REST deployment window events

Deployment window events are individual occurrences of the deployment window series for a specific environment.

GET /v1/deployment_window/events/[id]

Returns the deployment window event by ID.

Common attributes

• id — Numerical unique ID for a deployment window event
• format — Ensure to include an accept header or add .xml or .json  to the last path element
• token — Your API Token for authentication

Filters

• include_except—Comma-separated strings of the top-level associated items to exclude from the response. You can remove only top-level associated items from the response and these associated items should be a collection (zero to many) of other objects (not a simple property—string, numeric, boolean, and so on). For example, you can remove components from an application but you cannot remove route gates (it is not a top-level associated item) or app_version (it is a simple property). If you provide an incorrect associated item name (for example, the associated item does not exist, is not at the top level, or is a property), the name is ignored. See the table below for the items and their associated items.
• alone—Boolean value to return only the item or the associated items as well along with the item. If set to false (default), item and associated item details are returned; if set to true, only item details are returned. See the table below for the items and their associated items. See the table below for the items and their associated items.

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when record to show is not found

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

Filter example:

PUT /v1/deployment_window/events/[id]

Updates an existing deployment window with values from the posted data.

Editable attributes

• state — String value for the current state of the deployment window event. When you change the state attribute, the reason attribute is required. The following values are allowed for the state attribute:
  • created — The default  state for the created deployment window event
  • suspended — The deployment window event state for used for suspending the deployment window event
  • resumed — The deployment window event state for used for resuming the the deployment window event after the suspension
  • moved — The deployment window event state for used moving the deployment window event
    
• reason  — String value for the reason of the status change. This attribute is required if you change the state attribute
• start_at — String value in the date and time format for the deployment window event start. If you can change the start_at value, change the state attribute to moved and enter a value for the reason attribute
• finish_at — String value in the date and time format for the deployment window event finish. If you can change the start_at value, change the state attribute to moved and enter a value for the reason attribute

Common attributes

• format — Ensure to include an accept header or add .xml or .json to the last path element
• token — Your API Token for authentication

Filters

• include_except—Comma-separated strings of the top-level associated items to exclude from the response. You can remove only top-level associated items from the response and these associated items should be a collection (zero to many) of other objects (not a simple property—string, numeric, boolean, and so on). For example, you can remove components from an application but you cannot remove route gates (it is not a top-level associated item) or app_version (it is a simple property). If you provide an incorrect associated item name (for example, the associated item does not exist, is not at the top level, or is a property), the name is ignored. See the table below for the items and their associated items.
• alone—Boolean value to return only the item or the associated items as well along with the item. If set to false (default), item and associated item details are returned; if set to true, only item details are returned. See the table below for the items and their associated items. See the table below for the items and their associated items.

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when record to update is not found
• ERROR 422 Unprocessable entity — Occurs when validation fails, objects and errors are returned

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

Filter example:

Sample output

The following JSON is a sample output from GET /v1/deployment_windows/events/12:

The following XML is a sample output from {{code language="none"}}
GET /v1/deployment_windows/events/12
{{/code}}: