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 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 may be shown to the user for informational purposes only.
 name  string  yes (Required) Unique among other variables
 description  string  yes
 command  string  yes  (Required) The xCL command used to control the environment variables and the number of iterations.
 objectName  string  yes (Required)  The name of the step of pipeline over which to iterate
 objectType  string  yes  (Required) The type of the object over which to iterate. Value must be either “STEP” or “PIPELINE”
 currentState  list<string>  no  The current state of the iterator’s invocation
 labels  list<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/iterators
Creates a iterator for a step or pipeline. Returns the resulting iterator ID in the Location header.
DELETE /connect/v1/iterators/{id}
Delete a Iterator from the repository.
GET /connect/v1/iterators
Get a paginated list of all Iterator definitions.You can provide a page number (default 0) and a page size (default 100, max 1000). A description of the pagination pattern and metadata can be found here: [LINK]
GET /connect/v1/iterators/{id}
Get a single Iterator definition. You have to provide a valid Iterator ID.
PUT /connect/v1/iterators/{id}
Update a Iterator definition. You have to provide a valid Iterator definition ID in the URL and in the payload. The ID attribute can not be updated.
POST /connect/v1/iterators/{id}/invocation
Invoke (run) a Iterator.  Invoke the command(s) statements associated with a Iterator. This is an asynchronous call. The resulting Invocation resource location is returned in the Location header.