Skip to main content
Version: 3

Adeptia Connect APIs

You can use the listed APIs on this page to view product information and to manage various activities (User, Partner, Transactions, Schema, and Mapping) from an external application. The API provides the way to fetch product information, Create, Update, and Delete activities without accessing the user interface. 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 below table for more details.

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 Endpointhttps://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy

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

/securitypolicy
MethodPOST
------
Request Payload
Code
{
    "SecurityPolicy": {
        "entityName": "entityName",
        "description": "description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default"       
    }
}

| | --- | --- | | Response | Code

{
    "id": "192168001111167999972254600004",
    "entityName": "entityName",
    "serviceName": "SecurityPolicy"
}

| | --- | --- |

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.

OperationExample Payload
Creating Security Policy with Authentication Type as Basic and Authentication Mode as Single User.
Code
{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "project":"Default",
        "securityPolicyType": "Provider",
        "authentication": true,
        "authType": "Basic",
        "authModeType": 1,
        "userID": "enter userId", 
        "password": "enter password"        
    }
}

| | Creating Security Policy withAuthentication Type as Basic and Authentication Mode as Multiple User(Application User). | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "authentication": true,
        "authType": "Basic",
        "authModeType": 2,
        "authMode":2,
        "authGroup":"allRoles"       
    }
}

| | Creating Security Policy with Authentication Type as Basic and Authentication Modeas Multiple User(LDAP User). | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "authentication": true,
        "authType": "Basic",
        "authModeType": 3,
        "authMode":3,
        "authGroup":"allRoles"       
    }
}

| | Creating Security Policy with Authentication Type as API Keyand API Key Mode as**** Header. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "authentication": true,
        "authType": "API_Key",
        "claimParam":"value,value,value"      
    }
}
claimParam: value,value,value  //You can add multiple value like this, atleast one required.

| | Creating Security Policy with Authentication Type as API Keyand API Key Mode as**** Query Param. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "authentication": true,
        "authType": "API_Key",
        "apiKeyMode": "Query",
        "claimParam":"value,value,value"      
    }
}
claimParam: value,value,value  //You can add multiple value like this, atleast one required.

| | Creating Security Policy with Authentication Type as Kerberos. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "authentication": true,
        "authType": "Kerberos",
        "loginModule":"Enter Kerberos Module Name"        
    }
}

| [+] 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 withSignatureas the parameter.
Code
{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "signature": true,
        "sigKeyStore": "KeyStore:192168001073149086937652500003",
        "sigAlias": "enter alias",
        "sigKeyIdentifierType": "Default", 
        "sigAlgType": "Default",  
        "sigCanonicalization": "Default", 
        "timeStampSignatureOutgoing": true,
        "signatureParts": "<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Encode/Content]]></Encode></Part></Parts>"
    }
}
"sigKeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy withEncryption as the parameter. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "encryption": true,
        "encrypkeyStore": "KeyStore:192168001073149086937652500003",
        "encrypAlias": "enter alias",
        "encrypKeyIdentifierType": "Default", 
        "symmetricAlg": "Default",
        "keyEncrypAlg": "Default", 
        "encrypCanonicalization": "Default", 
        "encryptionParts": "<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Encode/Content]]></Encode></Part></Parts>"
    }
}
"encrypkeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy withUser Name Tokenas the parameter. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "userNameToken": true,
        "tokenUserid": "enter token user id",
        "tokenNonce": false,
        "tokenCreated": true,
        "tokenUserPassword": "asas",
        "tokenPasswordType": "select password type"
    }
}
"tokenPasswordType": "PasswordText/PasswordDigest"

| | Creating Security Policy with Time Stamp as the parameter. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "timeStamp": true,
        "timeToLive": 70
    }
}

| | Creating Security Policy with Other Configuration. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "messageSequenceOutgoing": "T"
    }
}

| [+] 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 withSignature Requiredproperty.
Code
{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "inComingMessage": true,
        "signatureRequired": true,
        "sigInkeyStore": "KeyStore:192168001073149086937652500003",
        "timeStampSignatureIncomming": true,
        "signatureIncomingParts":"<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Content/Element]]></Encode></Part></Parts>"
    }
}
"sigInkeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy withEncryption Requiredproperty. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "inComingMessage": true,
        "encryptionRequired": true,
        "decrypInkeyStore": "KeyStore:192168001073149086937652500003",
        "encryptionIncomingParts":"<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Content/Element]]></Encode></Part></Parts>"
    }
}
"decrypInkeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy withUser Name Token Requiredproperty. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "inComingMessage": true,
        "userNameTokenIncoming": true,
        "tokenUseridIncoming": "enter token user id incoming",
        "tokenUserPasswordIncoming": "enter password",
        "tokenNonceIncoming": false,
        "tokenPasswordTypeIncoming": "PasswordText"
    }
}

