Jump to

• Request
• Response

Get Variables for Dynamic Process Instance

get

/ic/api/process/v1/dp-instances/{id}/variables

Get all the variables for the dynamic process instance with the specified ID.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Process Instance ID

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : Variables

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object Variables-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "instanceId":{
                    "type":"string",
                    "description":"Instance ID"
                },
                "items":{
                    "$ref":"#/definitions/VariablesMap"
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links(optional): array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Variables-allOf[1]

Type: object

Show Source

• instanceId(optional): string
  Instance ID
• items(optional): object VariablesMap
  Additional Properties Allowed: additionalProperties

  a (key, MapItem) map. `default`is an example key

{
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Instance ID"
        },
        "items":{
            "$ref":"#/definitions/VariablesMap"
        }
    }
}

Nested Schema : VariablesMap

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

a (key, MapItem) map. `default`is an example key

Show Source

• default(optional): object default

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : default

Type: object

Nested Schema : additionalProperties

Type: object

401 Response

Unauthorized.

404 Response

Process instance ID does not exist.

500 Response

Internal Server Error.

Back to Top