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

get

Returns an instance of type step

Path parameters

stepIdstringRequired

step Identifier

Query parameters

Responses

200

Successful response

application/vnd.api+json

get

/step/{stepId}

HTTPcURLJavaScriptPython

GET /api/v1/step/{stepId} HTTP/1.1
Host: 
Accept: */*

200

Successful response

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

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