Submit an Item to Workflow
post
/content/management/api/v1.1/items/{id}/submitToWorkflow
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
id of the item.
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
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
id of the workflow.
Root Schema : ItemWorkflowSubmitBean
Type:
object
ItemWorkflowSubmitBean
Show Source
-
id(optional):
string
id of the Workflow.
-
options(optional):
object WorkflowSubmitOptions
Nested Schema : WorkflowSubmitOptions
Type:
Show Source
object
-
includeDependencies(optional):
boolean
Item dependencies to be included or not
Response
Supported Media Types
- application/json
201 Response
Created.
Root Schema : WorkflowItemDetails
Type:
object
WorkflowItemDetails.
Show Source
-
id(optional):
string
Workflow id.
-
instanceId:
string
Workflow instance id.
-
isCompleted(optional):
boolean
If workflow instance is completed or not in OIC.
-
items(optional):
array items
Items Details.
-
links(optional):
array links
Links
-
name(optional):
string
Workflow name.
-
status(optional):
string
Workflow status.
-
submittedBy(optional):
string
Submitted by user
-
submittedDate(optional):
object date
date
Nested Schema : ItemId
Type:
Show Source
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
Nested Schema : links
Type:
array
links of the item resource
Show Source
-
Array of:
object Link
Link of the resource.
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.
400 Response
Bad request.
404 Response
Not found.
500 Response
Internal server error.