Jump to

• Request
• Response

List Target Activities of an Instance

get

/process/api/v1/instances/{instanceId}/target-activities

Fetches all the target activities of a process instance.

Note:

You can use this API only on structured processes.

Request

Path Parameters

• instanceId(required): string
  Process Instance Id

Query Parameters

• fetchCompleted: boolean
  Fetch completed activities

  Default Value: false

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 : AlterflowResponse

Type: object

Show Source

• activities: array activities

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "activities":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Activity"
            }
        }
    }
}

Match All

Show Source

• object CommonModel

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "activities":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Activity"
            }
        }
    }
}

Nested Schema : activities

Type: array

Show Source

• Array of: object Activity

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

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : Activity

Type: object

Show Source

• activityId: string
• activityInstanceId: string
• activityName: string
• activityType: string

{
    "type":"object",
    "properties":{
        "activityId":{
            "type":"string",
            "require":true
        },
        "activityName":{
            "type":"string",
            "require":true
        },
        "activityType":{
            "type":"string",
            "require":true
        },
        "activityInstanceId":{
            "type":"string",
            "require":true
        }
    }
}

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

Examples

Select an example List of target activities

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