Versions Compared

Old Version 19

changes.mady.by.user Nitin Beri

Saved on

compared with

New Version 20

changes.mady.by.user Nitin Beri

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can use the listed APIs on this page to view product information and to manage various activities (Partner, 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.

...

OperationMethodAPI EndpointExample Response
View Connect Server (Developer Suite) InfoGET

/rest/fetchproperties/aboutinformation

Code Block
titleCreate Partner
collapsetrue
{
   "aboutInformation":{
      "productName":"Adeptia Connect",
      "productVersion":"2.9.3",
      "edition":"Enterprise",
      "installationDate":"23 Aug, 2018",
      "expiryDate":"8 Oct, 2019",
      "connectPortal":"",
      "connectServer":"Release_AC_2_9_3_INC01_04Aug2018"
   }
}
View Connect Portal InfoGET/rest/applications/getTag
Code Block
titleCreate Partner
collapsetrue
{
   "tag":"UmVsZWFzZV9BQ19XZWJfMl85XzNfMzFKYW4yMDE5X0FDXzJfOV8zXzMxSmFuMjAxOQ==",
 "acTag":"Release_AC_Web_2_9_3_31Jan2019_AC_2_9_3_31Jan2019"
}

The tag infomation also provides details in encrypted form (for example:

UmVsZWFzZV9BQ19XZWJfMl85XzNfMzFKYW4yMDE5X0FDXzJfOV8zXzMxSmFuMjAxOQ==
 
APIs for Managing Partners
...
OperationMethodAPI EndpointExample and Notes
Get all Schema and Mapping activities available to Partner GET /rest/activities/{partnerId}
 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,ExcelSchema
Valid 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.
 
Get all Schema and Mapping activities used by Partner in Transactions of a particular TemplateGET /rest/activities/{partnerId}/{templateId}
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

 
...