Modify a Target Board by RID.
Sets the current state of a Collection. Any fields, except hptl, not supplied will result in
removal if there was a value present. Trying to set hptl to empty when there's already a value will
result in an INVALID_ARGUMENT exception. You cannot modify the hptl field if a value is already set.
Fields that are not supported by the OpenAPI layer will remain unmodified.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:target-write.
objectstringstringstringobjectConfiguration for a target board
stringThe current version of the Target Board to be modified. The archive operation will be transformed against any concurrent operations made since this version. If there are any conflicting edits that result in changes to these operations when they're applied, that will be noted in the response.
1
2
3
4
5
curl -X PUT \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/targetWorkbench/targetBoards/ri.gotham-artifact.0-0.target-board.example/modify" \
-d '{"highPriorityTargetList":"ri.gotham-artifact.0-0.hptl.example","configuration":{"columns":[{"id":"EXECUTION","name":"IN PROGRESS","color":"RED"}],"targetIdentifiers":["CUSTOM"]},"name":"Example target board name.","description":"Example target board description.","baseRevisionId":1}'| Error Name | ||
|---|---|---|
Cannot | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Cannot update a target board's columns if targets are present in the column. | |
| Parameters | targetBoardRid | |
Revision | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The provided revision id is behind the current id. | |
| Parameters | id, revisionId | |
Modify | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not modify the TargetBoard. | |
| Parameters | targetBoardRid | |
See Errors for a general overview of errors in the platform.