Jump to

• Request
• Response

Get all WorkItem objects that meet the filter criteria.

put

https://{host}:{port}/{basePath}/WorkItem/filter

get all WorkItem objects that meet the filter criteria.

Request

Header Parameters

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

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• filter: object Filter

{
    "properties":{
        "filter":{
            "$ref":"#/components/schemas/Filter",
            "type":"object"
        }
    }
}

Nested Schema : Filter

Type: object

Show Source

• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• filterConditions: array filterConditions
• generation: integer
• maxResults: integer
• name(required): string
  Maximum Length: 256
• objType: string
  Maximum Length: 64
• orderByList: array orderByList
• orderType: string
  Allowed Values: [ "ASCENDING", "DESCENDING" ]
• workState: string

{
    "properties":{
        "objType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "maxResults":{
            "description":"",
            "type":"integer"
        },
        "orderByList":{
            "description":"",
            "type":"array"
        },
        "orderType":{
            "description":"",
            "enum":[
                "ASCENDING",
                "DESCENDING"
            ],
            "type":"string"
        },
        "filterConditions":{
            "description":"",
            "type":"array"
        },
        "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":""
}

Nested Schema : faultIds

Type: array

Nested Schema : filterConditions

Type: array

Nested Schema : orderByList

Type: array

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 WorkItem
  A WorkItem represents a unit of work in the context of a Job. A Job may contain one or multiple work items.

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

Nested Schema : WorkItem

Type: object

A WorkItem represents a unit of work in the context of a Job. A Job may contain one or multiple work items.

Show Source

• configObjs: array configObjs
• description(required): string
  Maximum Length: 1000
• endTime: string
  Maximum Length: 64
• errorDetails: ErrorDetails
  Read-only and this operation is unsupported. @param errorDetails
• invalidated: boolean
  Read-only and this operation is unsupported. @param invalidated - Unsupported.
• jobId: object Job
  A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects.
• startTime: string
  Maximum Length: 64
• status: string
  Allowed Values: [ "ACTIVE", "NOT_RUN", "EXECUTING", "SUCCEEDED", "FAILED", "CANCELLED", "OPERATOR_CANCELLED" ]
• targetObj: AssociatedObj
• workItemName(required): string
  Maximum Length: 256
• workQueueEntryIds: array workQueueEntryIds

{
    "properties":{
        "targetObj":{
            "description":"",
            "type":"AssociatedObj"
        },
        "configObjs":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "invalidated":{
            "description":"Read-only and this operation is unsupported. @param invalidated - Unsupported.",
            "type":"boolean"
        },
        "workItemName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "status":{
            "description":"",
            "enum":[
                "ACTIVE",
                "NOT_RUN",
                "EXECUTING",
                "SUCCEEDED",
                "FAILED",
                "CANCELLED",
                "OPERATOR_CANCELLED"
            ],
            "type":"string"
        },
        "errorDetails":{
            "description":"Read-only and this operation is unsupported. @param errorDetails",
            "type":"ErrorDetails"
        },
        "startTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "endTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "jobId":{
            "description":"",
            "$ref":"#/components/schemas/Job"
        },
        "workQueueEntryIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "workItemName"
    ],
    "type":"object",
    "description":"A WorkItem represents a unit of work in the context of a Job. A Job may contain one or multiple work items."
}

Nested Schema : configObjs

Type: array

Nested Schema : Job

Type: object

A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects.

Show Source

• abortedUser: string
  Maximum Length: 256
• associatedObjId: string
  Maximum Length: 128
• associatedObjType: string
  Maximum Length: 256
• endTime: timestamp
  Read-only and this operation is unsupported. @param endTime Time in milliseconds.
• jobName(required): string
  Maximum Length: 256
• progressMessage: string
  Maximum Length: 1024

  Read-only and this operation is unsupported. @param progressMessage.
• result: AssociatedObj
• runState: string
  Allowed Values: [ "ACTIVE", "SUCCEEDED", "FAILED", "ABORTED" ]
• startTime: timestamp
  Read-only and this operation is unsupported. @param startTime The startTime to set.
• transcript: string
  Maximum Length: 1000
• username: string
  Maximum Length: 64
• workItemIds: array workItemIds
• workRequestId: string
  Maximum Length: 256

{
    "properties":{
        "result":{
            "description":"",
            "type":"AssociatedObj"
        },
        "associatedObjType":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "associatedObjId":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "workRequestId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "abortedUser":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "endTime":{
            "description":"Read-only and this operation is unsupported. @param endTime Time in milliseconds.",
            "type":"timestamp"
        },
        "jobName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "progressMessage":{
            "description":"Read-only and this operation is unsupported. @param progressMessage.",
            "maxLength":1024,
            "type":"string"
        },
        "runState":{
            "description":"",
            "enum":[
                "ACTIVE",
                "SUCCEEDED",
                "FAILED",
                "ABORTED"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"Read-only and this operation is unsupported. @param startTime The startTime to set.",
            "type":"timestamp"
        },
        "transcript":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "username":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "workItemIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "jobName"
    ],
    "type":"object",
    "description":"A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects."
}

Nested Schema : workQueueEntryIds

Type: array

Nested Schema : workItemIds

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