Jump to

• Request
• Response

Gets a list of workflow instances based on a search criteria along with a paginiation token.

get

https://{host}:{port}/{basePath}/WorkFlow/workflowGetInstances

Gets a list of workflow instances based on a search criteria along with a paginiation token.

Request

Query Parameters

• includeNonTerminal(required): boolean
• includeTerminal(required): boolean
• limit: integer
• paginationToken: string

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object WorkFlow
  An WorkFlow object represents an instance of a workflow.

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

Nested Schema : WorkFlow

Type: object

An WorkFlow object represents an instance of a workflow.

Show Source

• arguments: string
  Maximum Length: 64
• completionCode: string
  Maximum Length: 64
• completionMessage: string
  Maximum Length: 64
• completionTimeMillis: integer
• creationTimestampMillis: integer
• domainId: string
  Maximum Length: 64
• faultIds: array faultIds
• finalState: string
  Maximum Length: 64
• majorVersion: integer
• minorVersion: integer
• name: string
  Maximum Length: 64
• status: string
  Maximum Length: 64
• surrogateKey: string
  Maximum Length: 64
• surrogateKeyScope: string
  Maximum Length: 64
• tag: string
  Maximum Length: 64
• wfid: string
  Maximum Length: 64

{
    "properties":{
        "wfid":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "name":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "majorVersion":{
            "description":"",
            "type":"integer"
        },
        "minorVersion":{
            "description":"",
            "type":"integer"
        },
        "domainId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "surrogateKey":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "surrogateKeyScope":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "arguments":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "creationTimestampMillis":{
            "description":"",
            "type":"integer"
        },
        "completionTimeMillis":{
            "description":"",
            "type":"integer"
        },
        "status":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "tag":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "completionCode":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "completionMessage":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "finalState":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "type":"object",
    "description":"An WorkFlow object represents an instance of a workflow."
}

Nested Schema : faultIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top