Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can see if the resource is currently locked and by whom. It is also possible to have this information through the resource access services (by ID or in list), with the parameter showLock (default to false).

Workflows

...

To 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 (or action): the name (not localized) or the identifier of the action to apply

  • if 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 for workflowAction and statusId

See the description of the response.

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 the description of the response.

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 the description of the response.

Know the different possible actions to change the state of a resource type

...

verb: POST

...

, a state change action must be applied (it is possible for the old workflow system to change the state directly, like any property linked to another resource (here the associated workflow resource), but the resource must be configured to allow it).

See detail at page Workflows (change status, or get possible workflow actions)

Mass import