1 of 1

Step

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

Entity fields:

Path

Type

Description

Example:

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

Supported Operations

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

Step

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

Entity fields:

Path

Type

Description

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

fields[step]array of enum

Selects the set of step fields that should be returned in the result.

itemsenum

outputstatusstepNumberjob

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

job

Response

Successful response

Body

datastep (object)

typestring

idstring

attributesobject

outputstring

statusenum

pendingqueuerunningcompleted

stepNumberinteger (int32)

relationshipsobject

jobobject

idstring

typeenum

job

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

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

Response

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

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

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

Returns an instance of type step

GET/api/v1/step/{stepId}

Path parameters

stepId*string

step Identifier

Query parameters

fields[step]array of enum

Selects the set of step fields that should be returned in the result.

itemsenum

outputstatusstepNumberjob

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

job

Response

Successful response

Body

datastep (object)

typestring

idstring

attributesobject

outputstring

statusenum

pendingqueuerunningcompleted

stepNumberinteger (int32)

relationshipsobject

jobobject

idstring

typeenum

job

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

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

Response

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