logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

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

Finmars Documentation

Accrual Calculation Model

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 accrual calculation model.

Responses

Response samples

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

Cost Method

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 cost method.

Responses

Response samples

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

Country

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
[
  • {
    }
]

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string (User code) <= 255 characters
country_code
string or null (Country code) <= 255 characters
region
string or null (Region) <= 255 characters
region_code
string or null (Region code) <= 255 characters
alpha_2
string or null (Alpha 2) <= 255 characters
alpha_3
string or null (Alpha 3) <= 255 characters
sub_region
string or null (Sub region) <= 255 characters
sub_region_code
string or null (Sub region code) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string (User code) <= 255 characters
country_code
string or null (Country code) <= 255 characters
region
string or null (Region) <= 255 characters
region_code
string or null (Region code) <= 255 characters
alpha_2
string or null (Alpha 2) <= 255 characters
alpha_3
string or null (Alpha 3) <= 255 characters
sub_region
string or null (Sub region) <= 255 characters
sub_region_code
string or null (Sub region code) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string (User code) <= 255 characters
country_code
string or null (Country code) <= 255 characters
region
string or null (Region) <= 255 characters
region_code
string or null (Region code) <= 255 characters
alpha_2
string or null (Alpha 2) <= 255 characters
alpha_3
string or null (Alpha 3) <= 255 characters
sub_region
string or null (Sub region) <= 255 characters
sub_region_code
string or null (Sub region code) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string (User code) <= 255 characters
country_code
string or null (Country code) <= 255 characters
region
string or null (Region) <= 255 characters
region_code
string or null (Region code) <= 255 characters
alpha_2
string or null (Alpha 2) <= 255 characters
alpha_3
string or null (Alpha 3) <= 255 characters
sub_region
string or null (Sub region) <= 255 characters
sub_region_code
string or null (Sub region code) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string (User code) <= 255 characters
country_code
string or null (Country code) <= 255 characters
region
string or null (Region) <= 255 characters
region_code
string or null (Region code) <= 255 characters
alpha_2
string or null (Alpha 2) <= 255 characters
alpha_3
string or null (Alpha 3) <= 255 characters
sub_region
string or null (Sub region) <= 255 characters
sub_region_code
string or null (Sub region code) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Read

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

A unique integer value identifying this country.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Update

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

A unique integer value identifying this country.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string (User code) <= 255 characters
country_code
string or null (Country code) <= 255 characters
region
string or null (Region) <= 255 characters
region_code
string or null (Region code) <= 255 characters
alpha_2
string or null (Alpha 2) <= 255 characters
alpha_3
string or null (Alpha 3) <= 255 characters
sub_region
string or null (Sub region) <= 255 characters
sub_region_code
string or null (Sub region code) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_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 country.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string (User code) <= 255 characters
country_code
string or null (Country code) <= 255 characters
region
string or null (Region) <= 255 characters
region_code
string or null (Region code) <= 255 characters
alpha_2
string or null (Alpha 2) <= 255 characters
alpha_3
string or null (Alpha 3) <= 255 characters
sub_region
string or null (Sub region) <= 255 characters
sub_region_code
string or null (Sub region code) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Delete

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

A unique integer value identifying this country.

Responses

Delete preview

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

A unique integer value identifying this country.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "country_code": "string",
  • "region": "string",
  • "region_code": "string",
  • "alpha_2": "string",
  • "alpha_3": "string",
  • "sub_region": "string",
  • "sub_region_code": "string"
}

Daily Pricing Model

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 daily pricing model.

Responses

Response samples

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

Day Time Convention

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 value identifying this accrual calculation model.

Responses

Response samples

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

Delete preview

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

A unique value identifying this accrual calculation model.

Responses

Response samples

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

