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.
By default, create a TargetBoard with default columns: IDENTIFIED TARGET, PRIORITIZED TARGET, IN COORDINATION, IN EXECUTION, COMPLETE.
Returns the RID of the created TargetBoard.
The security.spaceRid field defaults to your user's space if there is only one. Use the List Spaces endpoint at /api/v2/filesystem/spaces to get the spaces your user has access to.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:target-write.
objectobjectSecurity settings for the board
stringobjectConfiguration for a target board
stringstringobjectThe created TargetBoard
stringThe unique identifier for a Target Board
stringstringstringobjectConfiguration for a target board
objectSecurity settings for the board
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/targetWorkbench/targetBoards?preview=true" \
-d '{"security":{"portionMarkings":["SENSITIVE"],"spaceRid":"ri.compass.main.folder.12345"},"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."}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"security": {
"portionMarkings": [
"SENSITIVE"
],
"spaceRid": "ri.compass.main.folder.12345"
},
"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.",
"rid": "ri.gotham-artifact.0-0.target-board.example"
}| Error Name | ||
|---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The specified portion markings are not valid. | |
| Parameters | portionMarkings | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The space rid is missing or invalid. | |
| Parameters | spaceRid | |
Multitenant | Error Code | INTERNAL |
| Status Code | 500 | |
| Description | Multitenant mode is currently unknown. | |
| Parameters | | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the TargetBoard. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.