logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

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

Finmars Documentation

Account Attribute Type

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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Bulk delete

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Bulk restore

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Delete preview

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Objects to recalculate

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Recalculate attributes

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

A unique integer value identifying this attribute type.

Request Body schema: application/json
required
task_id
string or null (Task id)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string"
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "stats": "string",
  • "stats_file_report": "string"
}

Account Classifier

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
{}

Read

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

A unique integer value identifying this classifier.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "attribute_type": 0,
  • "level": 0,
  • "parent": 0,
  • "name": "string"
}

Account Type Attribute Type

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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Bulk delete

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Bulk restore

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Delete preview

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Objects to recalculate

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Recalculate attributes

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

A unique integer value identifying this attribute type.

Request Body schema: application/json
required
task_id
string or null (Task id)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string"
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "stats": "string",
  • "stats_file_report": "string"
}

Account Type

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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

show_transaction_details
boolean (Show transaction details)
transaction_details_expr
string or null (Transaction details expr) <= 4096 characters
Default: "\"\""
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "deleted_user_code": "string"
}

List attributes

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": [
    ]
}

Bulk delete

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

show_transaction_details
boolean (Show transaction details)
transaction_details_expr
string or null (Transaction details expr) <= 4096 characters
Default: "\"\""
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "deleted_user_code": "string"
}

Bulk restore

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

show_transaction_details
boolean (Show transaction details)
transaction_details_expr
string or null (Transaction details expr) <= 4096 characters
Default: "\"\""
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

show_transaction_details
boolean (Show transaction details)
transaction_details_expr
string or null (Transaction details expr) <= 4096 characters
Default: "\"\""
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

show_transaction_details
boolean (Show transaction details)
transaction_details_expr
string or null (Transaction details expr) <= 4096 characters
Default: "\"\""
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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 account type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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 account type.

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

show_transaction_details
boolean (Show transaction details)
transaction_details_expr
string or null (Transaction details expr) <= 4096 characters
Default: "\"\""
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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 account type.

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

show_transaction_details
boolean (Show transaction details)
transaction_details_expr
string or null (Transaction details expr) <= 4096 characters
Default: "\"\""
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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 account type.

Responses

Delete preview

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

A unique integer value identifying this account type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "show_transaction_details": true,
  • "transaction_details_expr": "\"\"",
  • "is_deleted": true,
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "deleted_user_code": "string"
}

Account

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
required
string (Type)
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

portfolios
Array of strings or null unique
is_enabled
boolean (Is enabled)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

List attributes

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": [
    ]
}

Bulk delete

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

portfolios
Array of strings or null unique
is_enabled
boolean (Is enabled)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

Bulk restore

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

portfolios
Array of strings or null unique
is_enabled
boolean (Is enabled)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

List ev group

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

portfolios
Array of strings or null unique
is_enabled
boolean (Is enabled)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

List ev item

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

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

portfolios
Array of strings or null unique
is_enabled
boolean (Is enabled)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

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 account.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

Update

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

A unique integer value identifying this account.

Request Body schema: application/json
required
type
required
string (Type)
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

portfolios
Array of strings or null unique
is_enabled
boolean (Is enabled)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

Partial update

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

A unique integer value identifying this account.

Request Body schema: application/json
required
type
required
string (Type)
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

portfolios
Array of strings or null unique
is_enabled
boolean (Is enabled)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}

Delete

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

A unique integer value identifying this account.

Responses

Delete preview

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

A unique integer value identifying this account.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_valid_for_all_portfolios": true,
  • "is_deleted": true,
  • "portfolios": [
    ],
  • "is_enabled": true,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "type_object": {
    },
  • "portfolios_object": [
    ]
}