Skip to main content
Version: 4

Adeptia Connect APIs

You can use the listed APIs on this page to view product information and to manage various activities from an external application. The API provides a way to fetch product information, Create, Update, and Delete activities, and migrate objects without accessing the user interface. 

APIs for Migration operations​

This section discusses the APIs that you can use to perform the following operations related to migrating objects from one environment to the other. Before you perform a migration operation, ensure that you have met the prerequisites discussed on this page. 

[+] Export objects

[-] Hide

The following table contains information related to the API that you can use to create an export zip -- containing the objects to be migrated -- which can be used for importing the objects at the target environment.

URL

https://<domain name>/rest/migration/export/execute/{id}

Request Method

POST

Headers

key: ACCESS_TOKEN
value: <value of the JWT access token>

Path Params

id: Id of the export package created using Solution Promotion. For more details, refer to this section.  

Response

{“success“ : boolean, “referenceId”:”string”}

Content-Type: application/json

Ex: {“success“: true/false, “referenceId”: “1234567891234“}

WarningThe operation returns a referenceId in response that you can use to view the export status and download the export zip and the respective logs.

[+] Import objects

[-] Hide

The following table contains information related to the API that you can use to import the objects to the target environment . 
 

InformationWhen you perform the import operation, a corresponding Rollback ZIP is created that allows you to revert the changes made during the import if needed.

URL

https://<domain name>/rest/migration/import/execute/{id}

Request Method

POST

Request

sourceZipFile:<Upload export zip>

Headers

key: ACCESS_TOKEN 
value: <value of the JWT access token>

Path Params

id: Id of the import package created using Solution Promotion. For more details, refer to this section. 

Response

{“success“ : boolean, “referenceId”:”string”}

Content-Type: application/json

Ex: {“success“: true/false, “referenceId”: “1234567891234“}

WarningThe operation returns a referenceId in response that you can use to view the export status and download the import zip, and logs

[+] Rollback the migration

[-] Hide

The Adeptia Connect migration API enables you to rollback the changes made during an import operation. To initialize the process, you first need to download a rollback zip and then use the following API endpoint to complete the rollback operation. 

URL

https://<domain name>/rest/migration/rollback/execute/{id}

Request Method

POST

Request

sourceZipFile:<file name of the rollback zip>

Headers

key: ACCESS_TOKEN

value: <value of the JWT access token>

Path Params

id: Id of the import package created using Solution Promotion. For more details, refer to this section.  

Response

{“success“ : boolean, “referenceId” : “string”}

Content-Type: application/json

Ex: {“success“: true/false, “referenceId”: “1234567891234”}

If you're executing a rollback operation within the specified migration log retention period, as defined in the property 
abpm.logs.migration.retainTime (In the Account > Settings > Microservice Settings > Archival And Cleanup section),
you can use the referenceId received as a response upon successfully completing an import operation to perform the rollback.

The following table contains information related to the API that you can use to rollback the import operation using a referenceId.

URLhttps://<domain name>/rest/migration/rollback/execute/{referenceId}
Request MethodPUT
Headers

key: ACCESS_TOKEN

value: <value of the JWT access token> 

Path ParamsReference Id: The id received in response to the import operation    
Response

{“success“ : boolean, “referenceId” : “string”}

Content-Type: application/json

Example: {“success“: true/false, “referenceId”: “1234567891234”}

[+] View export, import, or rollback status

[-] Hide

The following table contains information related to the API that you can use to view the export, import or rollback status. 

URL

https://<domain name>/rest/migration/status?id={referenceId}

Request Method

GET

Headers

key: ACCESS_TOKEN

value: <value of the JWT access token>

Query Params

Reference Id: The id received in response to the export or import operation     

Response

{"executionId": "string", "packageName": "string", "startTime": long, "status": “FINISHED/FAILED/RUNNING/QUEUED“, "referenceId": long}

The following table provides descriptions of the API response  

Status 
Description

SUCCESS

The process is completed successfully.

FAILED

The process is completed but fails due to some reason.

RUNNING

The process is still in progress and you need to wait for its completion.

QUEUED

The process has not started yet and is in the queue.

[+] Download export, import, or rollback zip file

[-] Hide

