Skip to main content

List valuesets

GET 
/v1/valuesets

List valuesets

Request​

Query Parameters

    page any

    Pagination page number

    offset any

    Pagination offset number

    createdAtGreaterThan date-time

    Search by date created greater than

    Example: 2314-03-14T03:14:15.926Z
    createdAtLessThan date-time

    Search by date created less than

    Example: 2314-03-14T03:14:15.926Z
    lastModifiedAtGreaterThan date-time

    Search by date updated greater than

    Example: 2314-03-14T03:14:15.926Z
    lastModifiedAtLessThan date-time

    Search by date updated less than

    Example: 2314-03-14T03:14:15.926Z
    ids number[]

    List of Valueset primary identifiers

    type string

    Possible values: [SYSTEM, CUSTOM]

    Valueset type. One of: [SYSTEM, CUSTOM]

    names string[]

    List of names

    sortField string

    Possible values: [id, name, lastModifiedAt, createdAt]

    Default value: id

    Field to sort by

    sortOrder string

    Possible values: [ASC, DESC]

    Default value: ASC

    Order option to sort by

Responses​

Paginated list of valuesets

Schema

    items

    object[]

    required

    List of items of type Valueset

  • Array [

    • id integerrequired

    Valueset primary identifier

    name stringrequired

    Possible values: <= 64 characters

    Valueset name

    type stringrequired

    Possible values: [SYSTEM, CUSTOM]

    Valueset type

    descriptions

    object[]

    required

    Valueset descriptions

  • Array [

    • language stringrequired

    Possible values: >= 2 characters and <= 2 characters

    Language is set as 2 character country code.

    value string

    Localized field value

  • ]

    • lastModifiedBy integer

    The userId of the user that changed the valueset

    lastModifiedAt date-timerequired

    Valueset last modified date

    createdBy integer

    The userId of the user that created the valueset

    createdAt date-timerequired

    Valueset creation date

  • ]

    • itemsFound integerrequired

    Total number of items found

    offset integernullablerequired

    Possible values: >= 1

    Default value: 12

    The amount of items to show per page

    page integernullablerequired

    Possible values: >= 1

    Default value: 1

    The current page

    pages integernullablerequired

    Possible values: >= 1

    Total amount of pages

    start integernullablerequired

    Possible values: >= 1

    Start position of the current page

    end integernullablerequired

    Possible values: >= 1

    End position of the current page

Loading...