Jump to

• Request
• Response

Get the item workflow instance details.

get

/content/management/api/v1.1/items/{id}/workflows/{instanceId}

Get the workflow details of an item for the specified instance

Request

Path Parameters

• id: string
  id of the item.
• instanceId: string
  Instance id of the workflow.

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

Type: object

ItemWorkflowStatus

Show Source

• activities(optional): array activities
  Activities within the workflow process.
• id(optional): string
  id of the workflow.
• instanceId: string
  Workflow instance id.
• isPurged(optional): boolean
  If workflow instance is purged or not in OIC.This is a read only field.
• item(optional): object WorkflowStatusItemBean
  WorkflowStatusItemBean
• links(optional): array links
  Links
• name(optional): string
  name of the workflow.
• status(optional): string
  status of the workflow.
• submittedBy(optional): string
  Submitted by user
• submittedDate(optional): object date
  date

{
    "type":"object",
    "required":[
        "instanceId"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the workflow."
        },
        "instanceId":{
            "type":"string",
            "description":"Workflow instance id."
        },
        "name":{
            "type":"string",
            "description":"name of the workflow."
        },
        "status":{
            "type":"string",
            "description":"status of the workflow."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        },
        "isPurged":{
            "type":"boolean",
            "description":"If workflow instance is purged or not in OIC.This is a read only field."
        },
        "activities":{
            "type":"array",
            "description":"Activities within the workflow process.",
            "items":{
                "$ref":"#/definitions/ProcessActivitiesBean"
            }
        },
        "item":{
            "description":"Item information.",
            "$ref":"#/definitions/WorkflowStatusItemBean"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemWorkflowStatus"
}

Nested Schema : activities

Type: array

Activities within the workflow process.

Show Source

• Array of: object ProcessActivitiesBean

{
    "type":"array",
    "description":"Activities within the workflow process.",
    "items":{
        "$ref":"#/definitions/ProcessActivitiesBean"
    }
}

Nested Schema : WorkflowStatusItemBean

Type: object

WorkflowStatusItemBean

Show Source

• id(optional): string
  id of the item.
• isDependent(optional): boolean
  If item is dependent or not.
• lastUpdatedVersion(optional): string
  Item updated version
• parents(optional): array parents
  Parent Item details
• submittedWithDependencies(optional): boolean
  If item is submitted to workflow with dependencies.
• version(optional): string
  Item version

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "submittedWithDependencies":{
            "type":"boolean",
            "description":"If item is submitted to workflow with dependencies."
        },
        "isDependent":{
            "type":"boolean",
            "description":"If item is dependent or not."
        },
        "version":{
            "type":"string",
            "description":"Item version"
        },
        "lastUpdatedVersion":{
            "type":"string",
            "description":"Item updated version"
        },
        "parents":{
            "type":"array",
            "description":"Parent Item details",
            "items":{
                "$ref":"#/definitions/ParentItemBean"
            }
        }
    },
    "description":"WorkflowStatusItemBean"
}

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

Type: object

Show Source

• details(optional): object details
  Additional Properties Allowed: additionalProperties

  Activity details
• id(optional): string
  Id of the activity
• itemVersion(optional): string
  Item Version
• links(optional): array links
  Links
• name(optional): string
  Name of the activity
• outcome(optional): string
  Outcome of the activity
• sourceActivity(optional): string
  Previous activity Id in the workflow
• targetActivity(optional): string
  Current activity Id in the workflow
• type(optional): string
  Type of the activity
• updatedDate: string(date-time)
  Date on which the activity has been updated.

{
    "type":"object",
    "required":[
        "updatedDate"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the activity"
        },
        "type":{
            "type":"string",
            "description":"Type of the activity"
        },
        "name":{
            "type":"string",
            "description":"Name of the activity"
        },
        "sourceActivity":{
            "type":"string",
            "description":"Previous activity Id in the workflow"
        },
        "targetActivity":{
            "type":"string",
            "description":"Current activity Id in the workflow"
        },
        "outcome":{
            "type":"string",
            "description":"Outcome of the activity"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date on which the activity has been updated."
        },
        "details":{
            "type":"object",
            "description":"Activity details",
            "additionalProperties":{
                "type":"object"
            }
        },
        "itemVersion":{
            "type":"string",
            "description":"Item Version"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : details

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Activity details",
    "additionalProperties":{
        "type":"object"
    }
}

Activity details

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

Type: object

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

Nested Schema : parents

Type: array

Parent Item details

Show Source

• Array of: object ParentItemBean

{
    "type":"array",
    "description":"Parent Item details",
    "items":{
        "$ref":"#/definitions/ParentItemBean"
    }
}

Nested Schema : ParentItemBean

Type: object

Show Source

• id(optional): string
  Parent id with which the asset is submitted to workflow.
• name(optional): string
  Parent name with which the asset is submitted to workflow.
• submittedBy(optional): string
  Submitted by user
• submittedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Parent id with which the asset is submitted to workflow."
        },
        "name":{
            "type":"string",
            "description":"Parent name with which the asset is submitted to workflow."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        }
    }
}

304 Response

Not modified.

400 Response

Bad request.

404 Response

Not found.

500 Response

Internal server error.

Back to Top