"tokenPasswordTypeIncoming": "PasswordText/PasswordDigest"

| | Creating Security Policy withTime Stamp Requiredproperty. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "inComingMessage": true,
        "timeStampRequired": true        
    }
}

| | Creating Security Policy withOther Configuration. | Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
        "messageSequenceIncoming": "T,U,E,S"
    }
}

| [+] 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.

Code

{
    "SecurityPolicy": {
        "entityName": "ProviderSecurityPolicy",
        "description": "Provider_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default"
    }
}

You can enter your project id, it takes Default project  // "project":"11685084254031",

**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 Code500 (Internal Server Error)
ResponseEntity 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 Endpointhttps://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/securitypolicy
MethodPOST
------
Request Payload
Code
{
    "SecurityPolicy": {
        "entityName": "entityName",
        "description": "description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default"              
    }
}

| | --- | --- | | Response | Code

{
    "id": "192168001111167999972254600004",
    "entityName": "entityName",
    "serviceName": "SecurityPolicy"
}

| | --- | --- |

Status Code200 (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.
Code
{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "authentication": true,
        "authType": "Basic",
        "userID": "enter userId", 
        "password": "enter password",
        "authenticatePreemptively": false        
    }
}

| | Creating Security Policy with Authentication Type as Kerberos. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "authentication": true,
        "authType": "Kerberos",
        "loginModule":"Enter Kerberos Module Name"        
    }
}

| | Creating Security Policy with Authentication Type as OAuth. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "authentication": true,
        "authType": "oauth",
        "oauthAccountId":"oauth Account Id"       
    }
}

| [+] 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.

Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "secure": true,
        "trustStoreName": "KeyStore:192168001083142261050270400002",
        "keyStoreName": "KeyStore:192168001083142261050270400002",      
        "keyStoreAlias": "adeptia"
    }
}

trustStoreName - enter trust store id 
keyStoreName - enter key store id

[+] 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 withSignatureas the parameter.
Code
{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "signature": true,
        "sigKeyStore": "KeyStore:192168001073149086937652500003",
        "sigAlias": "enter alias",
        "sigKeyIdentifierType": "Default", 
        "sigAlgType": "Default",  
        "sigCanonicalization": "Default", 
        "timeStampSignatureOutgoing": true,
        "signatureParts": "<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Encode/Content]]></Encode></Part></Parts>"
    }
}
"sigKeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy with Encryption as the parameter. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "encryption": true,
        "encrypkeyStore": "KeyStore:192168001073149086937652500003",
        "encrypAlias": "enter alias",
        "encrypKeyIdentifierType": "Default", 
        "symmetricAlg": "Default",
        "keyEncrypAlg": "Default", 
        "encrypCanonicalization": "Default", 
        "encryptionParts": "<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Encode/Content]]></Encode></Part></Parts>"
    }
}
"encrypkeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy with User Name Tokenas the parameter. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "userNameToken": true,
        "tokenUserid": "enter token user id",
        "tokenNonce": false,
        "tokenCreated": true,
        "tokenUserPassword": "asas",
        "tokenPasswordType": "select password type"
    }
}
"tokenPasswordType": "PasswordText/PasswordDigest"

| | Creating Security Policy withTime Stampas the parameter. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "timeStamp": true,
        "timeToLive": 70
    }
}

| | Creating Security Policy withOther Configurationparameter. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "messageSequenceOutgoing": "T"
    }
}