Event Schedule Config

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
required
string (Name) [ 1 .. 4096 ] characters
description
required
string (Description) [ 1 .. 4096 ] characters
notification_class
integer or null (Notification class)
object (NotificationClass)
notify_in_n_days
integer (Notify in N days) [ 0 .. 32767 ]
action_text
string (Action text) <= 255 characters
action_is_sent_to_pending
boolean (Action is sent to pending)
action_is_book_automatic
boolean (Action is book automatic)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 4096 ] characters
description
required
string (Description) [ 1 .. 4096 ] characters
notification_class
integer or null (Notification class)
object (NotificationClass)
notify_in_n_days
integer (Notify in N days) [ 0 .. 32767 ]
action_text
string (Action text) <= 255 characters
action_is_sent_to_pending
boolean (Action is sent to pending)
action_is_book_automatic
boolean (Action is book automatic)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 4096 ] characters
description
required
string (Description) [ 1 .. 4096 ] characters
notification_class
integer or null (Notification class)
object (NotificationClass)
notify_in_n_days
integer (Notify in N days) [ 0 .. 32767 ]
action_text
string (Action text) <= 255 characters
action_is_sent_to_pending
boolean (Action is sent to pending)
action_is_book_automatic
boolean (Action is book automatic)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 4096 ] characters
description
required
string (Description) [ 1 .. 4096 ] characters
notification_class
integer or null (Notification class)
object (NotificationClass)
notify_in_n_days
integer (Notify in N days) [ 0 .. 32767 ]
action_text
string (Action text) <= 255 characters
action_is_sent_to_pending
boolean (Action is sent to pending)
action_is_book_automatic
boolean (Action is book automatic)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 4096 ] characters
description
required
string (Description) [ 1 .. 4096 ] characters
notification_class
integer or null (Notification class)
object (NotificationClass)
notify_in_n_days
integer (Notify in N days) [ 0 .. 32767 ]
action_text
string (Action text) <= 255 characters
action_is_sent_to_pending
boolean (Action is sent to pending)
action_is_book_automatic
boolean (Action is book automatic)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Read

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

A unique integer value identifying this event schedule config.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Update

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

A unique integer value identifying this event schedule config.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 4096 ] characters
description
required
string (Description) [ 1 .. 4096 ] characters
notification_class
integer or null (Notification class)
object (NotificationClass)
notify_in_n_days
integer (Notify in N days) [ 0 .. 32767 ]
action_text
string (Action text) <= 255 characters
action_is_sent_to_pending
boolean (Action is sent to pending)
action_is_book_automatic
boolean (Action is book automatic)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Partial update

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

A unique integer value identifying this event schedule config.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 4096 ] characters
description
required
string (Description) [ 1 .. 4096 ] characters
notification_class
integer or null (Notification class)
object (NotificationClass)
notify_in_n_days
integer (Notify in N days) [ 0 .. 32767 ]
action_text
string (Action text) <= 255 characters
action_is_sent_to_pending
boolean (Action is sent to pending)
action_is_book_automatic
boolean (Action is book automatic)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Delete

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

A unique integer value identifying this event schedule config.

Responses

Delete preview

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

A unique integer value identifying this event schedule config.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "notification_class": 0,
  • "notification_class_object": {
    },
  • "notify_in_n_days": 32767,
  • "action_text": "string",
  • "action_is_sent_to_pending": true,
  • "action_is_book_automatic": true
}

Exposure Calculation Model

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 Exposure calculation model.

Responses

Response samples

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

Generated Event

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

Read

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

A unique integer value identifying this generated event.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "effective_date": "2019-08-24",
  • "notification_date": "2019-08-24",
  • "status": 1,
  • "status_date": "2019-08-24T14:15:22Z",
  • "event_schedule": 0,
  • "instrument": 0,
  • "portfolio": 0,
  • "account": 0,
  • "strategy1": 0,
  • "strategy2": 0,
  • "strategy3": 0,
  • "position": 0,
  • "is_need_reaction": true,
  • "action": 0,
  • "transaction_type": 0,
  • "member": 0,
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Update

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

A unique integer value identifying this generated event.

Request Body schema: application/json
required
data
required
object (Data)
object (EventSchedule)
object (InstrumentView)
object (PortfolioView)
object (AccountView)
object (Strategy1View)
object (Strategy2View)
object (Strategy3View)
object or null (EventScheduleAction)
object (TransactionTypeView)
object (MemberView)

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "effective_date": "2019-08-24",
  • "notification_date": "2019-08-24",
  • "status": 1,
  • "status_date": "2019-08-24T14:15:22Z",
  • "event_schedule": 0,
  • "instrument": 0,
  • "portfolio": 0,
  • "account": 0,
  • "strategy1": 0,
  • "strategy2": 0,
  • "strategy3": 0,
  • "position": 0,
  • "is_need_reaction": true,
  • "action": 0,
  • "transaction_type": 0,
  • "member": 0,
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Partial update

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

A unique integer value identifying this generated event.

Request Body schema: application/json
required
data
required
object (Data)
object (EventSchedule)
object (InstrumentView)
object (PortfolioView)
object (AccountView)
object (Strategy1View)
object (Strategy2View)
object (Strategy3View)
object or null (EventScheduleAction)
object (TransactionTypeView)
object (MemberView)

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "effective_date": "2019-08-24",
  • "notification_date": "2019-08-24",
  • "status": 1,
  • "status_date": "2019-08-24T14:15:22Z",
  • "event_schedule": 0,
  • "instrument": 0,
  • "portfolio": 0,
  • "account": 0,
  • "strategy1": 0,
  • "strategy2": 0,
  • "strategy3": 0,
  • "position": 0,
  • "is_need_reaction": true,
  • "action": 0,
  • "transaction_type": 0,
  • "member": 0,
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Error

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

