Additional Objects

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"
    }
  ]
}

ChainResponse

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"
  }
}

CommandsResponse

Properties

Name	Type	Description	Restrictions
data	[Command]

Example

{
  "data": [
    {
      "description": "string",
      "id": "74",
      "link_id": "string",
      "name": "string"
    }
  ]
}

CreatedWithErrorResponse

A response object that will include both the ID and the error message. This is for a “compound operation” that can fail (e.g. creating a resource and then queuing something, where the creation passes, but the queuing fails).

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of a resource (can be a GUID).
message	string	A message indicating the error.
url	string	The URL that can be used to get the resource.

Example

{
  "id": "string",
  "message": "string",
  "url": "string"
}

MappingRuleUploadResult

Properties

Name	Type	Description	Restrictions
errors	[ErrorWithLineNumber]
mappingRules	[MappingRule]	An object containing information about a mapping rule.

Example

{
  "errors": [
    {
      "error": "string",
      "lineNumber": 0
    }
  ],
  "mappingRules": [
    {
      "conditions": {
        "combinator": "AND",
        "rules": [
          {
            "combinator": "AND",
            "rules": [
              {
                "field": "string",
                "operator": "NULL",
                "value": [
                  "string"
                ]
              }
            ]
          }
        ]
      },
      "id": 0,
      "mappingGroupGuid": "74",
      "position": 0,
      "source": "string",
      "target": "string",
      "type": "LIKE"
    }
  ]
}

MappingRule

An object containing information about a mapping rule.

Properties

Name	Type	Description	Restrictions
conditions	Conditions
id	integer
mappingGroupGuid	ID	The unique identifier of a resource (can be a GUID).
position	integer
source	string
target	string
type	string

Enumerated Values

Property	Value
type	LIKE
type	EXACT
type	REGEX

Example

