Releases API

List releases

List all releases for an account:

GET /releases

Response

Status: 200 OK
[
  {
    "completion_target_at": "2016-06-14T15:00:00-05:00",
    "status": "implementation",
    "created_at": "2016-04-27T05:24:00-05:00",
    "updated_at": "2016-05-31T18:53:31-05:00",
    "subject": "Automate exchange rate updates in Expense Reporting",
    "id": 294,
    "sourceID": null,
    "completed_at": null,
    "impact": "none"
  },
  "..."
]

The response contains these fields by default. Filtering and pagination are available to reduce/limit the collection of releases.

States

The following states are available:

Collection Fields

By default the following fields will appear in collections of releases:

id sourceID subject impact status completion_target_at completed_at created_at updated_at

Obtain a different set of fields using the ?fields= parameter.

Sorting

By default a collection of releases is sorted descending by id.

The following fields are accepted by the ?sort= parameter:

id sourceID subject impact status completion_target_at completed_at created_at updated_at

List releases relevant for API user

List all releases which manager is the API user:

GET /releases/managed_by_me

Response

The response is similar to the response in List releases

Get a single release

GET /releases/:id

Response

Status: 200 OK
{
  "completion_target_at": "2016-06-14T15:00:00-05:00",
  "status": "implementation",
  "created_at": "2016-04-27T05:24:00-05:00",
  "updated_at": "2016-05-31T18:53:31-05:00",
  "subject": "Automate exchange rate updates in Expense Reporting",
  "id": 294,
  "sourceID": null,
  "completed_at": null,
  "impact": "none",
  "completion_reason": null,
  "manager": {
    "id": 53,
    "name": "Frank Watson",
    "account": {
      "id": "widget",
      "name": "Widget International"
    }
  },
  "source": null
}

The response contains these fields.

Create a release

POST /releases

When creating a new release these fields are available.

Response

Status: 201 Created
{
  "subject": "...",
  "...": "..."
}

The response contains all fields of the created release and is similar to the response in Get a single release

Update a release

PATCH /releases/:id

When updating a release these fields are available.

Response

Status: 200 OK
{
  "subject": "...",
  "...": "..."
}

The response contains all fields of the updated release and is similar to the response in Get a single release

Fields

completed_at
Readonly datetime — The Completed at field is automatically set to the date and time at which the release is set to the status “Completed”.
completion_reason
Readonly enum — The Completion reason field is automatically set based on the completion reason of the release’s changes. Possible values are:
  • withdrawn: Withdrawn - Withdrawn by Requester
  • rejected: Rejected - Rejected by Approver
  • rolled_back: Rolled Back - Original Environment Restored
  • partial: Partial - Not All Requirements Met
  • complete: Complete - All Requirements Met
completion_target_at
Readonly datetime — The Completion target field shows the target date and time of the last task of the changes that are related to the release.
created_at
Readonly datetime — The date and time at which the release was created.
id
Readonly integer — The unique ID of the release.
impact
Readonly enum — The Impact field shows the maximum impact level that is selected in the tasks of the changes that are related to the release. This indicates the maximum extent to which a “service instance”:/help/service_instance will be impacted by the implementation of the release. Possible values are:
  • none: None - Service Not Degraded
  • low: Low - Service Degraded for One User
  • medium: Medium - Service Down for One User
  • high: High - Service Degraded for Several Users
  • top: Top - Service Down for Several Users
manager
Required reference to Person, default: authenicated person — The Manager field is used to select the Person who is responsible for coordinating the implementation of the release. The person must have the release Manager role.
note
Optional text (max 64KB) — The Note field is used to provide a high-level description of the result that should be accomplished by the implementation of the release’s changes. It is also used to add any information that could prove useful for anyone affected by the release.
source
Optional string (max 30) - See source
sourceID
Optional string (max 128) - See source
status
Readonly enum — The Status field is automatically set based on the status of the release’s changes. Possible values are:
  • registered: Registered
  • risk_and_impact: Risk & Impact
  • approval: Approval
  • implementation: Implementation
  • progress_halted: Progress Halted
  • completed: Completed
subject
Required string (max 255) — The Subject field is used to enter a short description of the objective of the release.
updated_at
Readonly datetime — The date and time of the last update of the release. If the release has no updates it contains the created_at value.