A unique integer value identifying this generated event.

Request Body schema: application/json
required
data
required
object (Data)
object (EventSchedule)
object (InstrumentView)
object (PortfolioView)
object (AccountView)
object (Strategy1View)
object (Strategy2View)
object (Strategy3View)
object or null (EventScheduleAction)
object (TransactionTypeView)
object (MemberView)

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "effective_date": "2019-08-24",
  • "notification_date": "2019-08-24",
  • "status": 1,
  • "status_date": "2019-08-24T14:15:22Z",
  • "event_schedule": 0,
  • "instrument": 0,
  • "portfolio": 0,
  • "account": 0,
  • "strategy1": 0,
  • "strategy2": 0,
  • "strategy3": 0,
  • "position": 0,
  • "is_need_reaction": true,
  • "action": 0,
  • "transaction_type": 0,
  • "member": 0,
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Ignore

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

A unique integer value identifying this generated event.

Request Body schema: application/json
required
data
required
object (Data)
object (EventSchedule)
object (InstrumentView)
object (PortfolioView)
object (AccountView)
object (Strategy1View)
object (Strategy2View)
object (Strategy3View)
object or null (EventScheduleAction)
object (TransactionTypeView)
object (MemberView)

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "effective_date": "2019-08-24",
  • "notification_date": "2019-08-24",
  • "status": 1,
  • "status_date": "2019-08-24T14:15:22Z",
  • "event_schedule": 0,
  • "instrument": 0,
  • "portfolio": 0,
  • "account": 0,
  • "strategy1": 0,
  • "strategy2": 0,
  • "strategy3": 0,
  • "position": 0,
  • "is_need_reaction": true,
  • "action": 0,
  • "transaction_type": 0,
  • "member": 0,
  • "data": { },
  • "event_schedule_object": {
    },
  • "instrument_object": {
    },
  • "portfolio_object": {
    },
  • "account_object": {
    },
  • "strategy1_object": {
    },
  • "strategy2_object": {
    },
  • "strategy3_object": {
    },
  • "action_object": {
    },
  • "transaction_type_object": {
    },
  • "member_object": {
    }
}

Book

Book Read

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

A unique integer value identifying this generated event.

Responses

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Book Update

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

A unique integer value identifying this generated event.

Request Body schema: application/json
required
complex_transaction_status
integer or null (Complex transaction status)
Default: 1
Enum: 1 2 3
process_mode
string or null (Process mode)
Default: "book"
Enum: "book" "recalculate" "rebook"
recalculate_inputs
Array of strings or null
object or null (TransactionTypeComplexTransaction)
object (TransactionType)

Responses

Request samples

Content type
application/json
{
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Book Read

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

A unique integer value identifying this instrument type.

Responses

Response samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument": "string",
  • "instrument_type_object": {
    }
}

Book Update

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

A unique integer value identifying this instrument type.

Request Body schema: application/json
required
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "instrument_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument": "string",
  • "instrument_type_object": {
    }
}

Instrument 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"
}

Instrument Class

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 instrument class.

Responses

Response samples

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

Instrument Classifie

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

Instrument For Select

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

Read

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

A unique integer value identifying this instrument.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "identifier": { },
  • "modified_at": "2019-08-24T14:15:22Z",
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "public_name": "string",
  • "is_active": true,
  • "is_deleted": true,
  • "is_enabled": true,
  • "has_linked_with_portfolio": true,
  • "deleted_user_code": "string"
}

Delete preview

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

A unique integer value identifying this instrument.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "identifier": { },
  • "modified_at": "2019-08-24T14:15:22Z",
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "public_name": "string",
  • "is_active": true,
  • "is_deleted": true,
  • "is_enabled": true,
  • "has_linked_with_portfolio": true,
  • "deleted_user_code": "string"
}

Instrument 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"
}

Instrument 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
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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 update

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
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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 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 instrument type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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 instrument type.

Request Body schema: application/json
required
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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 instrument type.

Request Body schema: application/json
required
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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 instrument type.

Responses

Apply type to instruments

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

A unique integer value identifying this instrument type.

Request Body schema: application/json
required
mode
string or null (Mode)
Default: "overwrite"
Enum: "fill" "overwrite"
fields_to_update
required
Array of strings
Items Enum: "default_price" "default_accrued" "reference_for_pricing" "maturity_date" "maturity_price" "pricing_policies"

Responses

Request samples

Content type
application/json
{
  • "mode": "fill",
  • "fields_to_update": [
    ]
}

Response samples

Content type
application/json
{
  • "mode": "fill",
  • "fields_to_update": [
    ]
}

