Get catalogue item fields

GET

https://{tenant}.atomicwork.com/api/v1/catalogue-items/:item_id/fields

GET

/api/v1/catalogue-items/:item_id/fields

$ curl -G https://{tenant}.atomicwork.com/api/v1/catalogue-items/1/fields \
>      -H "X-Workspace-Id: 987654321" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d show_editable_only=false \
>      -d search_key=priority

200Retrieved

1 {
2   "fields": [
3     {
4       "id": 101,
5       "name": "Priority",
6       "type": "dropdown",
7       "editable": true,
8       "required": true,
9       "options": [
10         "Low",
11         "Medium",
12         "High",
13         "Critical"
14       ],
15       "default_value": "Medium",
16       "description": "Select the priority level for this catalogue item"
17     },
18     {
19       "id": 102,
20       "name": "Description",
21       "type": "text",
22       "editable": true,
23       "required": false,
24       "default_value": "",
25       "description": "Detailed description of the catalogue item"
26     },
27     {
28       "id": 103,
29       "name": "Due Date",
30       "type": "date",
31       "editable": true,
32       "required": false,
33       "default_value": null,
34       "description": "Expected completion date for the request"
35     }
36   ]
37 }

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

item_idlongRequired

The Catalogue item id

Query parameters

show_editable_onlybooleanOptionalDefaults to false

Show only editable fields for field management

search_keystringOptional

Search key for field name

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response