Version 2.0

Add Board Objects

PUT/api/v2/workbench/boards/{boardRid}/objects/add

Warning

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.

Adds Foundry Objects to a Workbench Board. This operation links the objects to the board, allowing them to be tracked within the board's workflow. If no state is specified, the objects will be placed in the board's default state (first column).

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:workbench-write.

Path parameters

boardRid

string

The unique identifier for a Workbench Board

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

AddBoardObjectsRequest

object

Hide child attributes

objectRids

list<FoundryObjectRid>

optional

The RIDs of the Foundry Objects to add to the board

Show child attributes

stateId

string

optional

Optional state (column) to place the objects in. If not specified, the objects will be placed in the board's default state (the first state in the board's configured order).

Response body

EmptySuccessResponse

any

An empty response object indicating the request was successful

Examples

Request

Copied!

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/add?preview=true" \
	-d '{"objectRids":["ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"],"stateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

Error responses

Error Name
`ObjectAlreadyOnBoard`	Error Code	`CONFLICT`
	Status Code	409
	Description	One or more objects are already on the specified board and cannot be added again.
	Parameters	`objectRids`
`BoardStateNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The specified state does not exist on the board.
	Parameters	`stateId`
`BoardHasNoDefaultState`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The board has no default state configured and no state was specified in the request.
	Parameters
`ObjectNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	One or more Foundry Objects could not be found or accessed.
	Parameters	`objectRids`
`ObjectTypeNotSupported`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	One or more objects do not implement the interface type or object type required by the board.
	Parameters	`objectRids`
`BoardInterfaceTypeNotSet`	Error Code	`FAILED_PRECONDITION`
	Status Code	500
	Description	The board requires an interface type to be configured before objects can be added.
	Parameters
`ObjectSecurityNotSatisfied`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	One or more objects do not satisfy the security requirements of the board.
	Parameters	`objectRids`
`BoardExceededItemLimit`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	Adding the requested objects would exceed the maximum number of items allowed on the board.
	Parameters	`currentItems, maxItems`
`BoardOperationNotSupported`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The requested operation cannot be performed on this board.
	Parameters
`AddBoardObjectsPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not add the BoardObject.
	Parameters	`boardRid`

See Errors for a general overview of errors in the platform.