Update a Workflow
put
/content/management/api/v1.1/workflows/{id}
Updates a workflow with the given payload.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
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
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Updates a workflow with the given information in the payload. The fields createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.
Root Schema : Workflow
Type:
object
Workflow
Show Source
-
applicationName(optional):
string
Application Name of the Workflow.
-
createdBy(optional):
string
createdBy user of the Repository.
-
createdDate(optional):
object date
date
-
description(optional):
string
Description of the Workflow.
-
externalId(optional):
string
External id coming from source. It is a required property in post request.
-
id(optional):
string
id of the Workflow.
-
isEnabled(optional):
boolean
If workflow is enabled or disabled in OCE.
-
links(optional):
array links
Links
-
name(optional):
string
Name of the Workflow.
-
properties(optional):
object properties
Additional Properties Allowed: additionalPropertiesProperties of a workflow.
-
repositories(optional):
array repositories
Assigned repositories of a workflow.
-
revision(optional):
string
Revision of the Workflow.
-
roleName(optional):
string
Name of the user's role on the workflow.
-
roles(optional):
array roles
Roles of a workflow.
-
source(optional):
string
Source of the workflow. It is a required property in post Request.
-
updatedBy(optional):
string
updatedBy user of the Repository.
-
updatedDate(optional):
object date
date
Nested Schema : properties
Type:
object
Additional Properties Allowed
Show Source
Properties of a workflow.
Nested Schema : repositories
Type:
array
Assigned repositories of a workflow.
Show Source
-
Array of:
object RepositoryId
RepositoryId
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.
Nested Schema : additionalProperties
Type:
object
Nested Schema : RepositoryId
Type:
object
RepositoryId
Show Source
-
id(optional):
string
-
name(optional):
string
Name of the repository. It is a required property in the get response and post/put request.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Workflow
Type:
object
Workflow
Show Source
-
applicationName(optional):
string
Application Name of the Workflow.
-
createdBy(optional):
string
createdBy user of the Repository.
-
createdDate(optional):
object date
date
-
description(optional):
string
Description of the Workflow.
-
externalId(optional):
string
External id coming from source. It is a required property in post request.
-
id(optional):
string
id of the Workflow.
-
isEnabled(optional):
boolean
If workflow is enabled or disabled in OCE.
-
links(optional):
array links
Links
-
name(optional):
string
Name of the Workflow.
-
properties(optional):
object properties
Additional Properties Allowed: additionalPropertiesProperties of a workflow.
-
repositories(optional):
array repositories
Assigned repositories of a workflow.
-
revision(optional):
string
Revision of the Workflow.
-
roleName(optional):
string
Name of the user's role on the workflow.
-
roles(optional):
array roles
Roles of a workflow.
-
source(optional):
string
Source of the workflow. It is a required property in post Request.
-
updatedBy(optional):
string
updatedBy user of the Repository.
-
updatedDate(optional):
object date
date
Nested Schema : properties
Type:
object
Additional Properties Allowed
Show Source
Properties of a workflow.
Nested Schema : repositories
Type:
array
Assigned repositories of a workflow.
Show Source
-
Array of:
object RepositoryId
RepositoryId
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.
Nested Schema : additionalProperties
Type:
object
Nested Schema : RepositoryId
Type:
object
RepositoryId
Show Source
-
id(optional):
string
-
name(optional):
string
Name of the repository. It is a required property in the get response and post/put request.
400 Response
Bad request.
404 Response
Not found.
500 Response
Internal server error.