Load Target Board by RID.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:target-read.
objectSuccess response with the requested Target Board.
objectstringThe 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
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/targetWorkbench/targetBoards/ri.gotham-artifact.0-0.target-board.example/load"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"targetBoard": {
"targetColumnIds": {
"bi.2a46fbf6-ff93-4710-951a-015ed5c92441*ri.gotham-artifact.0-0.target.1": {
"columnId": "EXECUTION"
},
"bi.8a66fbf3-ff93-4710-951a-015ee5c92441*ri.gotham-artifact.0-0.target.2": {
"columnId": "EXECUTION"
}
},
"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",
"targets": [
"bi.2a46fbf6-ff93-4710-951a-015ed5c92441*ri.gotham-artifact.0-0.target.1",
"bi.8a66fbf3-ff93-4710-951a-015ee5c92441*ri.gotham-artifact.0-0.target.2"
]
},
"baseRevisionId": 1
}| Error Name | ||
|---|---|---|
Target | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Cannot find target board from provided rid. | |
| Parameters | targetBoardRid | |
Load | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not load the TargetBoard. | |
| Parameters | targetBoardRid | |
See Errors for a general overview of errors in the platform.