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 body must valid ID and must match step on the URL.

For POST this is ignored.
 version  no This is shown to the user for informational purposes only.
 name  string  yes  (Required)
 value  string  yes  (Required)
 description  string  yes
 createdInstant  datetime  no
 createdBy  string  no Username associated with session
 modifiedInstant  datetime  no
 modifiedBy  string  no Username associated with session

List of APIs

Note: We have tried to keep this list up to date. However, for the most up to date list, see the interactive docs: https://connect-i1.xactlycorp.com/connect/docs/swagger-ui.html

POST /connect/v1/variables
Creates a Variable for managing the periodic invocation of a step or pipeline. Returns the resulting variable ID in the Location header. Session ID must be valid and session must be active (not expired).
DELETE /connect/v1/variables/{id}
Delete a Variable from the repository. Session ID must be valid and session must be active (not expired).
GET /connect/v1/variables
Retrieve a paginated list. You can provide a page number (default 0) and a page size (default 100, max 1000). Session ID must be valid and session must be active (not expired). A description of the pagination pattern and metadata can be found here: [link back to REST API ref]
GET /connect/v1/variables/{id}
Get a single Variable definition. You have to provide a valid Variable ID.
PUT /connect/v1/variables/{id}
Update a Variable definition. You have to provide a valid Variable definition ID in the URL and in the payload. The ID attribute can not be updated.

Searching variables

Variable service supports the same RSQL type search as audits and invocations. Here are some examples of searches:

Description Example
Search for all variables with a certain name /connect/v1/variables?ql=name==myVarName
Search for for variables created since July 21st, 2016 6:12 PM UTC /connect/v1/variables?ql=createdInstant=ge=2016-07-20T18:12:57.626Z
 click here to learn more about RSQL query language