...
Key | Header Information (value) |
---|---|
Content Type | application/json |
ACCESS_TOKEN | To get the Access Token, refer below table for more details. |
API to
...
Get Access TokenĀ
Operation | Method | API Endpoint | Example Payload | Example Response | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Get Access Token | POST | /rest/login/user | { "username":"{User Name}", "password":"{Password}" } |
|
...
Operation | Method | API Endpoint | Example Payload | Example and Notes | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create User | POST | /rest/invitation?resourceIdentifier=users | For Single Partner and Single Role: { "roleInfo":"[{\"partner\":1,\"roles\":[2],\"defaultRole\":2}]", | Example ResponseFor Multiple Partner and Multiple Role: |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "invitationId":"11567494226899", "303":[ ] } |
{
"IndigoUser":{
"firstName":"James",
"lastName":"Paul",
"invitationId":11567494226899,
"password":"P@ssw0rd",
"roleId":null
}
}
Example Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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
}
]
}
} |
Use the invitation Id from the above Create User response.
{
"IndigoUser":{
"firstName":"James",
"lastName":"Paul",
"email":"james.paul@abc.com",
"company":"Adeptia",
"id":"11567413236623",
"userPartnerRole":[
{
"partner":{
"id":1
},
"role":{
"id":2
},
"user":{{
"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
}
}
Note: In case of multiple partner and multiple role, you need to modify the roleInfo field with the respective activity IDs.
Example Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "invitationId":"11567494226899", "303":[ ] } |
This endpoint creates an invitation and return invitation id in response which you will use while creating the user.
{
"IndigoUser":{
"firstName":"James",
"lastName":"Paul",
"invitationId":11567494226899,
"password":"P@ssw0rd",
"roleId":null
}
}
Example Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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
}
]
}
} |
Note:
Use the invitation Id from the above Create User response.
{
"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 Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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 } ] } } |
By default the value of limit is 1. Moreover, the limit stands for maximum number of users can be fetched from the database.
...
Operation | Method | API Endpoint | Example Request Payload | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Transaction | POST | /rest/transaction |
| Create Transaction with Parameters | POST | /rest/transaction |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "547658658658658", "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Transaction": { "description": "To transfer benefits data from xml file.", } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Transaction": { "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } } |
| ||
{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "1111111111100" } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "547658658658658", "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Transaction": { "description": "To transfer benefits data from xml file.", } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Transaction": { "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } } |
APIs for Managing Transaction for Custom TemplateĀ
Operation | Method | API Endpoint | Example Request Payload | Example Response | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Transaction | POST | /rest/transaction |
To identify the sequence ID for each steps, it is recommended to run the below Get Step Info API. |
| ||||||||||||||
Get Step Info | GET | /rest/transactiontemplate/getactivitiesinfo/ {templateId}/{processFlowId} | EMPTY |
|
APIs for Managing Schema and Mapping
...
Operation | Method | API Endpoint | Example Response | |||||||
---|---|---|---|---|---|---|---|---|---|---|
View Connect Server (Developer Suite) Info | GET | /rest/fetchproperties/aboutinformation |
| |||||||
View Connect Portal Info | GET | /rest/applications/getTag |
|
...