| [+] 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 withSignature Requiredproperty.
Code
{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "inComingMessage": true,
        "signatureRequired": true,
        "sigInkeyStore": "KeyStore:192168001073149086937652500003",
        "timeStampSignatureIncomming": true,
        "signatureIncomingParts":"<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Content/Element]]></Encode></Part></Parts>"
    }
}
"sigInkeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy withEncryption Requiredproperty. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "inComingMessage": true,
        "encryptionRequired": true,
        "decrypInkeyStore": "KeyStore:192168001073149086937652500003",
        "encryptionIncomingParts":"<Parts><Part><Name><![CDATA[Name1]]></Name><Namespace><![CDATA[Namespace1]]></Namespace><Encode><![CDATA[Element/Content]]></Encode></Part><Part><Name><![CDATA[Name2]]></Name><Namespace><![CDATA[Namespace2]]></Namespace><Encode><![CDATA[Content/Element]]></Encode></Part></Parts>"
    }
}
"decrypInkeyStore": "enter key store id",
Element/Content - select one

| | Creating Security Policy withUser Name Token Requiredproperty. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "inComingMessage": true,
        "userNameTokenIncoming": true,
        "tokenUseridIncoming": "enter token user id incoming",
        "tokenUserPasswordIncoming": "enter password",
        "tokenNonceIncoming": false,
        "tokenPasswordTypeIncoming": "PasswordText"
    }
}

"tokenPasswordTypeIncoming": "PasswordText/PasswordDigest"

| | Creating Security Policy withTime Stamp Requiredproperty**.** | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "inComingMessage": true,
        "timeStampRequired": true        
    }
}

| | Creating Security Policy withOther Configuration. | Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default",
        "messageSequenceIncoming": "T,U,E,S"
    }
}

| [+] 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.

Code

{
    "SecurityPolicy": {
        "entityName": "ConsumerSecurityPoicy",
        "description": "Ws_Consumer_Security_Policy_Description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer",
        "project":"Default"
    }
}

You can enter your project id, it takes Default project  // "project":"11685084254031",

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 Code500 (Internal Server Error)
ResponseEntity 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 Endpointhttps://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy

Example:http://localhost:8081/AdeptiaConnect2/rest/entities/account/securitypolicy
MethodPOST
------
Request Payload
Code
{
    "SecurityPolicy": {
        "entityName": "entityName",
        "description": "description",
        "permissionMask": "770",
        "securityPolicyType": "Http",
        "project":"Default"              
    }
}

| | --- | --- | | Response | Code

{
    "id": "192168001111167999972254600004",
    "entityName": "entityName",
    "serviceName": "SecurityPolicy"
}

| | --- | --- |

Status Code200 (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
Code
{
    "SecurityPolicy": {
        "entityName": "HttpSecurityPolicy",
        "description": "HttpSecurityPolicyDescription",
        "permissionMask": "770",
        "securityPolicyType": "Http",
        "project":"Default",
        "authentication": true,
        "authType": "Basic",
        "userID": "enter userId", 
        "password": "enter password",
        "authenticatePreemptively": false        
    }
}

| [+] SSL Propertiesjavascript:void%280%29 [-] 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.

Code

{
    "SecurityPolicy": {
        "entityName": "HttpSecurityPolicy",
        "description": "HttpSecurityPolicyDescription",
        "permissionMask": "770",
        "securityPolicyType": "Http",
        "project":"Default",
        "secure": true,
        "trustStoreName": "KeyStore:192168001083142261050270400002",
        "keyStoreName": "KeyStore:192168001083142261050270400002",      
        "keyStoreAlias": "adeptia"
    }
}

trustStoreName - enter trust store id 
keyStoreName - enter key store id

[+] Advanced Propertiesjavascript:void%280%29 [-] 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.

Code

{
    "SecurityPolicy": {
        "entityName": "HttpSecurityPolicy",
        "description": "HttpSecurityPolicyDescription",
        "permissionMask": "770",
        "securityPolicyType": "Http",
        "project":"Default"
    }
}

You can enter your project id, it takes Default project  // "project":"11685084254031",

**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.

Status500 (Internal Server Error)
ResponseEntity 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:

ComponentInformation type
External Request URLhttps://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy/{id}

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

/securitypolicy/192168001055139764487378600005
Method TypePUT
Authorization TypeBasic
HeaderAuthorization

To use access token, provide the token value in ACCESS_TOKEN.
Request Payload
Code
{
    "SecurityPolicy": {
        "entityName": "entityName",
        "description": "description",
        "permissionMask": "770",
        "securityPolicyType": "Provider",
        "project":"Default",
         ...............
         ...............
         rest of the updated properties(describe above)              
    }
}

| | Status | 200 (OK) | | Response | Code

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

|

[+] WS Consumerjavascript:void%280%29 [-] 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:

ComponentInformation type
External Request URLhttps://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy/{id}

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

policy/192168001055139764487378600005
Method TypePUT
Authorization TypeBasic
HeaderAuthorization

To use access token, provide the token value in ACCESS_TOKEN.
Request Payload
Code
{
    "SecurityPolicy": {
        "entityName": "entityName",
        "description": "description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer" 
        "project":"Default",
         ...............
         ...............
         rest of the updated properties(describe above)              
    }
}

| | Status | 200 (OK) | | Response | | Copy Code
Code |
| --- |
|

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

| | [+] Http Source [-] 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:

ComponentInformation type
External Request URLhttps://<ipaddress/domain>:<port>/rest/entities/account/securitypolicy/{id}

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

/account/securitypolicy/192168001055139764487378600005
Method TypePUT
Authorization TypeBasic
HeaderAuthorization

To use access token, provide the token value in ACCESS_TOKEN.
Request Payload
{
    "SecurityPolicy": {
        "entityName": "entityName",
        "description": "description",
        "permissionMask": "770",
        "securityPolicyType": "Consumer" 
        "project":"Default",
         ...............
         ...............
         rest of the updated properties(describe above)              
    }
}

| | | Status | 200 (OK) | | Response | | Copy Code
Code |
| --- |
|

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

| |

API to get Access Token ​

OperationGet Access Token
MethodPOST
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​

OperationCreate User
MethodPOST
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\":11524225

847699,\"roles\":[11568264920467,11568264920469],

\"defaultRole\":11568264920467}]",

"senderEmail":"adminuser@adeptia.com",
"subject":400
}
}





