There are several service lines that work on the same principle. The end points are slightly different but the parameters are the same and depending on the configuration, the possibilities are the same. All details are available in section DAM & DATA API. This page describes the general principle to modify a workflow state or get the list of workflow actions.
Change the workflow state of a resource
verb:
POST
general form of the URI:
/api/rest/{type of service}/{name of the resource type}/workflow/{id of resource}
Parameters are:
workflowAction
(oraction
): the name (not localized) or the identifier of the action to applyif the resource is configured in status change mode by identifier (supporting the old workflow management mode), the parameter is called
statusId
workflow
: this parameter is a common alias forworkflowAction
andstatusId
See response sample.
Change the workflow state of several resources
You can apply the same action to several resources by specifying a list of identifiers (comma-separated) instead of a single one. You can also use the query parameter to select the resources on which the action will be applied.
See response sample.
Know the possible actions to change the state of a resource
verb:
GET
general form of the URI:
/api/rest/{type of service}/{name of the resource type}/workflow/{id of resource}
See a response sample
Know the different possible actions to change the state of a resource type
verb:
POST
general form of the URI:
/api/rest/{type of service}/{name of the resource type}/workflow
See response sample