This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Moves Foundry Objects from their current state to a different state on a Workbench Board. This operation preserves the objects' board item identifiers and edit history, allowing users to track the objects' progression through workflow states.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:workbench-write.
objectlist<FoundryObjectRid>The RIDs of the Foundry Objects to move
stringThe destination state (column) to move the objects to
1
2
3
4
5
curl -X PUT \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/workbench/boards/ri.gotham-artifact.0-0.workbench-board.example/objects/move?preview=true" \
-d '{"objectRids":["ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"],"stateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}'| Error Name | ||
|---|---|---|
Object | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | One or more objects are not on the specified board and cannot be moved. | |
| Parameters | | |
Board | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The specified state does not exist on the board. | |
| Parameters | stateId | |
Board | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The requested operation cannot be performed on this board. | |
| Parameters | | |
Move | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not move the BoardObject. | |
| Parameters | boardRid | |
See Errors for a general overview of errors in the platform.