Get variable

GET 
/variables/:variableKey

Get the variable by the variable key.

Request

Path Parameters

variableKey int64required

The variable key.

Responses

200

The variable is successfully returned.

application/json

Schema

Schema

name string

Name of this variable.

value string

Value of this variable.

fullValue string

Full value of this variable.

tenantId string

Tenant ID of this variable.

isTruncated boolean

Whether the value is truncated or not.

variableKey string

The key for this variable.

scopeKey string

The key of the scope of this variable.

processInstanceKey string

The key of the process instance of this variable.

Example (from schema)

{
  "variableKey": "string",
  "scopeKey": "string",
  "processInstanceKey": "string",
  "name": "string",
  "value": "string",
  "fullValue": "string",
  "tenantId": "string",
  "isTruncated": true
}

application/vnd.camunda.api.keys.number+json

Schema

Schema

name string

Name of this variable.

value string

Value of this variable.

fullValue string

Full value of this variable.

tenantId string

Tenant ID of this variable.

isTruncated boolean

Whether the value is truncated or not.

variableKey int64

The key for this variable.

scopeKey int64

The key of the scope of this variable.

processInstanceKey int64

The key of the process instance of this variable.

Example (from schema)

{
  "variableKey": 0,
  "scopeKey": 0,
  "processInstanceKey": 0,
  "name": "string",
  "value": "string",
  "fullValue": "string",
  "tenantId": "string",
  "isTruncated": true
}

application/vnd.camunda.api.keys.string+json

Schema

Schema

name string

Name of this variable.

value string

Value of this variable.

fullValue string

Full value of this variable.

tenantId string

Tenant ID of this variable.

isTruncated boolean

Whether the value is truncated or not.

variableKey string

The key for this variable.

scopeKey string

The key of the scope of this variable.

processInstanceKey string

The key of the process instance of this variable.

Example (from schema)

{
  "variableKey": "string",
  "scopeKey": "string",
  "processInstanceKey": "string",
  "name": "string",
  "value": "string",
  "fullValue": "string",
  "tenantId": "string",
  "isTruncated": true
}

400

Bad request

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

The request lacks valid authentication credentials.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Forbidden. The request is not allowed.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not found

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...