Jump to

• Request
• Response

Gets the details of a workflow definition.

get

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

Gets the details of a workflow definition.

Request

Query Parameters

• majorVersion(required): string
• minorVersion: string
• workflowName(required): 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 : WorkflowDefinition

Type: object

The definition of a workflow

Show Source

• approxMaxConcurrentWorkflows: integer
• approxMaximumFinallyRunTimeSeconds: integer
• approxMaximumRunTimeSeconds: integer
• approxStartTimeoutSeconds: integer
• catchStepDefinition: Step
• description(required): string
  Maximum Length: 1000
• domainId: string
  Maximum Length: 64
• faultIds: array faultIds
• finallyStep: string
  Maximum Length: 64
• firstStep: string
  Maximum Length: 64
• generation: integer
• majorVersion: integer
• minorVersion: integer
• name(required): string
  Maximum Length: 256
• pollingMode: string
  Maximum Length: 64
• status: string
  Maximum Length: 64
• steps: array steps
• workflowName: string
  Maximum Length: 64
• workState: string

{
    "properties":{
        "workflowName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "majorVersion":{
            "description":"",
            "type":"integer"
        },
        "minorVersion":{
            "description":"",
            "type":"integer"
        },
        "domainId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "steps":{
            "description":"",
            "type":"array"
        },
        "firstStep":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "approxMaximumRunTimeSeconds":{
            "description":"",
            "type":"integer"
        },
        "finallyStep":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "approxMaximumFinallyRunTimeSeconds":{
            "description":"",
            "type":"integer"
        },
        "approxStartTimeoutSeconds":{
            "description":"",
            "type":"integer"
        },
        "approxMaxConcurrentWorkflows":{
            "description":"",
            "type":"integer"
        },
        "catchStepDefinition":{
            "description":"",
            "type":"Step"
        },
        "status":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "pollingMode":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":"The definition of a workflow"
}

Nested Schema : faultIds

Type: array

Nested Schema : steps

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