| Warning | In 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":[ ] }

| | | | 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
 }
 ]
 }
}





| Warning | Use the invitation Id from the above Create User response. |
| --- | --- | | | | | Operation | Update User | | Method | PUT | | 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/users/{userId} | | | | Operation | Get All Users (Connect Portal) | | Method | GET | | API Endpoint | /rest/user?limit={maximum number of users} | | Example Payload | | N/A | | 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 |

APIs for managing Partners​

OperationCreate Partner
MethodPOST
API Endpoint/rest/company
Example Payload
Create Partner
Code
{ "Company": { "name": "Wallgreens", "partnerNetworks": [{ "id": 1 } "primaryContact": "admin@wallgreens.com", "phoneNumber": "2025550101", "address": "", "country": "", "status": 200, "enableSelfOnboard": false, "spokeCompany": false } }

| | | | Operation | Update Partner | | Method | PUT | | API Endpoint | /rest/company/{partnerId} | | Example Payload | | Code

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

| | | | Operation | Delete Partner | | Method | PUT | | API Endpoint | rest/company/deletepartner/{partnerId} | | Example Payload | | EMPTY | | | | Operation | Update Partner Parameters | | Method | PUT | | API Endpoint | /rest/company/{partnerId} | | Example Payload | | Update Partner Parameters
Code

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

| | | | Operation | Grant all Templates Access to Partner | | Method | POST | | API Endpoint | rest/templatepartnerlinkageresourceIdentifier=company | | Example Payload | | Grant Access to Partner
Code

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

| | | | Operation | Revoke all Templates Access to Partner | | Method | DELETE | | API Endpoint | rest/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
Code

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

| | | | Operation | Revoke Template Access from Partner | | Method | DELETE | | API Endpoint | rest/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
Code

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

| | | | Operation | Convert Internal Partner to External | | Method | POST | | API Endpoint | rest/company/enableSelfOnbaord | | Example Payload | | Code

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

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

APIs for managing Transactions​

OperationCreate Transaction
MethodPOST
API Endpoint/rest/transaction
Example Request Payload
Create Transaction
Code
{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "1111111111100" } }

| | | | Operation | Create Transaction with Parameters | | Method | POST | | API Endpoint | /rest/transaction | | Example Request Payload | | Create Transaction with Parameters
Code

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

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

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

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

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

| | | | Operation | Activate Transaction | | Method | PUT | | API Endpoint | rest/transaction/activate/{transaction_id} | | Example Request Payload | | {} | | | | Operation | Deactivate Transaction | | Method | PUT | | API Endpoint | rest/transaction/deactivate/{transaction_id} | | Example Request Payload | | {} | | | | Operation | Deactivate Transaction | | Method | PUT | | API Endpoint | rest/transaction/deactivate/{transaction_id} | | Example Request Payload | | {} | | | | Operation | Update the Transaction's event | | Method | PUT | | API Endpoint | rest/transaction/updateevent/{transaction_id} | | Example Request Payload | | Code