Delete preview

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

A unique integer value identifying this instrument type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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 Pricing

Update-pricing Read

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

A unique integer value identifying this instrument type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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-pricing Update

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

A unique integer value identifying this instrument type.

Request Body schema: application/json
required
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_deleted
boolean (Is deleted)

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

instrument_form_layouts
string or null (Instrument form layouts)
instrument_class
required
integer (Instrument class)
object (InstrumentClass)
one_off_event
string or null (One off event)
object (TransactionTypeSimpleView)
regular_event
string or null (Regular event)
object (TransactionTypeSimpleView)
factor_same
string or null (Factor same)
object (TransactionTypeSimpleView)
factor_up
string or null (Factor up)
object (TransactionTypeSimpleView)
factor_down
string or null (Factor down)
object (TransactionTypeSimpleView)
is_enabled
boolean (Is enabled)
Array of objects (InstrumentTypePricingPolicy)
has_second_exposure_currency
boolean (Has second exposure currency)
Array of objects (InstrumentTypeAccrual)
Array of objects (InstrumentTypeEvent)
Array of objects (InstrumentTypeInstrumentAttribute)
Array of objects (InstrumentTypeInstrumentFactorSchedule)
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
accrued_currency
string (Accrued currency)
accrued_multiplier
number (Accrued multiplier)
default_accrued
number (Default accrued)
exposure_calculation_model
integer or null (Exposure calculation model)
co_directional_exposure_currency
string or null (Co directional exposure currency) <= 255 characters
counter_directional_exposure_currency
string or null (Counter directional exposure currency) <= 255 characters
co_directional_exposure_currency_value_type
integer (Co directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
counter_directional_exposure_currency_value_type
integer (Counter directional exposure currency value type)
Enum: 20 10 40 30 50 60 70 100 110 120 80
long_underlying_instrument
string or null (Long underlying instrument) <= 255 characters
short_underlying_instrument
string or null (Short underlying instrument) <= 255 characters
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
instrument_factor_schedule_data
required
object (Instrument factor schedule data)
pricing_currency
integer or null (Pricing currency)
price_multiplier
number (Price multiplier)
pricing_condition
integer or null (Pricing condition)
object (PricingCondition)
default_price
number (Default price)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
reference_for_pricing
string (Reference for pricing) <= 100 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "instrument_form_layouts": "string",
  • "instrument_class": 0,
  • "instrument_class_object": {
    },
  • "one_off_event": "string",
  • "one_off_event_object": {
    },
  • "regular_event": "string",
  • "regular_event_object": {
    },
  • "factor_same": "string",
  • "factor_same_object": {
    },
  • "factor_up": "string",
  • "factor_up_object": {
    },
  • "factor_down": "string",
  • "factor_down_object": {
    },
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "has_second_exposure_currency": true,
  • "accruals": [
    ],
  • "events": [
    ],
  • "instrument_attributes": [
    ],
  • "instrument_factor_schedules": [
    ],
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "accrued_currency": "string",
  • "accrued_currency_object": 0,
  • "accrued_multiplier": 0,
  • "default_accrued": 0,
  • "exposure_calculation_model": 0,
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_value_type": 20,
  • "counter_directional_exposure_currency_value_type": 20,
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "instrument_factor_schedule_data": { },
  • "pricing_currency": 0,
  • "pricing_currency_object": 0,
  • "price_multiplier": 0,
  • "pricing_condition": 0,
  • "pricing_condition_object": {
    },
  • "default_price": 0,
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "reference_for_pricing": "string",
  • "configuration_code": "string",
  • "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"
}

Instrument

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
instrument_type
required
string (Instrument type)
object (InstrumentTypeView)
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

identifier
required
object (Identifier)
is_active
boolean (Is active)
Default: true
is_deleted
boolean (Is deleted)

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

has_linked_with_portfolio
boolean (Has linked with portfolio)
pricing_currency
required
string (Pricing currency)
object (CurrencyView)
price_multiplier
number (Price multiplier)
accrued_currency
required
string (Accrued currency)
object (CurrencyView)
accrued_multiplier
number (Accrued multiplier)
payment_size_detail
string or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
user_text_1
string or null (User text 1) <= 255 characters

User specified field 1

user_text_2
string or null (User text 2) <= 255 characters

User specified field 2

user_text_3
string or null (User text 3) <= 255 characters

User specified field 3

