Skip to main content

Get list of variables cages

GET 
/data_dictionary/variables_cages

The list of the variable cages

Request​

Query Parameters

    term string

    The term to the search

    include string

    The attributes that will be returned together with the data dictionary variable cage

    Example: author,client,values
    filter object

    The variable cages can be filtered

    sort_by object

    The variable cages can be sorted

Header Parameters

    X-Domain stringrequired

    Every request should has X-Domain Header, in the UUIDv4 format. The X-Domain can be get from the Tenant Integrations page

    X-API-KEY stringrequired

    An X-API-KEY key is a token that a client provides with a X-API-SECRET when making API calls, used instead of the JWT

    X-API-SECRET stringrequired

    An X-API-SECRET key is a token that a client provides with a X-API-KEY when making API calls, used instead of the JWT

Responses​

The request was successful

Schema

    data

    object[]

  • Array [

    • type string
    id string

    The id of the data dictionary variable cage

    attributes

    object

    name string

    The name of the data dictionary variable cage

    type DataDictionary.Variable.Type (string)

    Possible values: [system, custom]

    The type of the data dictionary variable: system - created of the system and can't be changed; custom - can be created by a user

    category DataDictionary.Variable.Category (string)

    Possible values: [text, date, file]

    The categories of the data dictionary variables, a separate category for a separate type of the content

    relationships

    object

    values

    object

    data

    object[]

  • Array [

    • type string
    id string

    The id of the value for a data dictionary variable cage

    attributes

    object

    id string

    The id of the value for a data dictionary variable cage

    name string

    The name of the variable

    value string

    The value of the variable can be as a string or as a link to the file

    value_reference string

    The reference of the value

    weight integer

    The weight used to sort the values in the cage

  • ]

    • client

    object

    data

    object

    type string

    The type of the client

    id string

    The client id in the UUIDv4 format

    attributes

    object

    name string

    The client name

    is_simulation boolean

    The mode when the tenant can be as a client

    has_members boolean

    Indicate if the client has a members

    created_at string

    The date and time when the client was created

    updated_at string

    The date and time when the client was last time changed

    archive_at string

    The date and time when the client was archived

    remove_at string

    The date and time when the client will be fully removed from a system

    author

    object

    data

    object

    type string

    Author it is a user who create entity

    id string

    The id of the user who create entity

    attributes

    object

    type string

    The type of the author of the discussion instance

    scope string

    The scope of the author of the discussion instance

    email string

    The email of the author of the discussion instance

    archived_at string

    The date and time when the author of the discussion instance was archived

    relationships

    object

    profile

    object

    data

    object

    type string
    id string

    The id of the profile registered user

    attributes

    object

    first_name string

    The user first name

    last_name string

    The user last name

    avatar string

    The user avatar in the JPG, PNG, and max size of 5Mb

    phone_code string

    The international phone code

    phone_number string

    The phone number of the user

    position string

    This field is a string and can be used as a position of the user in the company or some other information

    created_at string

    The date and time of the user creation

    updated_at string

    The date and time when the info in the user profile was changed

  • ]

Loading...