Get a List of Relational List Values

Retrieve a paginated list of the options of a relational list field of service records. A relational list is a custom field whose options come from another entity of your SysAid account instead of a list of its own, such as users, companies, configuration items, assets, groups or software products. Each item holds the ID of the entity an option stands for, such as the ID of a user, which is the value the field stores, and its caption, the display name of that entity. The options follow the filter set on the field in SysAid. Only the custom fields of service records are found, and an ID that is not a relational list of service records, such as the ID of a field of another type or of a field that does not exist, answers 404. The options are returned in the order SysAid keeps them in, sorted by caption without regard to case. SysAid reads at most the first 500 options of a field and does not page them, so "limit" and "offset" are applied by the API to those, and "total" is the number of options read, never more than 500, even when the field has more options.

Path Params
string
required
^(CustomColumn[0-9]{1,10}sr|[0-9]{1,10})$

The relational list field of service records, by the attribute name of its custom field, CustomColumn{N}sr, such as "CustomColumn4sr", or by its number N alone, such as "4". N is the number SysAid gave the custom column when it was created; the field name that GET /custom-fields returns, such as "sr_cust_users", is not accepted here. Both forms name the same field, and the leading zeros of N alone are dropped, so "04" is "CustomColumn4sr" while "CustomColumn04sr" names no field and answers 404. The ID is matched exactly, including case, and any other ID is rejected with 400.

Query Params
integer
≥ 0
Defaults to 0

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

integer
1 to 500
Defaults to 100

The number of items to display per page. The default is 100, and you can have up to 500.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json