logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

E-mail: admin@finmars.com License: BSD License Terms of Service

Finmars Documentation

Bookmark

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
id
integer or null (Id)
name
required
string (Name) non-empty
uri
string or null (Uri)
list_layout
integer or null (List layout)
data
object or null (Data)
children
Array of objects or null or null (BookmarkRecursiveField)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
id
integer or null (Id)
name
required
string (Name) non-empty
uri
string or null (Uri)
list_layout
integer or null (List layout)
data
object or null (Data)
children
Array of objects or null or null (BookmarkRecursiveField)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
id
integer or null (Id)
name
required
string (Name) non-empty
uri
string or null (Uri)
list_layout
integer or null (List layout)
data
object or null (Data)
children
Array of objects or null or null (BookmarkRecursiveField)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
id
integer or null (Id)
name
required
string (Name) non-empty
uri
string or null (Uri)
list_layout
integer or null (List layout)
data
object or null (Data)
children
Array of objects or null or null (BookmarkRecursiveField)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
id
integer or null (Id)
name
required
string (Name) non-empty
uri
string or null (Uri)
list_layout
integer or null (List layout)
data
object or null (Data)
children
Array of objects or null or null (BookmarkRecursiveField)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this bookmark.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this bookmark.

Request Body schema: application/json
required
id
integer or null (Id)
name
required
string (Name) non-empty
uri
string or null (Uri)
list_layout
integer or null (List layout)
data
object or null (Data)
children
Array of objects or null or null (BookmarkRecursiveField)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this bookmark.

Request Body schema: application/json
required
id
integer or null (Id)
name
required
string (Name) non-empty
uri
string or null (Uri)
list_layout
integer or null (List layout)
data
object or null (Data)
children
Array of objects or null or null (BookmarkRecursiveField)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this bookmark.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this bookmark.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uri": "string",
  • "list_layout": 0,
  • "data": { },
  • "children": [
    ]
}

Color Palette

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

