Page Comparison

...

Key	Header Information (value)
Content Type	application/json
ACCESS_TOKEN	To fetch get the Access Token, refer below table for more details.

API to

...

Get Access Token

Operation

Method

API Endpoint

Example Payload

Example Response

Fetch Get Access Token

POST

/rest/login/user

{

"username":"{User Name}",

"password":"{Password}"

}

Code Block

title	Fetch Token
collapse	true

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

APIs for Managing Users

OperationMethodAPI EndpointExample PayloadCreate PartnerPOST/rest/company Code BlocktitleCreate PartnerExample Response{ "invitationId11567494226899 303[ ] }By default this endpoint creates an invitation and returns invitation id in response that can be used while creating the user.

Example Response:

Operation

Method

API Endpoint

Example Payload

Example and Notes

Create User

POST

/rest/invitation?resourceIdentifier=users

For Single Partner and Single Role:

{
"Invitation":{
"companyID":1,
"contactEmail":"",
"invitationType":300,
"mailRecipient":"new@adeptiajames.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 Block

title	Create User
collapse	true

{
"Invitation":{
"companyID":1,
"contactEmail":"

",

"

invitationType":

POST

/rest/users/createuser

{
"IndigoUser":{
"firstName":"Test300,
"mailRecipient":"james.paul@abc.com",
"lastNamemessage":"UserAdeptia has invited you to use Adeptia Connect",
"invitationIdroleInfo":11567494226899,
"password":"P@ssw0rd",
"roleId":null
}
}

Code Block

title	Create User
collapse	true

{
 "IndigoUser":{
 "firstName":"Test",
 "lastName":"User",
 "email":"new@adeptia.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.Update UserPUT/rest/users/{userId}

"[{\"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

title	Create User
collapse	true

{ "invitationId":"11567494226899", "303":[ ] }

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

POST/rest/users/createuser

{
"IndigoUser":{
"firstName":"TestJames",
"lastName":"UserPaul",
"emailinvitationId":"new@adeptia.com",
"company":"Adeptia11567494226899,
"password":"P@ssw0rd",
"idroleId":"11567413236623",
"userPartnerRole":[
{
"partner":{
"id":1
},
"role":{
"id":2
},
"user":{
"id":"11567413236623"
},
"defaultRole":true
}
]
}
}

Example Response:

Code Block

title	Update User
collapse	true

{ "IndigoUser":{ "firstName":"Test", "lastName":"User

null
}
}

Activate

Example Response:

Code Block

title	Create User
collapse	true

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

Fetch UserGET/rest/user/{userId}Fetch All Users (Connect Portal)GET/rest/user

Note:

Use the invitation Id from the above Create User response.

Update UserPUT/rest/users/activate/{userId}

{

}Deactivate UserPUT/rest/users/deactivate/{userId}{}Delete UserPUT/rest/users/updateowner?oldUserId={userId}&deleteUser=true{}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

"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

title	Update User
collapse	true

{
 "

Company

IndigoUser":{

{

name

firstName":

Wallgreens

Test",
 "

partnerNetworks

lastName":

[{

id

User"

: 1

}

primaryContact

email":

admin@wallgreens

james.paul@abc.com",
 "

phoneNumber

company":

2025550101

Adeptia",
 "

address

id":

"11567413236623",
 "

country

userPartnerRole":[
 {
 "partner"

,

:{
 "

status

id":1

200

},
 "

enableSelfOnboard

role":{

false,

spokeCompany

id":2

false

}

Update PartnerPUT/rest/company/{partnerId} Code Block

title	Update Partner
collapse	true

{ "Company": { "name": "Walmart Corporate"

,
 "user":{
 "id":"11567413236623"
 },
 "defaultRole":true
 }
 ]
 }
}

Delete Partner

Get User

PUT

GET	/rest/

company/deletepartner

user/{

partnerId

userId}

EMPTYUpdate Partner ParametersPUT

Get All Users (Connect Portal)

GET

/rest/

company/{partnerId}

Code Block

title	Update Partner Parameters
collapse	true

{ "Company": { "partnerParameter": [{ "id": "-0", "paramId": { "id": "11518430417328" }, "value": "Purchase Order" }, { "id": "-1", "paramId": { "id": "11518430417329" }, "value": "c" }] }

Grant all Templates Access to PartnerPOSTrest/templatepartnerlinkage?resourceIdentifier=company Code BlocktitleGrant Access to

users?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.

APIs for Managing Partners

Operation

Method

API Endpoint

Example Payload

Create Partner

POST

/rest/company

Code Block

title	Create Partner
collapse	true

{ "TemplatePartnerLinkageCompany": { "partnername": {"Wallgreens", "idpartnerNetworks": 11535091945351 } } }

Revoke all Templates Access to Partner

DELETE

rest/templatepartnerlinkage/partnerId?resourceIdentifier=company

EMPTY

Grant a Template Access to Partner

POST

/rest/templatepartnerlinkage?isTemplate=true&resourceIdentifier=transactiontemplate

Code Block

title	Grant Access to Particular Template
collapse	true

{ "TemplatePartnerLinkage": { "partner": { "id": 11535091945351 }, "transactionTemplate": { "id": 11535091945352 } } }

Revoke Template Access from PartnerDELETErest/templatepartnerlinkage/ {linkageId}?isTemplate=true&resourceIdentifier=transactiontemplateEMPTYMove Partner from One Network to anotherPOST

[{ "id": 1 } "primaryContact": "admin@wallgreens.com", "phoneNumber": "2025550101", "address": "", "country": "", "status": 200, "enableSelfOnboard": false, "spokeCompany": false } }

Update PartnerPUT/rest/company/{partnerId}

Code Block

title	Update Partner
collapse	true

{ "Company": { "name": "Walmart Corporate" } }

Delete PartnerPUTrest/company/deletepartner/{partnerId}EMPTYUpdate Partner ParametersPUT/rest/company/{partnerId}

Code Block

title	Change Update Partner NetworkParameters
collapse	true

{ "Company": { "partnerNetworkspartnerParameter": [{ "id": 1 } ] } }

Convert Internal Partner to ExternalPOSTrest/company/enableSelfOnbaord

Code Block

collapse	true

{ "partnerId" : "11529580510902", "firstName" : "Walmart", "lastName" : "Corporation", "userId" : "Walmart", "email" : "admin@walmart.com", "password" : "P@ssw0rd" }

Convert Internal Partner to External PartnerPOSTrest/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

APIs for Managing Transaction

Operation	Method	API Endpoint	Example Request Payload
Create Transaction	POST	/rest/transaction

Code Block

title	Create Transaction
collapse	true

{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "1111111111100" } }

Create Transaction with ParametersPOST/rest/transaction

Code Block

title	Create Transaction with Parameters
collapse	true

{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "547658658658658", "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }

Update TransactionPUT/rest/transaction/{transactionId}

Code Block

title	Update Transaction
collapse	true

{ "Transaction": { "description": "To transfer benefits data from xml file.", } }

Update Transaction ParametersPUT/rest/transaction/{transactionId}

Code Block

title	Update Transaction Parameters
collapse	true

{ "Transaction": { "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }

DELETEDELETE/rest/transaction/{transactionId}EMPTY

"-0", "paramId": { "id": "11518430417328" }, "value": "Purchase Order" }, { "id": "-1", "paramId": { "id": "11518430417329" }, "value": "c" }] }

Grant all Templates Access to PartnerPOSTrest/templatepartnerlinkage?resourceIdentifier=company

Code Block

title	Grant Access to Partner
collapse	true

{ "TemplatePartnerLinkage": { "partner": { "id": 11535091945351 } } }

Revoke all Templates Access to PartnerDELETErest/templatepartnerlinkage/partnerId?resourceIdentifier=company

EMPTY

Grant a Template Access to PartnerPOST/rest/templatepartnerlinkage?isTemplate=true&resourceIdentifier=transactiontemplate

Code Block

title	Grant Access to Particular Template
collapse	true

{ "TemplatePartnerLinkage": { "partner": { "id": 11535091945351 }, "transactionTemplate": { "id": 11535091945352 } } }

Revoke Template Access from PartnerDELETErest/templatepartnerlinkage/ {linkageId}?isTemplate=true&resourceIdentifier=transactiontemplateEMPTYMove Partner from One Network to anotherPOST/rest/company/{partnerId}

Code Block

title	Change Partner Network
collapse	true

{ "Company": { "partnerNetworks": [{ "id": 1 } ] } }

Convert Internal Partner to ExternalPOSTrest/company/enableSelfOnbaord

Code Block

collapse	true

{ "partnerId" : "11529580510902", "firstName" : "Walmart", "lastName" : "Corporation", "userId" : "Walmart", "email" : "admin@walmart.com", "password" : "P@ssw0rd" }

Convert Internal Partner to External PartnerPOSTrest/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

APIs for Managing Transaction

Operation

Method

API Endpoint

Example Request Payload

Create Transaction

POST

/rest/transaction

Code Block

title	Create Transaction
collapse	true

{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "1111111111100" } }

Create Transaction with Parameters

POST

/rest/transaction

Code Block

title	Create Transaction with Parameters
collapse	true

{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "547658658658658", "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }

Update Transaction

PUT

/rest/transaction/{transactionId}

Code Block

title	Update Transaction
collapse	true

{ "Transaction": { "description": "To transfer benefits data from xml file.", } }

Update Transaction Parameters

PUT

/rest/transaction/{transactionId}

Code Block

title	Update Transaction Parameters
collapse	true

{ "Transaction": { "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }

DELETE

/rest/transaction/{transactionId}

EMPTY

APIs for Managing Transaction for Custom Template

Operation

Method

API Endpoint

Example Request Payload

Example Response

Create Transaction

POST

/rest/transaction

Code Block

title	Create Transaction
collapse	true

{
   "Transaction":{
      "entityName":"MM_TM_Payroll_Submit_File Transaction",
      "description":"To transfer benefits data.",
      "partner":{
         "id":11494913182612
      },
      "template":{
         "id":11572856933900
      },
      "status":601,
      "type":504,
      "direction":3200,
      "srcTrigger":"onformsubmit",
      "processType":700,
      "company":{
         "id":1
      },
      "contactUser":"james.paul@abc.com",
      "metadata":[
         {
            "activityId":"192168001115157614705356800011",
            "sequenceId":16,
            "sequenceType":"Mapping",
            "type":"DataMapping",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614699843700010",
            "sequenceId":13,
            "sequenceType":"Schema",
            "type":"XMLSchema",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614693311500006",
            "sequenceId":5,
            "sequenceType":"Schema",
            "type":"AdvanceTextSchema",
            "isUniqueName":false
         }
      ]
   }
}

To identify the sequence ID for each steps, it is recommended to run the below Get Step Info API.

Code Block

title	Create Transaction
collapse	true

{
   "Transaction":{
 	"id":"1234568,
     "entityName":"MM_TM_Payroll_Submit_File Transaction",
      "description":"To transfer benefits data.",
      "partner":{
         "id":11494913182612
      },
      "template":{
         "id":11572856933900
      },
      "status":601,
      "type":504,
      "direction":3200,
      "srcTrigger":"onformsubmit",
      "processType":700,
      "company":{
         "id":1
      },
      "contactUser":"james.paul@abc.com",
      "metadata":[
         {
            "activityId":"192168001115157614705356800011",
            "sequenceId":16,
            "sequenceType":"Mapping",
            "type":"DataMapping",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614699843700010",
            "sequenceId":13,
            "sequenceType":"Schema",
            "type":"XMLSchema",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614693311500006",
            "sequenceId":5,
            "sequenceType":"Schema",
            "type":"AdvanceTextSchema",
            "isUniqueName":false
         }
      ]
   }
}

Get Step Info

GET

/rest/transactiontemplate/getactivitiesinfo/

{templateId}/{processFlowId}

EMPTY

Code Block

title	Get Step Info
collapse	true

[
   {
      "id":"010000000208153912375678500006",
      "name":"PK_Read_Input_Data",
      "type":"FtpSource",
      "baseType":"Source",
      "trigger":true,
      "action":false,
      "include":true,
      "label":"PK_Read_Input_Data",
      "serviceDisplayName":"Source",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":true,
      "references":null,
      "sequenceId":1,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912397741400010",
      "name":"PK_Excel_Schema_Src",
      "type":"TextSchema",
      "baseType":"SourceSchema",
      "trigger":false,
      "action":false,
      "include":true,
      "label":"PK_Excel_Schema_Src",
      "serviceDisplayName":"Source Layout",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":[
         {
            "id":"010000000208153912375678500006",
            "name":"PK_Read_Input_Data",
            "type":"FtpSource",
            "baseType":"Source",
            "trigger":true,
            "action":false,
            "include":true,
            "label":"PK_Read_Input_Data",
            "serviceDisplayName":"Source",
            "triggerLayout":false,
            "actionLayout":false,
            "eventContextEnabled":true,
            "references":null,
            "sequenceId":1,
            "formType":"TEMPLATE"
         }
      ],
      "sequenceId":2,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912384088200008",
      "name":"PK_Write_Target_Data",
      "type":"FtpTarget",
      "baseType":"Target",
      "trigger":false,
      "action":true,
      "include":true,
      "label":"PK_Write_Target_Data",
      "serviceDisplayName":"Target",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":null,
      "sequenceId":3,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912399192000012",
      "name":"PK_Excel_Schema_Target",
      "type":"TextSchema",
      "baseType":"TargetSchema",
      "trigger":false,
      "action":false,
      "include":true,
      "label":"PK_Excel_Schema_Target",
      "serviceDisplayName":"Target Layout",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":[
         {
            "id":"010000000208153912384088200008",
            "name":"PK_Write_Target_Data",
            "type":"FtpTarget",
            "baseType":"Target",
            "trigger":false,
            "action":true,
            "include":true,
            "label":"PK_Write_Target_Data",
            "serviceDisplayName":"Target",
            "triggerLayout":false,
            "actionLayout":false,
            "eventContextEnabled":false,
            "references":null,
            "sequenceId":3,
            "formType":"TEMPLATE"
         }
      ],
      "sequenceId":4,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912414793100013",
      "name":"PK_Mapping",
      "type":"DataMapping",
      "baseType":"DataMapping",
      "trigger":false,
      "action":false,
      "include":true,
      "label":"Mapping",
      "serviceDisplayName":"Mapping",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":null,
      "sequenceId":5,
      "formType":"TEMPLATE"
   }
]

APIs for Managing Schema and Mapping

...

Operation

Method

API Endpoint

Example Response

View Connect Server (Developer Suite) Info

GET

/rest/fetchproperties/aboutinformation

Code Block

title	Connect Server Information
collapse	true

{ "aboutInformation":{ "productName":"Adeptia Connect", "productVersion":"2.9.2", "edition":"Enterprise", "installationDate":"19 Oct, 2018", "expiryDate":"8 Oct, 2019", "connectPortal":"2.9.2", "connectServer":"Release_AC_2_9_2_09Oct2018" } }

View Connect Portal Info

GET

/rest/applications/getTag

Code Block

title	Create Connect Portal Information
collapse	true

{ "tag":"UmVsZWFzZV9BQ19XZWJfMl85XzNfMzFKYW4yMDE5X0FDXzJfOV8zXzMxSmFuMjAxOQ==", "acTag":"Release_AC_Web_2_9_2_09Oct2018_AC_2_9_2_09Oct2018" }

...

Versions Compared

Old Version 28

New Version Current

Key

API to

Get Access Token

APIs for Managing Partners

APIs for Managing Partners

APIs for Managing Transaction for Custom Template