Jump to

• Request
• Response

Read a workflow task

get

/content/management/api/v1.1/workflowTasks/{taskId}

Request

Path Parameters

• taskId: string
  id of the workflow task.

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : WorkflowTask

Type: object

WorkflowTask

Show Source

• actions(optional): array actions
  Actions on the workflow task.
• assignedTo(optional): array assignedTo
  Assigned to user/group
• dueDate(optional): object date
  date
• id(optional): string
  id of the workflow task.
• initiatedBy(optional): string
  Initiated by user
• item(optional): object WorkflowTaskItem
  WorkflowTaskItem
• links(optional): array links
  Links
• name(optional): string
  name of the workflow task.
• source(optional): string
  source of the workflow.
• workflow(optional): object WorkflowId
  WorkflowId

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the workflow task."
        },
        "name":{
            "type":"string",
            "description":"name of the workflow task."
        },
        "source":{
            "type":"string",
            "description":"source of the workflow."
        },
        "assignedTo":{
            "type":"array",
            "description":"Assigned to user/group",
            "items":{
                "$ref":"#/definitions/WorkflowTaskAssignedToBean"
            }
        },
        "dueDate":{
            "description":"Due date and time",
            "$ref":"#/definitions/date"
        },
        "initiatedBy":{
            "type":"string",
            "description":"Initiated by user"
        },
        "item":{
            "description":"Item information.",
            "$ref":"#/definitions/WorkflowTaskItem"
        },
        "workflow":{
            "description":"Workflow information.",
            "$ref":"#/definitions/WorkflowId"
        },
        "actions":{
            "type":"array",
            "description":"Actions on the workflow task.",
            "items":{
                "$ref":"#/definitions/WorkflowTaskActions"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowTask"
}

Nested Schema : actions

Type: array

Actions on the workflow task.

Show Source

• Array of: object WorkflowTaskActions
  WorkflowTaskActions

{
    "type":"array",
    "description":"Actions on the workflow task.",
    "items":{
        "$ref":"#/definitions/WorkflowTaskActions"
    }
}

Nested Schema : assignedTo

Type: array

Assigned to user/group

Show Source

• Array of: object WorkflowTaskAssignedToBean

{
    "type":"array",
    "description":"Assigned to user/group",
    "items":{
        "$ref":"#/definitions/WorkflowTaskAssignedToBean"
    }
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : WorkflowTaskItem

Type: object

WorkflowTaskItem

Show Source

• advancedVideoInfo(optional): object advancedVideoInfo
  Whether the item is video-plus.
• fileGroup(optional): string
  Name of the fileGroup of item.
• id(optional): string
  id of the item.
• isMaster(optional): boolean
  Whether the item is master.
• language(optional): string
  Language of the item.
• links(optional): array links
  Links
• name(optional): string
  Name of the item.
• repositoryId(optional): string
  Repository of the item.
• type(optional): string
  Name of the type.
• typeCategory(optional): string
  Name of the typeCategory of item.
• version(optional): string
  The current version of the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"Name of the item."
        },
        "type":{
            "type":"string",
            "description":"Name of the type."
        },
        "typeCategory":{
            "type":"string",
            "description":"Name of the typeCategory of item."
        },
        "fileGroup":{
            "type":"string",
            "description":"Name of the fileGroup of item."
        },
        "repositoryId":{
            "type":"string",
            "description":"Repository of the item."
        },
        "version":{
            "type":"string",
            "description":"The current version of the item."
        },
        "language":{
            "type":"string",
            "description":"Language of the item."
        },
        "isMaster":{
            "type":"boolean",
            "description":"Whether the item is master."
        },
        "advancedVideoInfo":{
            "type":"object",
            "description":"Whether the item is video-plus."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowTaskItem"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : WorkflowId

Type: object

WorkflowId

Show Source

• id(optional): string
  id of the Workflow.
• isEnabled(optional): boolean
  If workflow is enabled or disabled in OCE.This is a read only field.
• name(optional): string
  Name of the Workflow.This is a read only field.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        },
        "name":{
            "type":"string",
            "description":"Name of the Workflow.This is a read only field."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"If workflow is enabled or disabled in OCE.This is a read only field."
        }
    },
    "description":"WorkflowId"
}

Nested Schema : WorkflowTaskActions

Type: object

WorkflowTaskActions

Show Source

• name(optional): string
  name of the action.
• type(optional): string
  type of action.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the action."
        },
        "type":{
            "type":"string",
            "description":"type of action."
        }
    },
    "description":"WorkflowTaskActions"
}

Nested Schema : WorkflowTaskAssignedToBean

Type: object

Show Source

• id(optional): string
  id of the assignee.
• type(optional): string
  Type of the assignee - user/role.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the assignee."
        },
        "type":{
            "type":"string",
            "description":"Type of the assignee - user/role."
        }
    }
}

Nested Schema : advancedVideoInfo

Type: object

Whether the item is video-plus.

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top