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.
Load Target Board by RID.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectSuccess response with the requested Target Board.
objectstringThe current version of the Collection retrieved. Any modifying operations should be accompanied by this version to avoid 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 \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/twb/targetBoard/ri.gotham-artifact.0-0.target-collection.example?preview=true"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
{
"rid": "ri.gotham-artifact.0-0.target-collection.example",
"name": "Example target board name.",
"description": "Example description.",
"highPriorityTargetList": "ri.gotham-artifact.0-0.hptl.example",
"configuration": {
"columns": [
{
"id": "EXECUTION",
"name": "DONE",
"color": "RED"
}
],
"targetIdentifiers": [
"CUSTOM"
]
},
"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"
}
}
}