Jump to

• Request
• Response

List Attributes of an Instance

get

/process/api/v1/instances/{instanceId}/attributes

Get all the attributes of an instance.

Request

Path Parameters

• instanceId(required): string
  Process instance ID

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47
• oci-original-url:
  Endpoint requested by customer

There's no request body for this operation.

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
• object Variables-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "properties":{
                "instanceId":{
                    "type":"string",
                    "description":"Instance Id"
                },
                "applicationName":{
                    "type":"string",
                    "description":"Application name"
                },
                "applicationVersion":{
                    "type":"string",
                    "description":"Application version"
                },
                "processDefinitionKey":{
                    "type":"string",
                    "description":"Process definition key"
                },
                "activityId":{
                    "type":"string",
                    "description":"Activity ID"
                },
                "activityInstId":{
                    "type":"string",
                    "description":"Activity instance ID"
                },
                "activityName":{
                    "type":"string",
                    "description":"Activity name"
                },
                "items":{
                    "$ref":"#/components/schemas/VariablesMap"
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : Variables-allOf[1]

Type: object

Show Source

• activityId: string
  Activity ID
• activityInstId: string
  Activity instance ID
• activityName: string
  Activity name
• applicationName: string
  Application name
• applicationVersion: string
  Application version
• instanceId: string
  Instance Id
• items: VariablesMap
  Additional Properties Allowed: additionalProperties

  A (key, MapItem) map. `default`is an example key.
• processDefinitionKey: string
  Process definition key

{
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Instance Id"
        },
        "applicationName":{
            "type":"string",
            "description":"Application name"
        },
        "applicationVersion":{
            "type":"string",
            "description":"Application version"
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"Process definition key"
        },
        "activityId":{
            "type":"string",
            "description":"Activity ID"
        },
        "activityInstId":{
            "type":"string",
            "description":"Activity instance ID"
        },
        "activityName":{
            "type":"string",
            "description":"Activity name"
        },
        "items":{
            "$ref":"#/components/schemas/VariablesMap"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

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: 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 with given ID does not exist.

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top