Using API, you can manage the activities (Partner, Schema, and Mapping) from the external application. The API provides the way to Create, Update, and Delete activities without GUI.
Following are the list of API:
Partners API
Operation Method API Endpoint Ex. Payload Create Partner POST /rest/company Update Partner PUT /rest/company/{partnerId} Delete Partner DELETE /rest/company/{partnerId} EMPTY Update Partner Parameters PUT /rest/company/{partnerId} Grant all Templates Access to Partner POST rest/templatepartnerlinkage Revoke all Templates Access to Partner DELETE rest/templatepartnerlinkage/{partnerId} EMPTY
Grant a Template Access to Partner POST rest/templatepartnerlinkage?isTemplate=true Revoke Template Access from Partner DELETE rest/templatepartnerlinkage/{LinkageId}?isTemplate=true EMPTY Move Partner from One Network to another --- --- Convert Internal Partner to External POST rest/company/enableSelfOnbaord Convert Internal Partner to External API 2 POST rest/users/import Multipart Request
ContentType : multipart/form-data
form-data Part1 :
- name : csvFile
- value : csv file containing user information
form-data Part2:
- name : isPartner
- value : true
Transaction API
Operation Method API Endpoint Ex. Request Payload Create Transaction POST /rest/transaction Create Transaction with Parameters POST /rest/transaction Update Transaction PUT /rest/transaction/{transactionId} Update Transaction Parameters PUT /rest/transaction/{transactionId} DELETE DELETE /rest/transaction/{transactionId} EMPTY Schema and Mapping API
Operation Method API Endpoint Ex. Payload Remarks Get all Schema and Mapping activities available to Partner GET /rest/activities/{partnerId} By default this endpoint lists all the activities available to partner.
To retrieve specific activities pass the comma separated service name query parameter as below
?services=TextSchema,ExcelSchema
Valid Service Names are
- TextSchema
- ExcelSchema
- AdvanceTextSchema
- PositionalSchema
- AdvancePositionalSchema
- XMLSchema
- JSONSchema
- EDISchema
- DataMapping
By default all the available fields of all activities are returned in response. To limit the number of fields and to get specific fields pass the "fields" query param and pass the comma separated field names as below
?fields=id,entityName
Note:
Only those activities will be returned in response to which the requesting user is authorized to view as per permission settings.
Admin will get all activities.
Get all Schema and Mapping activities used by Partner in Transactions of a particular Template GET /rest/activities/{partnerId}/{templateId} By default this endpoint lists all the activities used by partner for a particular template.
To retrieve specific activities pass the comma separated service name query parameter as below
?services=TextSchema,ExcelSchema (See above the list of valid service Names)
By default all the available fields of all activities are returned in response. To limit the number of fields and to get specific fields pass the "fields" query param and pass the comma separated field names as below
?fields=id,entityName
Known Issues with API
These are the issues which occur while updating Partner Parameters:
- Empty Partner Parameters [ { }, { } ] and create Parameters with NULL param Id and Value.
- Different Network Parameters can be associated with Partner to those Networks on which Partner does not belong.
- Passing Empty array ( [ ]) of Partner Parameters do not remove existing Parameters.