Get info about variable cage

GET 
/data_dictionary/variables_cages/:id

The full information about the variable cage

Request

Path Parameters

id stringrequired
The id of the variable cage
Example: 056dba62-0168-4d67-8131-a685f2d365ed

Query Parameters

include string
The attributes that will be returned together with the data dictionary variable cage
Example: author,client,values

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

200

The request was successful

application/vnd.api+json

Schema

Schema

data

object

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

Example (from schema)

{
  "data": {
    "type": "data_dictionary_variables_cages",
    "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
    "attributes": {
      "name": "Simple variable",
      "type": "system",
      "category": "text"
    },
    "relationships": {
      "values": {
        "data": [
          {
            "type": "data_dictionary_variables_cages_values",
            "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
            "attributes": {
              "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
              "name": "Simple variable",
              "value": "Simple variable value",
              "value_reference": "7318a31a-0bcf-48d1-9350-a6ae499007c0",
              "weight": 0
            }
          }
        ]
      },
      "client": {
        "data": {
          "type": "clients",
          "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
          "attributes": {
            "name": "Simple client",
            "is_simulation": true,
            "has_members": true,
            "created_at": "2016-01-01 12:00:00",
            "updated_at": "2016-01-01 12:00:00",
            "archive_at": "2016-01-01 12:00:00",
            "remove_at": "2016-01-01 12:00:00"
          }
        }
      },
      "author": {
        "data": {
          "type": "authors",
          "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
          "attributes": {
            "type": "users",
            "scope": "string",
            "email": "example@example.com",
            "archived_at": "2016-01-01 12:00:00"
          },
          "relationships": {
            "profile": {
              "data": {
                "type": "users_profile",
                "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
                "attributes": {
                  "first_name": "John",
                  "last_name": "Doe",
                  "avatar": "string",
                  "phone_code": "1",
                  "phone_number": "(111) 111-11-11",
                  "position": "string",
                  "created_at": "2016-01-01 12:00:00",
                  "updated_at": "2016-01-01 12:00:00"
                }
              }
            }
          }
        }
      }
    }
  }
}

401

Unauthorized exception

application/vnd.api+json

Schema

Schema

status integer

The response status code of the error

code integer
title string

The title of the error

Example (from schema)

{
  "status": 401,
  "code": 0,
  "title": "Unauthorized"
}

500

That means something has gone wrong on the server, and the server returns more specific about what the exact problem is

application/vnd.api+json

Schema

Schema

id object
type string

The type of the error

links string[]
status integer

The status of the error

code integer
title string

The title of the error

detail string
source object

The request body

meta object

The internal trace

Example (from schema)

{
  "id": {},
  "type": "errors",
  "links": [
    "string"
  ],
  "status": 0,
  "code": 0,
  "title": "string",
  "detail": "string",
  "source": {},
  "meta": {}
}

Loading...