API's for AC Activities

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's:

• Partners API's

  S. No	Operation	Method	API Endpoint	Ex. Payload	Remarks
  1	Create Partner	POST	/rest/company	Create Partner Expand source { "Company": { "name": "Test Name", "partnerNetworks": [{ "id": 1 } "primaryContact": "test@test.com", "phoneNumber": "7835802439", "address": "", "country": "", "status": 200, "enableSelfOnboard": false, "spokeCompany": false } }
  2	Update Partner	PUT	/rest/company/{partnerId}	Update Partner Expand source { "Company": { "name": "Updated Name" } }
  3	Delete Partner	DELETE	/rest/company/{partnerId}	EMPTY
  4	Update Partner Parameters	PUT	/rest/company/{partnerId}	Update Partner Parameters Expand source { "Company": { "partnerParameter": [{ "id": "-0", "paramId": { "id": "11518430417328" }, "value": "p1" }, { "id": "-1", "paramId": { "id": "11518430417329" }, "value": "c" }] }	Passing Company.partnerParameter.Id as Negative value will create a new parameter for that partner.
  5	Grant All Templates Access to Partner	POST	rest/templatepartnerlinkage	Grant Access to Partner Expand source { "TemplatePartnerLinkage": { "partner": { "id": 11535091945351 } } }
  6	Revoke all templates Access to Partner	DELETE	rest/templatepartnerlinkage/{partnerId}	EMPTY
  7	Grant a Template Access to partner	POST	rest/templatepartnerlinkage?isTemplate=true	Grant access to particular template Expand source { "TemplatePartnerLinkage": { "partner": { "id": 11535091945351 }, "transactionTemplate": { "id": 11535091945352 } } }	Note to pass isTemplate query param for this endpoint
  8	Revoke template access from Partner	DELETE	rest/templatepartnerlinkage/{LinkageId}?isTemplate=true	EMPTY	Note to pass isTemplate query param for this endpoint
  9	Move Partner from One Network to another	---	---	Change Partner Network Expand source { "Company": { "partnerNetworks": [{ "id": 1 } ] } }	Use Update partner Endpoint
  10	Convert Internal Partner to External	POST	rest/company/enableSelfOnbaord	Expand source { "partnerId" : "11529580510902", "firstName" : "Name", "lastName" : "lastName", "userId" : "testId", "email" : "example@example.com", "password" : "P@ssw0rd" }
  11	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	This api is asynchronous in nature and the user creation process runs in background.   You can check the status of the process by below endpoint rest/users/checkthreadstatus?isPartner=true if this endpoint return success that means the Partner is successfully converted to external

• Transaction API's 

  S. No	Operation	Method	API Endpoint	Ex. Request Payload	Remarks
  1	Create Transaction	POST	/rest/transaction	Create Transaction Expand source { "Transaction": { "entityName": "New Transaction", "description": "Transaction description", "templateId": "1111111111100" } }
  2	Create Transaction with Parameters	POST	/rest/transaction	Create Transaction with Parameters Expand source { "Transaction": { "entityName": "New Transaction", "description": "Transaction description", "templateId": "547658658658658", "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }
  3	Update Transaction	PUT	/rest/transaction/{transactionId}	Update Transaction Expand source { "Transaction": { "description": "Updated Transaction description", } }
  4	Update Transaction parameters	PUT	/rest/transaction/{transactionId}	Update Transaction Parameters Expand source { "Transaction": { "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }
  5	DELETE	DELETE	/rest/transaction/{transactionId}	EMPTY

  
  

• Schema and Mapping API's 

  S. No	Operation	Method	API Endpoint	Ex. Payload	Remarks
  1	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.
  2	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's

  Issue while updating Partner Parameters:

1. 1. Empty Partner parameters [ { }, { } ] create parameters with NULL param Id and Value
   2. Different Network Parameters can be associated to partner, to which Networks the partner does not belong.
   3. Passing Empty array( [ ]) of Partner parameters do not remove existing parameters.

See also

Patch Deployment Guide