chain

The Chain API endpoints provide an interface for getting information about chains and their commands.

Chain

Properties

Name	Type	Description	Restrictions
concurrency_enabled	boolean	Whether or not the chain will execute commands in parallel.
created_at	string	A timestamp representing the original creation time of the chain.
description	string	A brief summary of what the chain does.
disabled	boolean	Whether or not the chain is disabled.
id	ID	The unique identifier of a resource (can be a GUID).
internal_id	integer	The unique identifier of the chain resource in the Chains environment.
name	string	The name of the chain.
runtime_inputs	[object]	Variables available for user input for each execution.
runtime_inputs.data_type	string	The data type of the variable.
runtime_inputs.vuid	string	The unique identifier of the variable.
schedules	[ChainSchedule]	An array describing the automated schedule for a chain run.
updated_at	string	A timestamp representing the last updated time of the chain.

Example

{
  "concurrency_enabled": true,
  "created_at": "2018-03-14 20:10:39.520585",
  "description": "Sends an email when new changes are made to a Workiva spreadsheet.",
  "disabled": false,
  "id": "74",
  "internal_id": 74,
  "name": "Monitoring Chain",
  "runtime_inputs": [
    {
      "data_type": "file",
      "vuid": "45072337-72ee-4c52-9428-0b2ae21ac73c"
    }
  ],
  "schedules": [
    {
      "enabled": true,
      "end_at": "string",
      "properties": {
        "days_of_month": [
          "string"
        ],
        "days_of_week": [
          "string"
        ],
        "recurring_interval": 0,
        "recurring_type": "string",
        "run_at_hours": 0,
        "run_at_minutes": 0,
        "run_at_seconds": 0,
        "stop_at_hours": 0,
        "stop_at_minutes": 0,
        "zone": "string"
      },
      "start_at": "string"
    }
  ],
  "updated_at": "2018-03-14 20:10:39.520585"
}

Command

Properties

Name	Type	Description	Restrictions
description	string	A brief summary of what the command does.
id	ID	The unique identifier of a resource (can be a GUID).
link_id	string	The link ID associated with the command.
name	string	The name of the command.

Example

{
  "description": "string",
  "id": "74",
  "link_id": "string",
  "name": "string"
}

ChainsResponse

Properties

Name	Type	Description	Restrictions
data	[Chain]

Example

{
  "data": [
    {
      "concurrency_enabled": true,
      "created_at": "2018-03-14 20:10:39.520585",
      "description": "Sends an email when new changes are made to a Workiva spreadsheet.",
      "disabled": false,
      "id": "74",
      "internal_id": 74,
      "name": "Monitoring Chain",
      "runtime_inputs": [
        {
          "data_type": "file",
          "vuid": "45072337-72ee-4c52-9428-0b2ae21ac73c"
        }
      ],
      "schedules": [
        {
          "enabled": true,
          "end_at": "string",
          "properties": {
            "days_of_month": [
              "string"
            ],
            "days_of_week": [
              "string"
            ],
            "recurring_interval": 0,
            "recurring_type": "string",
            "run_at_hours": 0,
            "run_at_minutes": 0,
            "run_at_seconds": 0,
            "stop_at_hours": 0,
            "stop_at_minutes": 0,
            "zone": "string"
          },
          "start_at": "string"
        }
      ],
      "updated_at": "2018-03-14 20:10:39.520585"
    }
  ]
}

ChainSchedule

Properties

Name	Type	Description	Restrictions
enabled	boolean
end_at	string
properties	object
properties.days_of_month	[string]
properties.days_of_week	[string]
properties.recurring_interval	integer
properties.recurring_type	string
properties.run_at_hours	integer
properties.run_at_minutes	integer
properties.run_at_seconds	integer
properties.stop_at_hours	integer
properties.stop_at_minutes	integer
properties.zone	string
start_at	string

Example

{
  "enabled": true,
  "end_at": "string",
  "properties": {
    "days_of_month": [
      "string"
    ],
    "days_of_week": [
      "string"
    ],
    "recurring_interval": 0,
    "recurring_type": "string",
    "run_at_hours": 0,
    "run_at_minutes": 0,
    "run_at_seconds": 0,
    "stop_at_hours": 0,
    "stop_at_minutes": 0,
    "zone": "string"
  },
  "start_at": "string"
}