Get list of variables
GET/data_dictionary/variables
The list of the all variables
Request
Query Parameters
The term to the search
The attributes that will be returned together with the data dictionary variable
The list of the variables can be filtered
The list of the variables can be sorted
Header Parameters
Every request should has X-Domain Header, in the UUIDv4 format. The X-Domain can be get from the Tenant Integrations page
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
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
- 401
- 500
The request was successful
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
The id of the data dictionary variable
attributes
object
The id of the user who create dictionary variable
The type of the user who create dictionary variable
The name of the data dictionary variable
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
Possible values: [text
, date
, file
]
The categories of the data dictionary variables, a separate category for a separate type of the content
The date and time when the data dictionary variable was created
The date and time when the data dictionary variable was last time updated
relationships
object
author
object
data
object
Author it is a user who create entity
The id of the user who create entity
attributes
object
The type of the author of the discussion instance
The scope of the author of the discussion instance
The email of the author of the discussion instance
The date and time when the author of the discussion instance was archived
relationships
object
profile
object
data
object
The id of the profile registered user
attributes
object
The user first name
The user last name
The user avatar in the JPG, PNG, and max size of 5Mb
The international phone code
The phone number of the user
This field is a string and can be used as a position of the user in the company or some other information
The date and time of the user creation
The date and time when the info in the user profile was changed
{
"data": [
{
"type": "data_dictionary_variables",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"author_id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"author_type": "users",
"name": "Simple variable",
"type": "system",
"category": "text",
"created_at": "2016-01-01 12:00:00",
"updated_at": "2016-01-01 12:00:00"
},
"relationships": {
"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"
}
}
}
}
}
}
}
}
]
}
Unauthorized exception
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
The response status code of the error
The title of the error
{
"status": 401,
"code": 0,
"title": "Unauthorized"
}
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
- Example (from schema)
Schema
The type of the error
The status of the error
The title of the error
The request body
The internal trace
{
"id": {},
"type": "errors",
"links": [
"string"
],
"status": 0,
"code": 0,
"title": "string",
"detail": "string",
"source": {},
"meta": {}
}