reference_for_pricing
string (Reference for pricing) <= 100 characters
daily_pricing_model
string or null (Daily pricing model)
object (DailyPricingModel)
pricing_condition
string or null (Pricing condition)
object (PricingCondition)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
Array of objects or null or null (ManualPricingFormula)
Array of objects or null or null (AccrualCalculationSchedule)
Array of objects or null or null (InstrumentFactorSchedule)
Array of objects or null (EventSchedule)
is_enabled
boolean (Is enabled)
Array of objects or null or null (InstrumentPricingPolicy)
exposure_calculation_model
integer or null (Exposure calculation model)
object (ExposureCalculationModel)
co_directional_exposure_currency
required
string (Co directional exposure currency)
counter_directional_exposure_currency
required
string (Counter directional exposure currency)
object (CurrencyView)
object (CurrencyView)
long_underlying_instrument
string or null (Long underlying instrument)
short_underlying_instrument
string or null (Short underlying instrument)
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
country
string or null (Country)
object (Country)
Array of objects or null or null (Accrual)
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: []

Responses

Request samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "accruals": [
    ],
  • "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": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

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
instrument_type
required
string (Instrument type)
object (InstrumentTypeView)
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

identifier
required
object (Identifier)
is_active
boolean (Is active)
Default: true
is_deleted
boolean (Is deleted)

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

has_linked_with_portfolio
boolean (Has linked with portfolio)
pricing_currency
required
string (Pricing currency)
object (CurrencyView)
price_multiplier
number (Price multiplier)
accrued_currency
required
string (Accrued currency)
object (CurrencyView)
accrued_multiplier
number (Accrued multiplier)
payment_size_detail
string or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
user_text_1
string or null (User text 1) <= 255 characters

User specified field 1

user_text_2
string or null (User text 2) <= 255 characters

User specified field 2

user_text_3
string or null (User text 3) <= 255 characters

User specified field 3

reference_for_pricing
string (Reference for pricing) <= 100 characters
daily_pricing_model
string or null (Daily pricing model)
object (DailyPricingModel)
pricing_condition
string or null (Pricing condition)
object (PricingCondition)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
Array of objects or null or null (ManualPricingFormula)
Array of objects or null or null (AccrualCalculationSchedule)
Array of objects or null or null (InstrumentFactorSchedule)
Array of objects or null (EventSchedule)
is_enabled
boolean (Is enabled)
Array of objects or null or null (InstrumentPricingPolicy)
exposure_calculation_model
integer or null (Exposure calculation model)
object (ExposureCalculationModel)
co_directional_exposure_currency
required
string (Co directional exposure currency)
counter_directional_exposure_currency
required
string (Counter directional exposure currency)
object (CurrencyView)
object (CurrencyView)
long_underlying_instrument
string or null (Long underlying instrument)
short_underlying_instrument
string or null (Short underlying instrument)
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
country
string or null (Country)
object (Country)
Array of objects or null or null (Accrual)
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: []

Responses

Request samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "accruals": [
    ],
  • "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": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument_type
required
string (Instrument type)
object (InstrumentTypeView)
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

identifier
required
object (Identifier)
is_active
boolean (Is active)
Default: true
is_deleted
boolean (Is deleted)

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

has_linked_with_portfolio
boolean (Has linked with portfolio)
pricing_currency
required
string (Pricing currency)
object (CurrencyView)
price_multiplier
number (Price multiplier)
accrued_currency
required
string (Accrued currency)
object (CurrencyView)
accrued_multiplier
number (Accrued multiplier)
payment_size_detail
string or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
user_text_1
string or null (User text 1) <= 255 characters

User specified field 1

user_text_2
string or null (User text 2) <= 255 characters

User specified field 2

user_text_3
string or null (User text 3) <= 255 characters

User specified field 3

reference_for_pricing
string (Reference for pricing) <= 100 characters
daily_pricing_model
string or null (Daily pricing model)
object (DailyPricingModel)
pricing_condition
string or null (Pricing condition)
object (PricingCondition)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
Array of objects or null or null (ManualPricingFormula)
Array of objects or null or null (AccrualCalculationSchedule)
Array of objects or null or null (InstrumentFactorSchedule)
Array of objects or null (EventSchedule)
is_enabled
boolean (Is enabled)
Array of objects or null or null (InstrumentPricingPolicy)
exposure_calculation_model
integer or null (Exposure calculation model)
object (ExposureCalculationModel)
co_directional_exposure_currency
required
string (Co directional exposure currency)
counter_directional_exposure_currency
required
string (Counter directional exposure currency)
object (CurrencyView)
object (CurrencyView)
long_underlying_instrument
string or null (Long underlying instrument)
short_underlying_instrument
string or null (Short underlying instrument)
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
country
string or null (Country)
object (Country)
Array of objects or null or null (Accrual)
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: []

Responses

Request samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "accruals": [
    ],
  • "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": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument_type
required
string (Instrument type)
object (InstrumentTypeView)
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

identifier
required
object (Identifier)
is_active
boolean (Is active)
Default: true
is_deleted
boolean (Is deleted)

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