Once you have performed the export or import operation, you can use the API discussed in the table below to download any of the following zip files

  • export zip
  • import zip
  • rollback zip 

URL

https://<domain name>/rest/migration/downloadzip?id={referenceId}&type={type}

Request Method

GET

Headers

key: ACCESS_TOKEN 

value: <value of the JWT access token> 

Query Params

Reference Id: The id received in response to the export or import operation      

Type: The type of zip you want to download.  The available options are - exportzip, importzip, rollbackzip


Response

Content-Type: application/zip

[+] Download export, import, or rollback logs

[-] Hide

The following table contains information related to the API that you can use to download the export, import, and rollback logs. 

URL

https://<domain name>/rest/migration/logs?id={referenceId}

Request Method

GET

Headers

key: ACCESS_TOKEN 

value: <value of the JWT access token> 

Query Params

Reference Id: The id received in response to the export or import operation     

Response

Content-Type: text/plain

[+] Download export.xml file

[-] Hide

The following table contains information related to the API that you can use to download the export.xml file corresponding to an export package.  

URL

https://<domain name>/rest/migration/export/exportxml?id={id}

Request Method

GET

Headers

key: ACCESS_TOKEN

value: <value of the JWT access token> 

Query Params

id: Id of the export package created using Solution Promotion. For more details, refer to this section.   

Response

Content-Type: application/xml

[+] Download retain.xml file

[-] Hide

The following table contains information related to the API that you can use to download the retain.xml file (if any) used for creating an import package.

URL

https://<domain name>/rest/migration/import/retainxml?id={id}

Request Method

GET

Headers

key: ACCESS_TOKEN

value: <value of the JWT access token> 

Query Params

id: Id of the import package created using Solution Promotion. For more details, refer to this section.   

Response

Content-Type: application/xml

APIs for deploying jar and war files​

This section discusses the APIs that you can use to deploy a WAR or JAR file. 

Information

Before you deploy the files, ensure that you have met the following prerequisites:

  1. You have the JWT token for authentication. To generate the token you can use the API discussed in this section. 
  2. You are logged in to the application as Sys Admin or have been assigned a custom Sys Admin role with Custom Libraries permission. To learn more, refer to this page. 

[+] Deploy a jar file

[-] Hide

The following table contains information related to the API that you can use to deploy a jar file

URL

https://<domain name>/rest/customlibrary/fileupload/ext/{filename}/upload

Request Method

POST

Request

file: <Upload JAR file>

Headers

key: ACCESS_TOKEN

value: <value of the JWT access token>  

Path Params

filename: <name of the JAR file being uploaded>.
Example: mywebapp.jar 

Response

