...
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}]", For Multiple Partner and Multiple Role: { Note: In case of multiple partner and multiple role, you need to modify the roleInfo field with the respective activity IDs. | Example Response:
This endpoint creates an invitation and return invitation id in response which you will use while creating the user. | |||||||
POST | /rest/users/createuser | { | Example Response:
Use the invitation Id from the above Create User response. | ||||||||
Update User | PUT | /rest/users/{userId} | { "company":"Adeptia", | Example Response:
| |||||||
Get User | GET | /rest/user/{userId} | |||||||||
Get All Users (Connect Portal) | GET | /rest/userusers?limit={maximum number of users} | 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. | ||||||||
Activate User | PUT | /rest/users/activate/{userId} | EMPTY | ||||||||
Deactivate User | PUT | /rest/users/deactivate/{userId} | EMPTY | ||||||||
Delete User | PUT | /rest/users/updateowner?oldUserId={userId}&deleteUser=true | EMPTY | By default this endpoint will delete the user who has no dependency else an exception message to move objects will be generated. |
...
Operation | Method | API Endpoint | Example Request Payload | Example Response Payload | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Transaction | POST | /rest/transaction |
To identify the sequence ID for each steps, you need to run the Get Step Info API.it is recommended to run the below Get Step Info API. |
| ||||||||||||||
Get Step Info | GET | /rest/transactiontemplate/getactivitiesinfo/ {templateId}/{processFlowId} | EMPTY |
|
...
Operation | Method | API Endpoint | Example Response | |||||||
---|---|---|---|---|---|---|---|---|---|---|
View Connect Server (Developer Suite) Info | GET | /rest/fetchproperties/aboutinformation |
| |||||||
View Connect Portal Info | GET | /rest/applications/getTag |
|
...