has_linked_with_portfolio
boolean (Has linked with portfolio)
pricing_currency
required
string (Pricing currency)
object (CurrencyView)
price_multiplier
number (Price multiplier)
accrued_currency
required
string (Accrued currency)
object (CurrencyView)
accrued_multiplier
number (Accrued multiplier)
payment_size_detail
string or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
user_text_1
string or null (User text 1) <= 255 characters

User specified field 1

user_text_2
string or null (User text 2) <= 255 characters

User specified field 2

user_text_3
string or null (User text 3) <= 255 characters

User specified field 3

reference_for_pricing
string (Reference for pricing) <= 100 characters
daily_pricing_model
string or null (Daily pricing model)
object (DailyPricingModel)
pricing_condition
string or null (Pricing condition)
object (PricingCondition)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
Array of objects or null or null (ManualPricingFormula)
Array of objects or null or null (AccrualCalculationSchedule)
Array of objects or null or null (InstrumentFactorSchedule)
Array of objects or null (EventSchedule)
is_enabled
boolean (Is enabled)
Array of objects or null or null (InstrumentPricingPolicy)
exposure_calculation_model
integer or null (Exposure calculation model)
object (ExposureCalculationModel)
co_directional_exposure_currency
required
string (Co directional exposure currency)
counter_directional_exposure_currency
required
string (Counter directional exposure currency)
object (CurrencyView)
object (CurrencyView)
long_underlying_instrument
string or null (Long underlying instrument)
short_underlying_instrument
string or null (Short underlying instrument)
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
country
string or null (Country)
object (Country)
Array of objects or null or null (Accrual)
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: []

Responses

Request samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "accruals": [
    ],
  • "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": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument_type
required
string (Instrument type)
object (InstrumentTypeView)
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

identifier
required
object (Identifier)
is_active
boolean (Is active)
Default: true
is_deleted
boolean (Is deleted)

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

has_linked_with_portfolio
boolean (Has linked with portfolio)
pricing_currency
required
string (Pricing currency)
object (CurrencyView)
price_multiplier
number (Price multiplier)
accrued_currency
required
string (Accrued currency)
object (CurrencyView)
accrued_multiplier
number (Accrued multiplier)
payment_size_detail
string or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
user_text_1
string or null (User text 1) <= 255 characters

User specified field 1

user_text_2
string or null (User text 2) <= 255 characters

User specified field 2

user_text_3
string or null (User text 3) <= 255 characters

User specified field 3

reference_for_pricing
string (Reference for pricing) <= 100 characters
daily_pricing_model
string or null (Daily pricing model)
object (DailyPricingModel)
pricing_condition
string or null (Pricing condition)
object (PricingCondition)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
Array of objects or null or null (ManualPricingFormula)
Array of objects or null or null (AccrualCalculationSchedule)
Array of objects or null or null (InstrumentFactorSchedule)
Array of objects or null (EventSchedule)
is_enabled
boolean (Is enabled)
Array of objects or null or null (InstrumentPricingPolicy)
exposure_calculation_model
integer or null (Exposure calculation model)
object (ExposureCalculationModel)
co_directional_exposure_currency
required
string (Co directional exposure currency)
counter_directional_exposure_currency
required
string (Counter directional exposure currency)
object (CurrencyView)
object (CurrencyView)
long_underlying_instrument
string or null (Long underlying instrument)
short_underlying_instrument
string or null (Short underlying instrument)
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
country
string or null (Country)
object (Country)
Array of objects or null or null (Accrual)
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: []

Responses

Request samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "accruals": [
    ],
  • "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": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

Generate events range for single instrument

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Generate events range

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Generate events

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Is on balance

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
date
string <date> (Date)
Default: "2025-02-20"
user_codes
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "date": "2025-02-20",
  • "user_codes": [
    ]
}

Response samples

Content type
application/json
{
  • "date": "2025-02-20",
  • "user_codes": [
    ]
}

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

Process events

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Rebuild all events

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Calculate prices accrued price

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
begin_date
string or null <date> (Begin date)
end_date
string or null <date> (End date)

Responses

Request samples