is_default
boolean (Is default)
required
Array of objects (ColorPaletteColor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

is_default
boolean (Is default)
required
Array of objects (ColorPaletteColor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

is_default
boolean (Is default)
required
Array of objects (ColorPaletteColor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

is_default
boolean (Is default)
required
Array of objects (ColorPaletteColor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

is_default
boolean (Is default)
required
Array of objects (ColorPaletteColor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this color palette.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this color palette.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

is_default
boolean (Is default)
required
Array of objects (ColorPaletteColor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this color palette.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

is_default
boolean (Is default)
required
Array of objects (ColorPaletteColor)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this color palette.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this color palette.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "is_default": true,
  • "colors": [
    ],
  • "deleted_user_code": "string"
}

Column Sort Data

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 1024 characters
column_key
string or null (Column key) <= 255 characters
is_common
boolean (Is common)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 1024 characters
column_key
string or null (Column key) <= 255 characters
is_common
boolean (Is common)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 1024 characters
column_key
string or null (Column key) <= 255 characters
is_common
boolean (Is common)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 1024 characters
column_key
string or null (Column key) <= 255 characters
is_common
boolean (Is common)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 1024 characters
column_key
string or null (Column key) <= 255 characters
is_common
boolean (Is common)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this column sort data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this column sort data.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 1024 characters
column_key
string or null (Column key) <= 255 characters
is_common
boolean (Is common)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this column sort data.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 1024 characters
column_key
string or null (Column key) <= 255 characters
is_common
boolean (Is common)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this column sort data.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this column sort data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "column_key": "string",
  • "is_common": true,
  • "data": { }
}

Complex Transaction User Field

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Primary

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this complex transaction user field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this complex transaction user field.

Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this complex transaction user field.

Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this complex transaction user field.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this complex transaction user field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Configuration Export Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
Default: ""
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
Default: ""
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
Default: ""
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
Default: ""
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
Default: ""
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this configuration export layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this configuration export layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
Default: ""
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this configuration export layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
Default: ""
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this configuration export layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this configuration export layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Ping

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this configuration export layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "",
  • "is_default": true,
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Context Menu Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this context menu layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this context menu layout.

Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this context menu layout.

Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this context menu layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this context menu layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Ping

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this context menu layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Cross Entity Attribute Extension

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
context_content_type
required
string (Context content type)
content_type_from
required
string (Content type from)
content_type_to
required
string (Content type to)
extension_type
string or null (Value type)
Enum: "NULL" "CONSTANT" "ATTRIBUTE"
key_from
string (Key from) <= 255 characters
Default: ""
key_to
string or null (Key to) <= 255 characters
value_to
string or null (Value to) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
context_content_type
required
string (Context content type)
content_type_from
required
string (Content type from)
content_type_to
required
string (Content type to)
extension_type
string or null (Value type)
Enum: "NULL" "CONSTANT" "ATTRIBUTE"
key_from
string (Key from) <= 255 characters
Default: ""
key_to
string or null (Key to) <= 255 characters
value_to
string or null (Value to) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
context_content_type
required
string (Context content type)
content_type_from
required
string (Content type from)
content_type_to
required
string (Content type to)
extension_type
string or null (Value type)
Enum: "NULL" "CONSTANT" "ATTRIBUTE"
key_from
string (Key from) <= 255 characters
Default: ""
key_to
string or null (Key to) <= 255 characters
value_to
string or null (Value to) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
context_content_type
required
string (Context content type)
content_type_from
required
string (Content type from)
content_type_to
required
string (Content type to)
extension_type
string or null (Value type)
Enum: "NULL" "CONSTANT" "ATTRIBUTE"
key_from
string (Key from) <= 255 characters
Default: ""
key_to
string or null (Key to) <= 255 characters
value_to
string or null (Value to) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
context_content_type
required
string (Context content type)
content_type_from
required
string (Content type from)
content_type_to
required
string (Content type to)
extension_type
string or null (Value type)
Enum: "NULL" "CONSTANT" "ATTRIBUTE"
key_from
string (Key from) <= 255 characters
Default: ""
key_to
string or null (Key to) <= 255 characters
value_to
string or null (Value to) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this cross entity attribute extension.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this cross entity attribute extension.

Request Body schema: application/json
required
context_content_type
required
string (Context content type)
content_type_from
required
string (Content type from)
content_type_to
required
string (Content type to)
extension_type
string or null (Value type)
Enum: "NULL" "CONSTANT" "ATTRIBUTE"
key_from
string (Key from) <= 255 characters
Default: ""
key_to
string or null (Key to) <= 255 characters
value_to
string or null (Value to) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this cross entity attribute extension.

Request Body schema: application/json
required
context_content_type
required
string (Context content type)
content_type_from
required
string (Content type from)
content_type_to
required
string (Content type to)
extension_type
string or null (Value type)
Enum: "NULL" "CONSTANT" "ATTRIBUTE"
key_from
string (Key from) <= 255 characters
Default: ""
key_to
string or null (Key to) <= 255 characters
value_to
string or null (Value to) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this cross entity attribute extension.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this cross entity attribute extension.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "context_content_type": "string",
  • "content_type_from": "string",
  • "content_type_to": "string",
  • "extension_type": "NULL",
  • "key_from": "",
  • "key_to": "string",
  • "value_to": "string"
}

Dashboard Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this dashboard layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this dashboard layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this dashboard layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this dashboard layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this dashboard layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Ping

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this dashboard layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Draft

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
required
string or null (User code) <= 1024 characters
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
required
string or null (User code) <= 1024 characters
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
required
string or null (User code) <= 1024 characters
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
required
string or null (User code) <= 1024 characters
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
required
string or null (User code) <= 1024 characters
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this draft.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this draft.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
required
string or null (User code) <= 1024 characters
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this draft.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
required
string or null (User code) <= 1024 characters
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this draft.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this draft.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user_code": "string",
  • "data": { },
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Edit Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this edit layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this edit layout.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this edit layout.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this edit layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this edit layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Ping

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this edit layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Entity Tooltip

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
key
string (Key) <= 255 characters
Default: ""
text
string or null (Text)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
key
string (Key) <= 255 characters
Default: ""
text
string or null (Text)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
key
string (Key) <= 255 characters
Default: ""
text
string or null (Text)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
key
string (Key) <= 255 characters
Default: ""
text
string or null (Text)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
key
string (Key) <= 255 characters
Default: ""
text
string or null (Text)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this entity tooltip.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this entity tooltip.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
key
string (Key) <= 255 characters
Default: ""
text
string or null (Text)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this entity tooltip.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
key
string (Key) <= 255 characters
Default: ""
text
string or null (Text)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this entity tooltip.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this entity tooltip.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "key": "",
  • "text": "string"
}

Instrument User Field

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
string (Key) <= 255 characters
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
string (Key) <= 255 characters
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
string (Key) <= 255 characters
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
string (Key) <= 255 characters
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
string (Key) <= 255 characters
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Primary

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this instrument user field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this instrument user field.

Request Body schema: application/json
required
key
string (Key) <= 255 characters
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this instrument user field.

Request Body schema: application/json
required
key
string (Key) <= 255 characters
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this instrument user field.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this instrument user field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

List Layout Light

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List light

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Request Body schema: application/json
required
content_type
required
string (Content type)
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
is_systemic
boolean (Is systemic)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Ping

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this list layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content_type": "string",
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "is_systemic": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Member Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this member layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this member layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this member layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)
origin_for_global_layout
integer or null (Origin for global layout)
sourced_from_global_layout
integer or null (Sourced for global layout)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this member layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this member layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Ping

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this member layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "origin_for_global_layout": 0,
  • "sourced_from_global_layout": 0,
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Mobile Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this mobile layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this mobile layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this mobile layout.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
is_default
boolean (Is default)
is_active
boolean (Is active)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this mobile layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this mobile layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Ping

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this mobile layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "is_default": true,
  • "is_active": true,
  • "data": { },
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Portal Interface Access

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique value identifying this portal interface access.

Responses

Response samples

Content type
application/json
{
  • "id": 32767,
  • "value": 32767,
  • "user_code": "string",
  • "name": "string"
}

System Attributes

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Template Layout

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
user_code
string or null (User code) <= 255 characters
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
user_code
string or null (User code) <= 255 characters
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
user_code
string or null (User code) <= 255 characters
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
user_code
string or null (User code) <= 255 characters
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
user_code
string or null (User code) <= 255 characters
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this template layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this template layout.

Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
user_code
string or null (User code) <= 255 characters
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this template layout.

Request Body schema: application/json
required
type
string (Type) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
user_code
string or null (User code) <= 255 characters
is_default
boolean (Is default)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this template layout.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this template layout.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "",
  • "name": "",
  • "user_code": "string",
  • "is_default": true,
  • "data": { },
  • "deleted_user_code": "string"
}

Transaction User Field

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Primary

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction user field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction user field.

Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction user field.

Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
name
string (Name) <= 255 characters
is_active
boolean (Is active)
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction user field.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction user field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "is_active": true,
  • "user_code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

User Interface Access

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
role
string or null (Role user code) <= 1024 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
allowed_items
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
role
string or null (Role user code) <= 1024 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
allowed_items
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
role
string or null (Role user code) <= 1024 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
allowed_items
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
role
string or null (Role user code) <= 1024 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
allowed_items
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string (Name) <= 255 characters
role
string or null (Role user code) <= 1024 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
allowed_items
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this user interface access model.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this user interface access model.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
role
string or null (Role user code) <= 1024 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
allowed_items
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this user interface access model.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
role
string or null (Role user code) <= 1024 characters
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
allowed_items
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this user interface access model.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this user interface access model.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "allowed_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}