{
  "conditions": {
    "combinator": "AND",
    "rules": [
      {
        "combinator": "AND",
        "rules": [
          {
            "field": "string",
            "operator": "NULL",
            "value": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "id": 0,
  "mappingGroupGuid": "74",
  "position": 0,
  "source": "string",
  "target": "string",
  "type": "LIKE"
}

ErrorWithLineNumber

Properties

Name	Type	Description	Restrictions
error	string
lineNumber	integer

Example

{
  "error": "string",
  "lineNumber": 0
}

EnvironmentsResponse

Properties

Name	Type	Description	Restrictions
data	[Environment]	An object containing information about a particular workspace environment.

Example

{
  "data": [
    {
      "chains_count": 0,
      "color": "string",
      "created_at": "string",
      "description": "string",
      "id": "74",
      "name": "string",
      "position": 0,
      "settings": {
        "color": "string"
      },
      "updated_at": "string",
      "variables": [
        {
          "defaultValue": "string",
          "encrypted": true,
          "key": "string",
          "label": "string",
          "value": "string"
        }
      ]
    }
  ]
}

EnvironmentResponse

Properties

Name	Type	Description	Restrictions
data	Environment	An object containing information about a particular workspace environment.

Example

{
  "data": {
    "chains_count": 0,
    "color": "string",
    "created_at": "string",
    "description": "string",
    "id": "74",
    "name": "string",
    "position": 0,
    "settings": {
      "color": "string"
    },
    "updated_at": "string",
    "variables": [
      {
        "defaultValue": "string",
        "encrypted": true,
        "key": "string",
        "label": "string",
        "value": "string"
      }
    ]
  }
}

Environment

An object containing information about a particular workspace environment.

Properties

Name	Type	Description	Restrictions
chains_count	integer(int64)
color	string
created_at	string
description	string
id	ID	The unique identifier of a resource (can be a GUID).
name	string
position	integer(int64)
settings	object
settings.color	string
updated_at	string
variables	[Variable]

Example

{
  "chains_count": 0,
  "color": "string",
  "created_at": "string",
  "description": "string",
  "id": "74",
  "name": "string",
  "position": 0,
  "settings": {
    "color": "string"
  },
  "updated_at": "string",
  "variables": [
    {
      "defaultValue": "string",
      "encrypted": true,
      "key": "string",
      "label": "string",
      "value": "string"
    }
  ]
}

ChainRunPageResponse

Properties

Name	Type	Description	Restrictions
data	ChainRunPage

Example

{
  "data": {
    "chainExecutors": [
      {
        "chainId": "74",
        "endAt": "string",
        "envId": "74",
        "id": "74",
        "launchType": "manual",
        "pausedAt": "string",
        "resultText": "string",
        "resumedAt": "string",
        "startAt": "string",
        "state": "sleeping",
        "userId": "74",
        "userName": "string"
      }
    ],
    "cursor": "string"
  }
}

ChainRunPage

Properties

Name	Type	Description	Restrictions
chainExecutors	[ChainRun]	An array of the chain runs.
cursor	string	Cursor value indicating page information for the data to retrieve.

Example

{
  "chainExecutors": [
    {
      "chainId": "74",
      "endAt": "string",
      "envId": "74",
      "id": "74",
      "launchType": "manual",
      "pausedAt": "string",
      "resultText": "string",
      "resumedAt": "string",
      "startAt": "string",
      "state": "sleeping",
      "userId": "74",
      "userName": "string"
    }
  ],
  "cursor": "string"
}

ChainRunResponse

Properties

Name	Type	Description	Restrictions
data	ChainRun

Example

{
  "data": {
    "chainId": "74",
    "endAt": "string",
    "envId": "74",
    "id": "74",
    "launchType": "manual",
    "pausedAt": "string",
    "resultText": "string",
    "resumedAt": "string",
    "startAt": "string",
    "state": "sleeping",
    "userId": "74",
    "userName": "string"
  }
}

ChainRun

Properties

Name	Type	Description	Restrictions
chainId	ID	The unique identifier of a resource (can be a GUID).
endAt	string	The timestamp at which the chain run completed.
envId	ID	The unique identifier of a resource (can be a GUID).
id	ID	The unique identifier of a resource (can be a GUID).
launchType	string	The type of event that triggered the chain run.
pausedAt	string	The timestamp at which the chain run was paused.
resultText	string	The result of the chain run.
resumedAt	string	The timestamp at which the chain run was resumed.
startAt	string	The timestamp at which the chain run started.
state	string	The state of the chain run.
userId	ID	The unique identifier of a resource (can be a GUID).
userName	string	The user that triggered the chain run.

Enumerated Values

Property	Value
launchType	manual
launchType	api
launchType	schedule
launchType	trigger
launchType	slack
launchType	trigger_event
state	sleeping
state	enqueueing
state	paused
state	errored
state	warned
state	all_succeeded
state	stopped

Example

{
  "chainId": "74",
  "endAt": "string",
  "envId": "74",
  "id": "74",
  "launchType": "manual",
  "pausedAt": "string",
  "resultText": "string",
  "resumedAt": "string",
  "startAt": "string",
  "state": "sleeping",
  "userId": "74",
  "userName": "string"
}

ChainRunWithNodesResponse

Properties

Name	Type	Description	Restrictions
data	ChainRunWithNodes	A chain run object with details about all of the command nodes used in that run.

Example

{
  "data": {
    "chainId": "74",
    "endAt": "string",
    "envId": "74",
    "id": "74",
    "launchType": "manual",
    "nodes": [
      {
        "endAt": "string",
        "id": "74",
        "iterable": true,
        "name": "string",
        "nodeId": "74",
        "nodeType": "command",
        "results": [
          {
            "id": "74",
            "iteratorValue": "string",
            "outputLogUrl": "string",
            "outputVariables": {
              "data": "string",
              "path": "string"
            },
            "state": "active"
          }
        ],
        "startAt": "string",
        "state": "sleeping"
      }
    ],
    "pausedAt": "string",
    "resultText": "string",
    "resumedAt": "string",
    "startAt": "string",
    "state": "sleeping",
    "userId": "74",
    "userName": "string"
  }
}

ChainRunWithNodes

A chain run object with details about all of the command nodes used in that run.

Properties

Name	Type	Description	Restrictions
chainId	ID	The unique identifier of a resource (can be a GUID).
endAt	string	The timestamp at which the chain run completed.
envId	ID	The unique identifier of a resource (can be a GUID).
id	ID	The unique identifier of a resource (can be a GUID).
launchType	string	The type of event that triggered the chain run.
nodes	[ChainRunNode]
pausedAt	string	The timestamp at which the chain run was paused.
resultText	string	The result of the chain run.
resumedAt	string	The timestamp at which the chain run was resumed.
startAt	string	The timestamp at which the chain run started.
state	string	The state of the chain run.
userId	ID	The unique identifier of a resource (can be a GUID).
userName	string	The user that triggered the chain run.

Enumerated Values

Property	Value
launchType	manual
launchType	api
launchType	schedule
launchType	trigger
launchType	slack
launchType	trigger_event
state	sleeping
state	enqueueing
state	paused
state	errored
state	warned
state	all_succeeded
state	stopped

Example

{
  "chainId": "74",
  "endAt": "string",
  "envId": "74",
  "id": "74",
  "launchType": "manual",
  "nodes": [
    {
      "endAt": "string",
      "id": "74",
      "iterable": true,
      "name": "string",
      "nodeId": "74",
      "nodeType": "command",
      "results": [
        {
          "id": "74",
          "iteratorValue": "string",
          "outputLogUrl": "string",
          "outputVariables": {
            "data": "string",
            "path": "string"
          },
          "state": "active"
        }
      ],
      "startAt": "string",
      "state": "sleeping"
    }
  ],
  "pausedAt": "string",
  "resultText": "string",
  "resumedAt": "string",
  "startAt": "string",
  "state": "sleeping",
  "userId": "74",
  "userName": "string"
}

ActivityResponse

Properties

Name	Type	Description	Restrictions
data	[Activity]	An object representing an event within chains.

Example

{
  "data": [
    {
      "created_at": "string",
      "id": "74",
      "key": "string",
      "owner_id": "74",
      "owner_type": "string",
      "parameters": {
        "id": "74"
      },
      "recipient_id": "74",
      "recipient_type": "string",
      "trackable_id": "74",
      "trackable_type": "string",
      "updated_at": "string"
    }
  ]
}

Activity

An object representing an event within chains.

Properties

Name	Type	Description	Restrictions
created_at	string
id	ID	The unique identifier of a resource (can be a GUID).
key	string
owner_id	ID	The unique identifier of a resource (can be a GUID).
owner_type	string
parameters	object
parameters.id	ID	The unique identifier of a resource (can be a GUID).
recipient_id	ID	The unique identifier of a resource (can be a GUID).
recipient_type	string
trackable_id	ID	The unique identifier of a resource (can be a GUID).
trackable_type	string
updated_at	string

Example

{
  "created_at": "string",
  "id": "74",
  "key": "string",
  "owner_id": "74",
  "owner_type": "string",
  "parameters": {
    "id": "74"
  },
  "recipient_id": "74",
  "recipient_type": "string",
  "trackable_id": "74",
  "trackable_type": "string",
  "updated_at": "string"
}

LoginActivityResponse

Properties

Name	Type	Description	Restrictions
data	[LoginActivity]	Information about a particular login event.

Example

{
  "data": [
    {
      "city": "string",
      "context": "string",
      "country": "string",
      "created_at": "string",
      "failure_reason": "string",
      "id": "74",
      "identity": "string",
      "ip": "string",
      "region": "string",
      "success": true,
      "user_id": "74"
    }
  ]
}

LoginActivity

Information about a particular login event.

Properties

Name	Type	Description	Restrictions
city	string
context	string
country	string
created_at	string
failure_reason	string
id	ID	The unique identifier of a resource (can be a GUID).
identity	string
ip	string
region	string
success	boolean
user_id	ID	The unique identifier of a resource (can be a GUID).

Example

{
  "city": "string",
  "context": "string",
  "country": "string",
  "created_at": "string",
  "failure_reason": "string",
  "id": "74",
  "identity": "string",
  "ip": "string",
  "region": "string",
  "success": true,
  "user_id": "74"
}

PermissionsResponse

Properties

Name	Type	Description	Restrictions
data	[Permission]	An object containing information about access permission to particular chains resources.

Example

{
  "data": [
    {
      "id": "74",
      "name": "read",
      "object_id": "74",
      "object_name": "string",
      "object_type": "string",
      "user_groups": [
        {
          "created_at": "string",
          "default": true,
          "id": "74",
          "name": "string"
        }
      ]
    }
  ]
}

Permission

An object containing information about access permission to particular chains resources.

Properties

Name	Type	Description	Restrictions
id	ID	The unique identifier of a resource (can be a GUID).
name	string
object_id	ID	The unique identifier of a resource (can be a GUID).
object_name	string
object_type	string
user_groups	[UserGroup]	An object containing information about a particular group in Chains.

Enumerated Values

Property	Value
name	read
name	execute
name	write
name	create
name	admin

Example

{
  "id": "74",
  "name": "read",
  "object_id": "74",
  "object_name": "string",
  "object_type": "string",
  "user_groups": [
    {
      "created_at": "string",
      "default": true,
      "id": "74",
      "name": "string"
    }
  ]
}

UserGroupsResponse

Properties

Name	Type	Description	Restrictions
data	[UserGroup]	An object containing information about a particular group in Chains.

Example

{
  "data": [
    {
      "created_at": "string",
      "default": true,
      "id": "74",
      "name": "string"
    }
  ]
}

UserGroupResponse

Properties

Name	Type	Description	Restrictions
data	UserGroup	An object containing information about a particular group in Chains.

Example

{
  "data": {
    "created_at": "string",
    "default": true,
    "id": "74",
    "name": "string"
  }
}

UserGroup

An object containing information about a particular group in Chains.

Properties

Name	Type	Description	Restrictions
created_at	string
default	boolean
id	ID	The unique identifier of a resource (can be a GUID).
name	string

Example

{
  "created_at": "string",
  "default": true,
  "id": "74",
  "name": "string"
}

UsersResponse

Properties

Name	Type	Description	Restrictions
data	[User]	An object containing information about a particular user in Chains.

Example

{
  "data": [
    {
      "created_at": "string",
      "email": "string",
      "first_name": "string",
      "id": "74",
      "last_name": "string",
      "last_sign_in_at": "string",
      "sso_enabled": true
    }
  ]
}

UserResponse

Properties

Name	Type	Description	Restrictions
data	User	An object containing information about a particular user in Chains.

Example

{
  "data": {
    "created_at": "string",
    "email": "string",
    "first_name": "string",
    "id": "74",
    "last_name": "string",
    "last_sign_in_at": "string",
    "sso_enabled": true
  }
}

User

An object containing information about a particular user in Chains.

Properties

Name	Type	Description	Restrictions
created_at	string
email	string
first_name	string¦null
id	ID	The unique identifier of a resource (can be a GUID).
last_name	string¦null
last_sign_in_at	string¦null
sso_enabled	boolean

Example

{
  "created_at": "string",
  "email": "string",
  "first_name": "string",
  "id": "74",
  "last_name": "string",
  "last_sign_in_at": "string",
  "sso_enabled": true
}

WorkspacesResponse

Properties

Name	Type	Description	Restrictions
data	[Workspace]

Example

{
  "data": [
    {
      "company_id": "74",
      "description": "string",
      "external_id": "74",
      "id": "74",
      "name": "string",
      "variables": [
        {
          "defaultValue": "string",
          "encrypted": true,
          "key": "string",
          "label": "string",
          "value": "string"
        }
      ]
    }
  ]
}

WorkspaceResponse

Properties

Name	Type	Description	Restrictions
data	Workspace

Example

{
  "data": {
    "company_id": "74",
    "description": "string",
    "external_id": "74",
    "id": "74",
    "name": "string",
    "variables": [
      {
        "defaultValue": "string",
        "encrypted": true,
        "key": "string",
        "label": "string",
        "value": "string"
      }
    ]
  }
}

Workspace

Properties

Name	Type	Description	Restrictions
company_id	ID	The unique identifier of a resource (can be a GUID).
description	string	A description of the workspace.
external_id	ID	The unique identifier of a resource (can be a GUID).
id	ID	The unique identifier of a resource (can be a GUID).
name	string	The name of the workspace.
variables	[Variable]	A list of the workspace’s variables.

Example

{
  "company_id": "74",
  "description": "string",
  "external_id": "74",
  "id": "74",
  "name": "string",
  "variables": [
    {
      "defaultValue": "string",
      "encrypted": true,
      "key": "string",
      "label": "string",
      "value": "string"
    }
  ]
}