Connect REST Reference

Connect REST Audit Entity

Audit Entity Attribute Type Updatable Comments  id  UUID  no  action  string  no The action that resulted from the API call  username  string  no The username for the active session used for […]

Connect REST Snapshot Entity

Snapshot Entity Use snapshot in conjunction with Connect’s deploy commands to migrate Connect domain objects from one environment to another. The following are the attributes in the body of a […]

Connect REST Deployment Entity

Deployment Entity Deploy service is used to migrate “Xactly Connect” domain objects from one Connect source environment to another target environment. Domain objects include steps, pipelines, schedules, variables, etc. Tables […]

Connect REST Iterator Entity

Iterator Entity The following are the attributes in the body of a iterator service. Iterator service is used to loop over the invocation of a step or pipeline. Attribute Type […]

Connect REST Credential Entity

Credential Entity The following are the attributes in the body of a credential service. Attribute Type Updatable Comments  id  UUID  no (Required for PUT only) For PUT the ID in […]

Connect REST File Directory Listing Entity

File / Directory Listing Entity To see the full list of /files APIs see the Swagger interactive docs. The only /files related API that produces JSON is the /files/list API. […]

Connect REST Variable Entity

Variable Entity The following are the attributes in the body of a variable service. Attribute Type Updatable Comments  id  UUID  no (Required for PUT only) For PUT the ID in […]

Connect REST InvocationDetail Entity

InvocationDetail Entity The following are the attributes in the body of a InvocationDetail entity you will find inside of a single invocation entity. Attribute Type Updatable Comments id  n/a version […]

Connect REST Invocation Entity

Invocation Entity The following are the attributes in the body of a invocation service. You would only see this in the response body of a GET request. Attribute Type Updatable […]

Connect REST Schedule Entity

Schedule Entity The following are the attributes in the body of a Schedule service. Attribute Type Updatable Comments  id  UUID  no (Required for PUT only)For PUT the ID in body […]