{
    "filterIn":"abc*.txt",
    "fileBaseLocation":"/<Folder name>/Source"
}

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

APIs for managing Transactions created using Custom Template ​

OperationCreate Transaction
MethodPOST
API Endpoint/rest/transaction
Example Request Payload
Create Transaction
Code
{
   "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 step, it is recommended that you run the**Get Step Info**API. | | Example Response | | Create Transaction
Code

{
   "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
         }
      ]
   }
}

| | | | Operation | Get Step Info | | Method | GET | | API Endpoint | /rest/transactiontemplate/getactivitiesinfo/{templateId}/{processFlowId} | | Example Request Payload | | EMPTY | | Example Response | | Get Step Info
Code

[
   {
      "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 to execute Transactions​

OperationExecute by File Upload
MethodPOST
API Endpointrest/adhoc/fileupload/transaction

/{transaction_id}
Example Request Payload
Content-Type: multipart/form-data Form Data

uploadedFile="File to be uploaded"
Example Response
Code
{"success":true}

| | | | Operation | Execute by Trigger Now (Run Now) | | Method | POST | | API Endpoint | rest/transaction/triggerjob/

{event_type}/{transaction_id} | | Example Request Payload | | {} | | Example Response | | Code

{"noOfFileProcessedPerPolling": 1}

|

Where, event_typeis 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 an 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.
OperationFetch Event
MethodGET
API Endpointrest/entities/events/{event_type}/{event_id}
Example Request Payload
N/A
OperationExecute by Trigger Now (Run Now)
MethodPUT
API Endpointrest/entities/events/{event_type}/{event_id}
Example Request Payload
Example: File event
Code
{  "FileEvent": {
    "id": "192168001015159341823445900004",
    "pollingFrequency": "5$m"
  }
}


Example: Calender event
Code

{
  "CalendarEvent": {
    "id": "192168001139156636227726500004",   "businessInterval": "0/30 * * * * ? *", "calendarType": "AllDays"
  }
}

| | | | 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 File events, FTP events, Database events, 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​

OperationGet all Schema and Mapping activities available to Partner
MethodGET
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
• DataMappingBy 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.
OperationGet all Schema and Mapping activities used by Partner in Transactions of a particular Template
MethodGET
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​

OperationView Connect Server (Developer Suite) Info
MethodGET
API Endpoint/rest/fetchproperties/aboutinformation
Example Response
Connect Server Information
Code
{ "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" } }

| | | | Operation | View Connect Portal Info | | Method | GET | | API Endpoint | /rest/applications/getTag | | Example Response | | Connect Portal Information
Code

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

|

APIs for System Console ​

OperationSystem Console JSON (diagnostics.json)
MethodGET
API Endpointrest/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, rest/diagnostics?component=all.
• To fetch the individual component JSON, mention the component name. For example, rest/diagnostics?component=backend-database.

APIs for scheduler ​

OperationStop scheduler
MethodGET
API Endpointrest/schedulerservice?query=Stop&page=1&start=0&limit=<page size>
Example Request Payload
N/A
OperationStart scheduler
MethodGET
API Endpointrest/schedulerservice?query=Start&page=1&start=0&limit=<page size>
Example Request Payload
N/A
OperationPause scheduler
MethodGET
API Endpointrest/schedulerservice?query=Resume&page=1&start=0&limit=<page size>
Example Request Payload
N/A
OperationResume scheduler
MethodGET
API Endpointrest/schedulerservice?query=Pause&page=1&start=0&limit=<page size>
Example Request Payload
N/A

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

APIs for kernel​

OperationPause kernel
MethodPOST
API Endpointrest/serviceAction/pause/Kernel?component=kernel&nodeName= <nodename>
Content Typeapplication/x-www-form-urlencoded
Example Request Payload
kernelStatus=Pause Kernel
OperationResume kernel
MethodPOST
API Endpointrest/serviceAction/pause/Kernel?component=kernel&nodeName= <nodename>
Content Typeapplication/x-www-form-urlencoded
Example Request Payload
kernelStatus=Resume Kernel

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.

You may be interested in...

What's new​
Best practices​
Training guides​
Frequently asked questions​
Adeptia Connect APIs​