Content type
application/json
{
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

System generate and process

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

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

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

Update

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

A unique integer value identifying this instrument.

Request Body schema: application/json
required
instrument_type
required
string (Instrument type)
object (InstrumentTypeView)
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

identifier
required
object (Identifier)
is_active
boolean (Is active)
Default: true
is_deleted
boolean (Is deleted)

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

has_linked_with_portfolio
boolean (Has linked with portfolio)
pricing_currency
required
string (Pricing currency)
object (CurrencyView)
price_multiplier
number (Price multiplier)
accrued_currency
required
string (Accrued currency)
object (CurrencyView)
accrued_multiplier
number (Accrued multiplier)
payment_size_detail
string or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
user_text_1
string or null (User text 1) <= 255 characters

User specified field 1

user_text_2
string or null (User text 2) <= 255 characters

User specified field 2

user_text_3
string or null (User text 3) <= 255 characters

User specified field 3

reference_for_pricing
string (Reference for pricing) <= 100 characters
daily_pricing_model
string or null (Daily pricing model)
object (DailyPricingModel)
pricing_condition
string or null (Pricing condition)
object (PricingCondition)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
Array of objects or null or null (ManualPricingFormula)
Array of objects or null or null (AccrualCalculationSchedule)
Array of objects or null or null (InstrumentFactorSchedule)
Array of objects or null (EventSchedule)
is_enabled
boolean (Is enabled)
Array of objects or null or null (InstrumentPricingPolicy)
exposure_calculation_model
integer or null (Exposure calculation model)
object (ExposureCalculationModel)
co_directional_exposure_currency
required
string (Co directional exposure currency)
counter_directional_exposure_currency
required
string (Counter directional exposure currency)
object (CurrencyView)
object (CurrencyView)
long_underlying_instrument
string or null (Long underlying instrument)
short_underlying_instrument
string or null (Short underlying instrument)
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
country
string or null (Country)
object (Country)
Array of objects or null or null (Accrual)
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: []

Responses

Request samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "accruals": [
    ],
  • "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": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

Partial update

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

A unique integer value identifying this instrument.

Request Body schema: application/json
required
instrument_type
required
string (Instrument type)
object (InstrumentTypeView)
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

identifier
required
object (Identifier)
is_active
boolean (Is active)
Default: true
is_deleted
boolean (Is deleted)

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

has_linked_with_portfolio
boolean (Has linked with portfolio)
pricing_currency
required
string (Pricing currency)
object (CurrencyView)
price_multiplier
number (Price multiplier)
accrued_currency
required
string (Accrued currency)
object (CurrencyView)
accrued_multiplier
number (Accrued multiplier)
payment_size_detail
string or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
user_text_1
string or null (User text 1) <= 255 characters

User specified field 1

user_text_2
string or null (User text 2) <= 255 characters

User specified field 2

user_text_3
string or null (User text 3) <= 255 characters

User specified field 3

reference_for_pricing
string (Reference for pricing) <= 100 characters
daily_pricing_model
string or null (Daily pricing model)
object (DailyPricingModel)
pricing_condition
string or null (Pricing condition)
object (PricingCondition)
maturity_date
string or null <date> (Maturity date)
maturity_price
number (Maturity price)
Array of objects or null or null (ManualPricingFormula)
Array of objects or null or null (AccrualCalculationSchedule)
Array of objects or null or null (InstrumentFactorSchedule)
Array of objects or null (EventSchedule)
is_enabled
boolean (Is enabled)
Array of objects or null or null (InstrumentPricingPolicy)
exposure_calculation_model
integer or null (Exposure calculation model)
object (ExposureCalculationModel)
co_directional_exposure_currency
required
string (Co directional exposure currency)
counter_directional_exposure_currency
required
string (Counter directional exposure currency)
object (CurrencyView)
object (CurrencyView)
long_underlying_instrument
string or null (Long underlying instrument)
short_underlying_instrument
string or null (Short underlying instrument)
underlying_long_multiplier
number (Underlying long multiplier)
underlying_short_multiplier
number (Underlying short multiplier)
long_underlying_exposure
integer or null (Long underlying exposure)
short_underlying_exposure
integer or null (Short underlying exposure)
position_reporting
integer (Position reporting)
Enum: 1 2 3
country
string or null (Country)
object (Country)
Array of objects or null or null (Accrual)
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: []

Responses

Request samples

Content type
application/json
{
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "accruals": [
    ],
  • "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": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

Delete

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

A unique integer value identifying this instrument.

Responses

Attach file

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

A unique integer value identifying this instrument.

Request Body schema: application/json
required
attachments
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "attachments": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete preview

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

A unique integer value identifying this instrument.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument_type": "string",
  • "instrument_type_object": {
    },
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "identifier": { },
  • "is_active": true,
  • "is_deleted": true,
  • "has_linked_with_portfolio": true,
  • "pricing_currency": "string",
  • "pricing_currency_object": {
    },
  • "price_multiplier": 0,
  • "accrued_currency": "string",
  • "accrued_currency_object": {
    },
  • "accrued_multiplier": 0,
  • "payment_size_detail": "string",
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "reference_for_pricing": "string",
  • "daily_pricing_model": "string",
  • "daily_pricing_model_object": {
    },
  • "pricing_condition": "string",
  • "pricing_condition_object": {
    },
  • "maturity_date": "2019-08-24",
  • "maturity_price": 0,
  • "manual_pricing_formulas": [
    ],
  • "accrual_calculation_schedules": [
    ],
  • "factor_schedules": [
    ],
  • "event_schedules": [
    ],
  • "is_enabled": true,
  • "pricing_policies": [
    ],
  • "exposure_calculation_model": 0,
  • "exposure_calculation_model_object": {
    },
  • "co_directional_exposure_currency": "string",
  • "counter_directional_exposure_currency": "string",
  • "co_directional_exposure_currency_object": {
    },
  • "counter_directional_exposure_currency_object": {
    },
  • "long_underlying_instrument": "string",
  • "short_underlying_instrument": "string",
  • "long_underlying_instrument_object": 0,
  • "short_underlying_instrument_object": 0,
  • "underlying_long_multiplier": 0,
  • "underlying_short_multiplier": 0,
  • "long_underlying_exposure": 0,
  • "short_underlying_exposure": 0,
  • "position_reporting": 1,
  • "country": "string",
  • "country_object": {
    },
  • "files": [
    ],
  • "first_transaction_date": "string",
  • "accruals": [
    ],
  • "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": [
    ]
}

Rebuild Events

Rebuild-events Update

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

A unique integer value identifying this instrument.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Rebuild-events Partial update

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

A unique integer value identifying this instrument.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Long Underlying Exposure

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 Long underlying exposure.

Responses

Response samples

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

Payment Size Detail

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 payment size detail.

Responses

Response samples

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

Periodicity

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

Responses

Response samples

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

Price History

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
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "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 create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

Recalculate

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))
recalculate_inputs
Array of strings
Default: []
Items Enum: "accrued_price" "factor" "ytm" "modified_duration"

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string",
  • "recalculate_inputs": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string",
  • "recalculate_inputs": [ ]
}

