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 are not copied between environments due to data loss concerns in the target environment.

The following are the attributes in the body of a deploy 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 may be shown to the user for informational purposes only. (Deployment is immutable and it’s version would never change.)
 name  string  yes (Required) Unique among other variables.
 description  string  yes Description of the deployment record.
 deployment_type  enum  no Send(0), Receive(1), Revert(2);
 content_in_json  string  no Deployment in JSON string.
 from_machine  string  no The machine where the deployment to be sent.
 to_machine  string  no The machine where receive the deployment from source.
 source_session  string  no Session on source machine.
 invocation_id  string  no
 predeploy_snapshot_id  string  no The service automatically snapshots the current the current state of the target environment prior to commencing the deployment. This is the ID of that snapshot in the target environment.
 postdeploy_snapshot_id  string  no The service automatically snapshots the current the current state of the target environment after completing the deployment. This is the ID of that snapshot in the target environment.
 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

Send deployment (a copy of all the assets) to a remote Xactly Connect service. Deployment record will be stored on both source and target environment. The resulting invocation resource location is returned in the Location header.
POST /connect/v1/deployments
Get a paginated list of all deployment 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/deployments




Get a single deployment definition. You have to provide a valid Deployment ID.




GET /connect/v1/deployments/{id}








Get the latest deployment definition. You have to provide a valid Deployment ID.




GET /connect/v1/deployments/latest








Get a list of all available source environments for deploy process.




GET /connect/v1/deployments/sources






Send request to get available target environments for deploy process




GET /connect/v1/deployments/targets




Deployment Container Entity and Partial Deployment


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 are not copied between











The following are the attributes in the body of a deploy 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
Read-only. This may be shown to the user for informational purposes only.




 name
 string
 yes
Required. Unique among other variables.




 description
 string
 yes
Optional. Description of the  container




 content
 array
 yes
Array of object references




 createdInstant
 datetime
 no
 Read-only.




 createdBy
 string
 no
Read-only. Username associated with session




 modifiedInstant
 datetime
 no
 Read-only.




 modifiedBy
 string
 no
Read-only. Username associated with session






List of APIs for managing Containers








Create a new deployment container.








POST /connect/v1/containers












Get a list of all deployment containers.








GET /connect/v1/containers








Get the a single deployment container definition. You have to provide a valid container ID.




GET /connect/v1/containers/{id}






Delete a single deployment container definition. You have to provide a valid container ID.


DELETE /connect/v1/containers/{id}






Update a single deployment container definition. You have to provide a valid container ID.




PUT /connect/v1/containers/{id}






Deploying a Container


Deployment of a container from source system to target system can be done through the deployment service.











The following are the attributes in the body of a deployment service.




Attribute
Type
Updatable
Comments




username
 string
 no





password
 string
 no





target
 string
 no





snapshotId
 string
 no
 Optional.

When present the deployment is done using that snapshot.		




 containerId
 string
 no
 Optional

Deployment payload is generated using the container represent by this id.		




deployOption
string
 no
Optional




deployOptionType
 string
 no
Optional






Endpoint for container deployment


POST /connect/v1/deployments