Step

This endpoint is used to see the output for a job step.

Entity fields:

Path	Type	Description
data.type	string	Should be "step"
data.attributes.output	string	URL with the output for the step
data.attributes.status	string	Step status(pending or completed)
data.attributes.stepNumber	int	A job can have several steps, this field is used to identity the order for the execution

Example:

{
  "data": {
    "type": "step",
    "attributes": {
      "output": "URL with the step output",
      "stepNumber": "Step Number Order",
      "status": "Terraform Provider"
    }
  }
}

Supported Operations

Returns an instance of type step

GET/api/v1/step/{stepId}

Path parameters

stepId*string

step Identifier

Query parameters

Response

200

Successful response

Body

application/vnd.api+json

datastep (object)

includedarray of object

Included resources

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/step/{stepId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "output": "text",
      "status": "pending",
      "stepNumber": 0
    },
    "relationships": {
      "job": {
        "id": "text",
        "type": "job"
      }
    }
  },
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

For a complete list of organization operation please visit the OpenAPI specification