Read

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

A unique integer value identifying this price history.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

Update

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

A unique integer value identifying this price history.

Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

Partial update

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

A unique integer value identifying this price history.

Request Body schema: application/json
required
instrument
required
string (Instrument)
object (InstrumentView)
pricing_policy
required
string (Pricing policy)
object (PricingPolicy)
date
string <date> (Date)
Default: "2025-02-20"
principal_price
required
number (Principal price)
accrued_price
required
number (Accrued price)
nav
number (Nav)
cash_flow
number (Cash flow)
factor
number (Factor)
long_delta
number (Long delta)
short_delta
number (Short delta)
is_temporary_price
boolean (Is temporary price)
modified_duration
number (Modified duration)
error_message
string or null (Error message(s))

Responses

Request samples

Content type
application/json
{
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "modified_duration": 0,
  • "error_message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

Delete

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

A unique integer value identifying this price history.

Responses

Delete preview

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

A unique integer value identifying this price history.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "instrument": "string",
  • "instrument_object": {
    },
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "date": "2025-02-20",
  • "principal_price": 0,
  • "accrued_price": 0,
  • "procedure_modified_datetime": "string",
  • "nav": 0,
  • "cash_flow": 0,
  • "factor": 0,
  • "long_delta": 0,
  • "short_delta": 0,
  • "is_temporary_price": true,
  • "ytm": "string",
  • "modified_duration": 0,
  • "error_message": "string"
}

Pricing Condition

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 pricing condition.

Responses

Response samples

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

Pricing Policy

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

notes
string or null (Notes)

Notes, any useful information about the object

expr
string or null (Expression) <= 4096 characters
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

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

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

notes
string or null (Notes)

Notes, any useful information about the object

expr
string or null (Expression) <= 4096 characters
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

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

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

notes
string or null (Notes)

Notes, any useful information about the object

expr
string or null (Expression) <= 4096 characters
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

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

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

notes
string or null (Notes)

Notes, any useful information about the object

expr
string or null (Expression) <= 4096 characters
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

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

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

notes
string or null (Notes)

Notes, any useful information about the object

expr
string or null (Expression) <= 4096 characters
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

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

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 pricing policy.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

Update

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

A unique integer value identifying this pricing policy.

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

notes
string or null (Notes)

Notes, any useful information about the object

expr
string or null (Expression) <= 4096 characters
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

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

Partial update

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

A unique integer value identifying this pricing policy.

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

notes
string or null (Notes)

Notes, any useful information about the object

expr
string or null (Expression) <= 4096 characters
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

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

Delete

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

A unique integer value identifying this pricing policy.

Responses

Delete preview

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

A unique integer value identifying this pricing policy.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "notes": "string",
  • "expr": "string",
  • "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"
}

Short Underlying Exposure

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 Short underlying exposure.

Responses

Response samples

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