Get Environment Job Status

GET 
/v1/product/:product_id/environment/:environment_id/automation/:automation_id/status

Get the status of an environment automation job

Request

Path Parameters

environment_id uuidrequired

The environment ID

automation_id uuidrequired

The ID for the specific environment automation task

product_id uuidrequired

Product ID

Responses

200

Successful Response

application/json

Schema

Schema

environment_id uuidrequired

Environment for automation

automation_id uuidrequired

Identifier of automation job

status CustomerAutomationStatus (string)

Possible values: [in_progress, completed, action_required, cancelled, failure, queued, skipped, stale, timed_out, requested, waiting, pending, done]

An enumeration.

Example (from schema)

{
  "environment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "automation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "in_progress"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...