{"success":boolean, “response": “string”, "fileName":"string"}

Content-Type: application/json

Information

Restart the webrunner and runtime microservices to bring the changes into effect.

[+] Deploy a war file

[-] Hide

The following table contains information related to the API that you can use to deploy a war file

URL

https://<domain name>/rest/customlibrary/fileupload/webapps/{filename}/upload

Request Method

POST

Request

file: <Upload WAR file>

Headers

key: ACCESS_TOKEN 

value: <value of the JWT access token> 

Path Params

filename: <name of WAR file being uploaded>
Example: mywebapp.war

Response

{"success":boolean, “response": “string”, "fileName":"string"}

Content-Type: application/json

InformationRestart the portal microservice to bring the changes into effect.

APIs for uploading jar or custom classes to the customClasses folder​

This section discusses the APIs that you can use to upload custom classes or the jars to the customClasses folder. ​

Information

Before you upload custom class or jar file to the customClasses folder, ensure that you have met the following prerequisites:

  1. You have the JWT token for authentication. To generate the token you can use the API discussed in this section. 
  2. You are logged in to the application as Sys Admin or have been assigned a custom Sys Admin role with Custom Libraries permission. To learn more, refer to this page. 

[+] Upload a custom class or jar file

[-] Hide

The following table contains information related to the API that you can use to upload custom class or jar files to the customClasses folder

URL

https://<domain name>/rest/customlibrary/fileupload/customClasses/{filename}/upload

Request Method

POST

Request

file: <Upload JAR file> or <Upload Class file>

Headers

key: ACCESS_TOKEN

 value: <value of the JWT access token>  

Path Params

filename: <name of JAR or class file being uploaded>

Example: mywebapp.jar , mywebapp.class

Response

{"success":boolean, “response": “string”, “fileName":"string"}

Content-Type: application/json

InformationRestart the webrunner and runtime microservices to bring the changes into effect.

APIs for creating Security Policy​

This section guides you on how to create Security Policy using an API.

[+] WS Provider

[-] Hide

The following table contains information related to the API (WS Provider) that you can use to create Security Policy.    

API Endpoint

https://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/securitypolicy

MethodPOST
Request Payload
<ch:codesample>
</ch:codesample>
Response
<ch:codesample>
</ch:codesample>

You can create Security Policies using different Authentication Properties, Incoming Message Properties, Outgoing Message Properties and other Advanced Properties.

[+] Authentication Properties

[-] Hide

The following table shows examples of request payloads based on different Authentication Properties that you may want to set for the Security Policy that you create.

Operation 
Example Payload
Creating Security Policy with Authentication Type as Basic and Authentication Mode as Single User.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Authentication Type as Basic and Authentication Mode as Multiple User(Application User).
<ch:codesample>
</ch:codesample>
Creating Security Policy with Authentication Type as Basic and Authentication Mode as Multiple User(LDAP User).
<ch:codesample>
</ch:codesample>
Creating Security Policy with Authentication Type as API Key and API Key Mode as Header.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Authentication Type as API Key and API Key Mode as Query Param.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Authentication Type as Kerberos.<ch:codesample>
</ch:codesample>

[+] Outgoing Message Properties 

[-] Hide

 The following table shows examples of request payloads based on different Outgoing Message Properties that you may want to set for the Security Policy that you create.

Operation Example Payload
Creating Security Policy with Signature as the parameter. <ch:codesample>
</ch:codesample>
Creating Security Policy with Encryption as the parameter. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with User Name Token as the parameter. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with Time Stamp as the parameter. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with Other Configuration.
<ch:codesample>
</ch:codesample>

[+] Incoming Message Properties

[-] Hide

The following table shows examples of request payloads based on different Incoming Message Properties that you may want to set for the Security Policy that you create.

Operation Example Payload
Creating Security Policy with Signature Required property. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with Encryption Required property. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with User Name Token Required property. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with Time Stamp Required property.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Other Configuration. 
<ch:codesample>
</ch:codesample>

[+] Advanced Properties

[-] Hide

The following is the example of request payload based on Advanced Properties that you may want to set for the Security Policy that you create. 

Enter your project name and add it to the payload.

**Note:-**This endpoint checks for the creation of duplicate security policies. If you create a policy with the same entity name, you will get the following message.

Status Code

500 (Internal Server Error)

Response

Entity with name “<Entity Name>“ already exists in the database.

[+] WS Consumer

[-] Hide

The following table contains information related to the API (WS Consumer) that you can use to create Security Policy.    

API Endpoint

https://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/securitypolicy

MethodPOST
Request Payload
<ch:codesample></ch:codesample>
Response
<ch:codesample>
</ch:codesample>
Status Code
200 (OK)

You can create Security Policies using different Authentication Properties, SSL Properties, Outgoing Message Properties and other Advanced Properties.

[+] Authentication Properties 

[-] Hide

 The following table shows examples of request payloads based on different Authentication Properties that you may want to set for the Security Policy that you create.

OperationExample payload
Creating Security Policy with Authentication Type as Basic. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with Authentication Type as Kerberos.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Authentication Type as OAuth.
<ch:codesample>
</ch:codesample>

[+] SSL Properties

[-] Hide

The following is the example of request payload based on SSL Properties that you may want to set for the Security Policy that you create.

[+] Outgoing Message Properties

[-] Hide

The following table shows examples of request payloads based on different Outgoing Message Properties that you may want to set for the Security Policy that you create.

OperationExample payload
Creating Security Policy with Signature as the parameter. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with Encryption as the parameter. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with User Name Token as the parameter. 
<ch:codesample>
</ch:codesample>
Creating Security Policy with Time Stamp as the parameter.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Other Configuration parameter. 
<ch:codesample>
</ch:codesample>

[+] Incoming Message Properties

[-] Hide

The following table shows examples of request payloads based on different Incoming Message Properties that you may want to set for the Security Policy that you create.

OperationExample payload 
Creating Security Policy with Signature Required property.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Encryption Required property.
<ch:codesample>
</ch:codesample>
Creating Security Policy with User Name Token Required property.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Time Stamp Required property.
<ch:codesample>
</ch:codesample>
Creating Security Policy with Other Configuration. 
<ch:codesample>
</ch:codesample>

[+] Advanced Properties

[-] Hide

The following is the example of request payload based on Advanced Properties that you may want to set for the Security Policy that you create.

Enter your project name and add it to the payload.

Note:- This endpoint checks for the creation of duplicate security policies. If you create a policy with the same entity name, you will get the following message.

Status Code 
500 (Internal Server Error)
Response 
Entity with name “<Entity Name>“ already exists in the database.

[+] Http Source

[-] Hide

The following table contains information related to the API (Http Source) that you can use to create Security Policy.    

API Endpoint

https://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/securitypolicy

MethodPOST
Request Payload
<ch:codesample></ch:codesample>
Response
<ch:codesample>
</ch:codesample>
Status Code 
200 (OK)

You can create Security Policies using different Authentication Properties, SSL Properties and other Advanced Properties.

[+] Authentication Properties

[-] Hide

The following table shows example of request payloads based on different Authentication Properties that you may want to set for the Security Policy that you create.

OperationExample payload
Authentication Type is Basic
<ch:codesample>
</ch:codesample>

[+] SSL Properties

[-] Hide

The following is the example of request payload based on SSL Properties that you may want to set for the Security Policy that you create.

[+] Advanced Properties

[-] Hide

The following is the example of request payload based on Advanced Properties that you may want to set for the Security Policy that you create.

Enter your project name and add it to the payload.

**Note:-**This endpoint checks for the creation of duplicate security policies. If you create a policy with the same entity name, you will get the following message.

Status Code 
500 (Internal Server Error)
Response 
Entity with name “<Entity Name>“ already exists in the database.

APIs for updating existing Security Policy​

This section guides you on how to update existing Security Policy using an API.

[+] WS Provider

[-] Hide

To update the security policy enter the value (as per requirement) in Request Payload. Incase, you want to update a specific entity, you will have to pass the entity's ID in the URL and the updated data in the request payload. The following table shows the components you need to enter to update the security policy:

Component

Information type

External Request URL

https://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy/{id}

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/
securitypolicy/192168001055139764487378600005

Method Type

PUT

Authorization Type

Basic 

Header

Authorization

To use access token, provide the token value in ACCESS_TOKEN.

Request Payload
<ch:codesample>
</ch:codesample>
Status
200 (OK)
Response
<ch:codesample>
</ch:codesample>

[+] WS Consumer

[-] Hide

To update the security policy enter the value (as per requirement) in Request Payload. Incase, you want to update a specific entity, you will have to pass the entity's ID in the URL and the updated data in the request payload. The following table shows the components you need to enter to update the security policy:

Component

Information type

External Request URL

https://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy/{id}

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/
securitypolicy/192168001055139764487378600005

Method Type

PUT

Authorization Type

Basic 

Header

Authorization

To use access token, provide the token value in ACCESS_TOKEN.

Request Payload

<ch:codesample></ch:codesample>

Status

200 (OK)

Response


Code
{"id": "192168001055139764487378600005","entityName": "entityName","serviceName": "SecurityPolicy"}

[+] Http Source

[-] Hide

To update the security policy enter the value(as per requirement) in Request Payload. In case, you want to update a specific entity, you will have to pass the entity's ID in the URL and the updated data in the request payload. The following table shows the components you need to enter to update the security policy:

Component

Information type

External Request URL

https://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy/{id}

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/
securitypolicy/192168001055139764487378600005

Method Type

PUT

Authorization Type

Basic 

Header

Authorization

To use access token, provide the token value in ACCESS_TOKEN.

Request Payload

<ch:codesample></ch:codesample>

Status

200 (OK)

Response


Code
{"id": "192168001055139764487378600005","entityName": "entityName","serviceName": "SecurityPolicy"}

To manage User, Partner, Transactions, Schema, and Mapping activities from an external application, use any REST client with the following header information to process your request.

KeyHeader Information (value)
Content Typeapplication/json
ACCESS_TOKENTo get the Access Token, refer to the below table for more details.

API to Get Access Token​

Operation 
Get Access Token
Method
POST 
API Endpoint 
/rest/login/user
                                                                        Example Payload 

Code
{"username":"{User Name}","password":"{Password}"}


Where, User Name is the username of a native Adeptia user, and Password is the user's password. 

Warning

This payload is not applicable for an LDAP or SAML user.

                                                                     Example Response 

Fetch Token

Code
{
"tokenExpiresDays": 30,
"ACCESS_TOKEN": "{access token}"
}

APIs for Managing Users​

Operation 
Create User
Method
POST
API Endpoint 
/rest/invitation?resourceIdentifier=users
                                                     Example Payload
  • For Single Partner and Single Role
    Code
    {
    "Invitation":{
    "companyID":1,
    "contactEmail":"",
    "invitationType":300,
    "mailRecipient":"james.paul@abc.com", "message":"Adeptia has invited you to use Adeptia Connect", "roleInfo":"[{\"partner\":1,\"roles\":[2],\"defaultRole\":2}]",
    "senderEmail":"adminuser@adeptia.com",
    "subject":400
    }
    }

  • For Multiple Partner and Multiple Role
    Code
    {
    "Invitation":{
    "companyID":1,
    "contactEmail":"",
    "invitationType":300,
    "mailRecipient":"james.paul@abc.com",
    "message":"Adeptia has invited you to use Adeptia Connect",
    "roleInfo":"[{\"partner\":11524225847691,\"roles\":[11568264901750,11568264901759],\"defaultRole\":11568264901750},{\"partner\":11524225847699,\"roles\":[11568264920467,11568264920469],\"defaultRole\":11568264920467}]",
    "senderEmail":"adminuser@adeptia.com",
    "subject":400
    }
    }

    WarningIn case of multiple partner and multiple role, you need to modify the roleInfo field with the respective activity IDs.

                                                                 Example and Notes
Code
{ "invitationId":"11567494226899", "303":[ ] }

This endpoint creates an invitation and return invitation id in response which you will use while creating the user.

Operation 
Create User
Method
POST
API Endpoint
/rest/users/createuser
                                                     Example Payload
Code
{
"IndigoUser":{
"firstName":"James",
"lastName":"Paul",
"invitationId":11567494226899,
"password":"P@ssw0rd",
"roleId":null
}
}


                                                                 Example and Notes
Code
{
 "IndigoUser":{
 "firstName":"James",
 "lastName":"Paul",
 "email":"james.paul@abc.com",
 "company":"Adeptia",
 "id":"11567413236623",
 "userPartnerRole":[
 {
 "partner":{
 "id":1
 },
 "role":{
 "id":2
 },
 "user":{
 "id":"11567413236623"
 },
 "defaultRole":true
 }
 ]
 }
}

WarningUse the invitation Id from the above Create User response.


Operation 
Update User
MethodPUT
API Endpoint
/rest/users/{userId}
                                                      Example Payload
Code
{
"IndigoUser":{
"firstName":"James",
"lastName":"Paul",
"email":"james.paul@abc.com", "company":"Adeptia",
"id":"11567413236623",
"userPartnerRole":[
{
"partner":{
"id":1
},
"role":{
"id":2
},
"user":{
"id":"11567413236623"
},
"defaultRole":true
}
]
}
}

                                                             Example and Notes
Code
{
 "IndigoUser":{
 "firstName":"Test",
 "lastName":"User",
 "email":"james.paul@abc.com",
 "company":"Adeptia",
 "id":"11567413236623",
 "userPartnerRole":[
 {
 "partner":{
 "id":1
 },
 "role":{
 "id":2
 },
 "user":{
 "id":"11567413236623"
 },
 "defaultRole":true
 }
 ]
 }
}


Operation
Get User
Method
GET
API Endpoint
/rest/user/{userId}

Operation
Get All Users (Connect Portal)
Method
GET
API Endpoint
/rest/user?limit={maximum number of users}
                                                   Example and Notes
Using this API, you will get only Connect Portal users.

By default the value of limit is 1. Moreover, the limit stands for maximum number of users can be fetched from the database.

Operation
Activate User
Method
PUT
API Endpoint
/rest/users/activate/{userId}
Example Payload
EMPTY

Operation
Deactivate User
Method
PUT
API Endpoint
/rest/users/deactivate/{userId}
                                                      Example Payload

                                                              EMPTY

Operation
Delete User
Method
PUT
API Endpoint
/rest/users/updateowner?oldUserId={userId}&deleteUser=true
                                                     Example Payload
                                                               EMPTY
                                                     Example and Notes
By default this endpoint will delete the user who has no dependency else an exception message to move objects will be generated.

APIs for Managing Partners​

Operation
Create Partner
Method
POST
API Endpoint
/rest/company
                                                            Example Payload
Create Partner
<ch:codesample>
</ch:codesample>

Operation
Update Partner
Method
PUT
API Endpoint/rest/company/{partnerId}
                                                            Example Payload 
Update Partner
<ch:codesample></ch:codesample>

Operation
Delete Partner
Method
PUT
API Endpointrest/company/deletepartner/{partnerId}
                                                           Example Payload
                                                                           EMPTY

Operation
Update Partner Parameter 
Method
PUT
API Endpointrest/company/deletepartner/{partnerId}
                                                            Example Payload
Update Partner Parameters
<ch:codesample></ch:codesample>

Operation
Grant all Templates Access to Partner
Method
POST
API Endpointrest/templatepartnerlinkage?resourceIdentifier=company
                                                             Example Payload

Grant Access to Partner

<ch:codesample></ch:codesample>

Operation
Revoke all Templates Access to Partner
Method
DELETE
API Endpointrest/templatepartnerlinkage/partnerId?resourceIdentifier=company
                                                            Example Payload
                                                                      EMPTY

Operation
Grant a Template Access to Partner
Method
POST
API Endpoint/rest/templatepartnerlinkage?isTemplate=true&resourceIdentifier=transactiontemplate
                                                            Example Payload
Grant Access to Particular Template
<ch:codesample>
</ch:codesample>

Operation
Revoke Template Access from Partner
Method
DELETE
API Endpointrest/templatepartnerlinkage/ {linkageId}?isTemplate=true&resourceIdentifier=transactiontemplate
                                                            Example Payload
                                                                     EMPTY

Operation
Move Partner from One Network to another
Method
POST
API Endpoint/rest/company/{partnerId}
                                                            Example Payload
Change Partner Network
<ch:codesample></ch:codesample>

Operation
Convert Internal Partner to External
Method
POST
API Endpointrest/company/enableSelfOnbaord
                                                            Example Payload
<ch:codesample>
</ch:codesample>

Operation
Convert Internal Partner to External Partner
Method
POST
API Endpointrest/users/import
                                                             Example Payload
Multipart RequestContentType : multipart/form-dataform-data Part1 :
  • name : csvFile
  • value : csv file containing user information
form-data Part2:
  • name : isPartner
  • value : true

APIs for Managing Transaction​

Operation
Create Transaction
Method
POST 
API Endpoint
/rest/transaction
                                                                Example Request Payload
 Create Transaction
<ch:codesample>
</ch:codesample>

Operation
Create Transaction with Parameters
Method
POST 
API Endpoint
/rest/transaction
                                                               Example Request Payload 
Create Transaction with Parameters
<ch:codesample></ch:codesample>

Operation
Update Transaction
Method
PUT
API Endpoint
/rest/transaction/{transactionId}
                                                            Example Request Payload
Update Transaction
<ch:codesample></ch:codesample>

Operation
Update Transaction Parameters
Method
PUT
API Endpoint
/rest/transaction/{transactionId}
                                                                Example Request Payload

Update Transaction Parameters

<ch:codesample></ch:codesample>

Operation
Activate Transaction 
Method
PUT
API Endpoint
rest/transaction/activate/{transaction_id}
                                                                 Example Request Payload
                                                                                     {}

Operation
Deactivate Transaction 
Method
PUT
API Endpoint
rest/transaction/activate/{transaction_id}
                                                                Example Request Payload
                                                                                    {}

Operation
Update the Transaction's event 
Method
PUT
API Endpoint
rest/transaction/updateevent/{transaction_id}
                                                                Example Request Payload

<ch:codesample>

</ch:codesample>

Operation
DELETE
Method
DELETE
API Endpoint
/rest/transaction/{transactionId}
                                                               Example Request Payload
                                                                               EMPTY

APIs for Managing Transaction for Custom Template​

Operation 
Create Transaction
Method
POST 
API Endpoint
/rest/transaction
                                                                Example Request Payload
 Create Transaction
<ch:codesample>

To identify the sequence ID for each step, it is recommended that you run the Get Step Info API.
</ch:codesample>
                                                                       Example Response 

Create Transaction

<ch:codesample></ch:codesample>

Operation 
<ch:anchor>Get Step Info
</ch:anchor>
Method 
GET
API Endpoint 
/rest/transactiontemplate/getactivities
info/{templateId}/{processFlowId}
                                                                Example Request Payload
                                                                                EMPTY 
                                                                  Example Response 

Get Step Info

<ch:codesample></ch:codesample>

APIs to execute transaction​

Operation 
Execute by File Upload
Method 
POST
API Endpoint 
rest/adhoc/fileupload/transaction/{transaction_id}
                                                     Example Request Payload
 Content-Type: multipart/form-data Form Data
uploadedFile="File to be uploaded"
                                                            Example Response 

                                        

<ch:codesample></ch:codesample>

Operation 
Execute by Trigger Now (Run Now)
Method 
POST
API Endpoint 
rest/transaction/triggerjob/{event_type}/{transaction_id}
                                                    Example Request Payload 
                                                                           {}
                                                              Example Response 
                                               <ch:codesample>
</ch:codesample>

Where, event_type is the type of event. For example, "file" for File Event, "ftp" for FTP Event, "calendar" for Calendar Event, "rest" for Rest Consumer, etc.

APIs to schedule and update the event​

Follow the steps below before you schedule and update the Event using the listed APIs:

  1. Deactivate the transaction associated with the event.
  2. Update the Polling Frequency or Cron Interval of the event to schedule the event.
  3. Activate the transaction.
Operation 
Fetch Event 
Method 
GET
API Endpoint 
rest/entities/events/{event_type}/{event_id}
                                                                   Example Request Payload
                                                                                    N/A

Operation 
Execute by Trigger Now (Run Now)
Method 
PUT
API Endpoint 
rest/entities/events/{event_type}/{event_id}
                                                                  Example Request Payload
File event
<ch:codesample>

Calendar event
<ch:codesample>

</ch:codesample></ch:codesample>

Operation 
Fetch all events 
Method 
GET
API Endpoint 
rest/entities/{event_type}?page=1&limit=1000

Here, event_type will be
the type of the event such
as fileevents, ftpevents, databaseevents, etc.

You can also modify the
value in the limit parameter.
                                                               Example Request Payload 
                                                                                    N/A

Where, event_type is the type of event. For example, "file" for File Event, "ftp" for FTP Event, "calendar" for Calendar Event, etc.

WarningTo schedule the event, you need to update the Polling Frequency or Cron Interval. 

APIs for Managing Schema and Mapping

Operation 
Get all Schema and Mapping activities available to Partner
Method 
GET 
API Endpoint 
/rest/activities/{partnerId}
                                                                   Example and Notes
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,ExcelSchemaValid 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. 

Operation 
Get all Schema and Mapping activities used by Partner in Transactions of a particular Template
Method 
GET 
API Endpoint 
/rest/activities/{partnerId}/{templateId}
                                                                    Example and Notes
 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

APIs for Viewing Product Information​

Operation 
View Connect Server (Developer Suite) Info
Method 
GET 
API Endpoint 
/rest/fetchproperties/aboutinformation
                                                                        Example Response
 Connect Server Information
<ch:codesample>
</ch:codesample>

Operation
View Connect Portal Info
Method 
GET 
API Endpoint 
/rest/applications/getTag
                                                                       Example Response 
Connect Portal Information
<ch:codesample>
</ch:codesample>

APIs for System Console ​

Operation 
System Console JSON (diagnostics.json)
Method 
GET 
API Endpoint 
diagnostics?component={component_name}
                                                                 Example Request Payload 
                                                                                    N/A
Warning
  • To fetch the complete JSON, the value of component_name will be all. For Example, diagnostics?component=all.
  • To fetch the individual component JSON, mention the component name. For example, diagnostics?component=backend-database.

APIs for scheduler ​

Operation 
Pause scheduler
Method 
GET 
API Endpoint 
event/schedulerservice?query=Pause
                                                                 Example Request Payload 
                                                                                    N/A

Operation 
Resume scheduler
Method 
GET 
API Endpoint 
event/schedulerservice?query=Resume
                                                                Example Request Payload 
                                                                                     N/A

Here, <page size> indicates the number of activated event displayed on each page.

APIs for Webforms​

Operation 
Insert records into database
Method 
POST
API Endpoint 
/rest/insertrecord
                                                                  Example and Notes  
By default this endpoint posts data into database table(s) based on the request payload provided to this API.  
Input parameters are:
  • DBInfo ID
  • AdvancedDBTarget ID
The structure of request payload JSON needs to match the table schema that is defined in the database.

Operation 
Post all records into a database
Method 
POST
API Endpoint 
/rest/insertrecord
                                                                   Example and Notes
This endpoint can also be used on any web form that requires insertion of data into a table. The DB Info ID and Database Schema ID passed as input parameters are used to connect to a specific database instance. Payload can consist of multiple records. This base API can be further modified to your needs. This allows for dynamic parameterization to change the pointer to the database from development to production environment. Here's a sample payload:

{
  "name": "Acme Corp",
  "city": "Costa Mesa",
  "state": "CA",
  "subcode": "0586548",
  "street": "475 APPLE BLVD",
  "zip": "92626",
  "phone": "9495673800",
  "comments": "testing"
}

Operation 
Update records into database
Method 
POST
API Endpoint 
/rest/updaterecord
                                                             Example and Notes  
By default this endpoint posts data into database table(s) based on the request payload provided to this API.  
Input parameters are:
  • DBInfo ID
  • AdvancedDBTarget ID
The structure of request payload JSON needs to match the table schema that is defined in the database.

Operation 
Update record in a database table
Method 
POST
API Endpoint 
/rest/updaterecord
                                                                   Example and Notes 
This endpoint can also be used on any web form that requires updating of an existing record in a table. The DB Info ID, Database Schema ID passed as input parameters are used to connect to a specific database instance. Payload can consist of multiple records. This base API can be further modified to your needs. This allows for dynamic parameterization to change the pointer to the database from development to production environment. Here's a sample payload:

{
  "RecordID": 23
  "name": "Acme Corp",
  "city": "Costa Mesa",
  "state": "CA",
}

Operation 
Delete records in a database
Method 
POST
API Endpoint 
/rest/deleterecord
                                                                  Example and Notes  
By default this endpoint posts data into database table(s) based on the request payload provided to this API.  
Input parameters are:
  • DBInfo ID
  • AdvancedDBTarget ID
The structure of request payload JSON needs to match the table schema that is defined in the database.

Operation 
Delete record in a database table
Method 
POST
API Endpoint 
/rest/deleterecord
                                                                   Example and Notes 
This endpoint can also be used on any web form that requires deletion of an existing record in a table. The DB Info ID, Database Schema ID passed as input parameters are used to connect to a specific database instance. Payload can consist of multiple record IDs. This base API can be further modified to your needs. This allows for dynamic parameterization to change the pointer to the database from development to production environment. Here's a sample payload:

{
  "RecordID": 23
}

Operation 
Read records from a database
Method 
GET
API Endpoint 
/rest/readrecord
                                                             Example and Notes  
By default this endpoint posts data into database table(s) based on the request payload provided to this API.  
Input parameters are:
  • DBInfo ID
  • AdvancedDBTarget ID
The structure of request payload JSON needs to match the table schema that is defined in the database.


Operation 
Read all records from a database
Method 
GET
API Endpoint 
/rest/readrecord
                                                              Example and Notes 
This endpoint can also be used on any web form that requires pulling data from a table. The DB Info ID and Database Schema ID passed as input parameters are used to connect to a specific database instance. Payload can consist of multiple records. To read all records you can leave the Record ID blank. This base API can be further modified to your needs. This allows for dynamic parameterization to change the pointer to the database from development to production environment. Here's a sample payload:

//to read specific records
{
"RecordID": 23
"RecordID": 24
}

//to read all records
{
"RecordID": null
}

Known Issues with API​

These are the issues which occur while updating Partner Parameters:

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