Get Pick List

Gets the specified pick list, its values, and the fields that are associated with it.

Resource Information

Scopesettings

Deprecated scope name:   get_settings_pick_list

App TypeAll
Authorization TypeAccess token
URI /v4/settings/pickLists/{id}
HTTP MethodGET
Automation Version(s)7.3.3

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNo Indicates the language applied.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3
result.descriptionstringThe description of the record or item.7.3.3
result.statusresult.status{}The pick list status.7.3.3
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.values[]result.values{}The values in a pick list.7.3.3
result.values.descriptionresult.values.description{}The description of the record or item.7.3.3
result.values.description.textstringThe localized display text.7.3.2
result.values.description.valuestringThe value for the specified parameter.7.3.2
result.values.displayOrderlongThe order of the item in comparison to the other items.7.3.3
result.values.statusresult.values.status{}The pick list value status.7.3.3
result.values.status.textstringThe localized display text.7.3.2
result.values.status.valuestringThe value for the specified parameter.7.3.2
result.values.textstringThe localized display text.7.3.3
result.values.valuestringThe value for the specified parameter.7.3.3
statusintegerThe record status.7.3.3