logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

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

Finmars Documentation

Account Classifier Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this account classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this account classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this account classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this account classifier mapping.

Responses

Delete preview

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

A unique integer value identifying this account classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Account Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this account mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this account mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this account mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this account mapping.

Responses

Delete preview

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

A unique integer value identifying this account mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Account Type Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this account type mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this account type mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this account type mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (AccountTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this account type mapping.

Responses

Delete preview

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

A unique integer value identifying this account type mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Accrual Calculation Model Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (AccrualCalculationModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (AccrualCalculationModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (AccrualCalculationModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (AccrualCalculationModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (AccrualCalculationModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this accrual calculation model mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this accrual calculation model mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (AccrualCalculationModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this accrual calculation model mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (AccrualCalculationModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this accrual calculation model mapping.

Responses

Delete preview

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

A unique integer value identifying this accrual calculation model mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Accrual Schedule Download 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 accrual schedule download method.

Responses

Response samples

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

Complex Transaction Csv File Import Validate

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "file": "http://example.com",
  • "stats_file_report": "string",
  • "task_status": "string"
}

Complex Transaction Csv File Import

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "file": "http://example.com",
  • "stats_file_report": "string",
  • "task_status": "string"
}

Complex Transaction Import Scheme Light

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

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

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

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

Bulk delete

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

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

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

Bulk restore

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

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "rule_expr": "string",
  • "configuration_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
required
string or null (User code) <= 1024 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "rule_expr": "string",
  • "configuration_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
required
string or null (User code) <= 1024 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

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

Read

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

A unique integer value identifying this complex transaction import scheme.

Responses

Response samples

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

Update

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

A unique integer value identifying this complex transaction import scheme.

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

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

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

Partial update

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

A unique integer value identifying this complex transaction import scheme.

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

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

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

Delete

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

A unique integer value identifying this complex transaction import scheme.

Responses

Delete preview

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

A unique integer value identifying this complex transaction import scheme.

Responses

Response samples

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

Complex Transaction Import Scheme

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
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

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
book_uniqueness_settings
integer (Book uniqueness settings)
Enum: 1 2 3 4 5
expression_iterations_count
integer (Expression iterations count) [ -32768 .. 32767 ]
required
Array of objects (ComplexTransactionImportSchemeInput)
Array of objects (ComplexTransactionImportSchemeCalculatedInput)
required
Array of objects (ComplexTransactionImportSchemeRuleScenario)
required
Array of objects (ComplexTransactionImportSchemeSelectorValue)
required
Array of objects (ComplexTransactionImportSchemeReconScenario)
recon_layout
object or null (Recon layout)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
filter_expression
string or null (Filter expression) <= 255 characters
has_header_row
boolean (Has header row)
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": ""
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
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

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
book_uniqueness_settings
integer (Book uniqueness settings)
Enum: 1 2 3 4 5
expression_iterations_count
integer (Expression iterations count) [ -32768 .. 32767 ]
required
Array of objects (ComplexTransactionImportSchemeInput)
Array of objects (ComplexTransactionImportSchemeCalculatedInput)
required
Array of objects (ComplexTransactionImportSchemeRuleScenario)
required
Array of objects (ComplexTransactionImportSchemeSelectorValue)
required
Array of objects (ComplexTransactionImportSchemeReconScenario)
recon_layout
object or null (Recon layout)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
filter_expression
string or null (Filter expression) <= 255 characters
has_header_row
boolean (Has header row)
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": ""
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
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

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
book_uniqueness_settings
integer (Book uniqueness settings)
Enum: 1 2 3 4 5
expression_iterations_count
integer (Expression iterations count) [ -32768 .. 32767 ]
required
Array of objects (ComplexTransactionImportSchemeInput)
Array of objects (ComplexTransactionImportSchemeCalculatedInput)
required
Array of objects (ComplexTransactionImportSchemeRuleScenario)
required
Array of objects (ComplexTransactionImportSchemeSelectorValue)
required
Array of objects (ComplexTransactionImportSchemeReconScenario)
recon_layout
object or null (Recon layout)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
filter_expression
string or null (Filter expression) <= 255 characters
has_header_row
boolean (Has header row)
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": ""
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
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

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
book_uniqueness_settings
integer (Book uniqueness settings)
Enum: 1 2 3 4 5
expression_iterations_count
integer (Expression iterations count) [ -32768 .. 32767 ]
required
Array of objects (ComplexTransactionImportSchemeInput)
Array of objects (ComplexTransactionImportSchemeCalculatedInput)
required
Array of objects (ComplexTransactionImportSchemeRuleScenario)
required
Array of objects (ComplexTransactionImportSchemeSelectorValue)
required
Array of objects (ComplexTransactionImportSchemeReconScenario)
recon_layout
object or null (Recon layout)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
filter_expression
string or null (Filter expression) <= 255 characters
has_header_row
boolean (Has header row)
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": ""
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

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

Human Readable Name of the object

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

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

List light

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Read

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

A unique integer value identifying this complex transaction import scheme.

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",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

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

A unique integer value identifying this complex transaction import scheme.

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

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
book_uniqueness_settings
integer (Book uniqueness settings)
Enum: 1 2 3 4 5
expression_iterations_count
integer (Expression iterations count) [ -32768 .. 32767 ]
required
Array of objects (ComplexTransactionImportSchemeInput)
Array of objects (ComplexTransactionImportSchemeCalculatedInput)
required
Array of objects (ComplexTransactionImportSchemeRuleScenario)
required
Array of objects (ComplexTransactionImportSchemeSelectorValue)
required
Array of objects (ComplexTransactionImportSchemeReconScenario)
recon_layout
object or null (Recon layout)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
filter_expression
string or null (Filter expression) <= 255 characters
has_header_row
boolean (Has header row)
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": ""
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

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

A unique integer value identifying this complex transaction import scheme.

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

rule_expr
required
string (Rule expr) [ 1 .. 4096 ] characters
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
book_uniqueness_settings
integer (Book uniqueness settings)
Enum: 1 2 3 4 5
expression_iterations_count
integer (Expression iterations count) [ -32768 .. 32767 ]
required
Array of objects (ComplexTransactionImportSchemeInput)
Array of objects (ComplexTransactionImportSchemeCalculatedInput)
required
Array of objects (ComplexTransactionImportSchemeRuleScenario)
required
Array of objects (ComplexTransactionImportSchemeSelectorValue)
required
Array of objects (ComplexTransactionImportSchemeReconScenario)
recon_layout
object or null (Recon layout)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
filter_expression
string or null (Filter expression) <= 255 characters
has_header_row
boolean (Has header row)
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": ""
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

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

A unique integer value identifying this complex transaction import scheme.

Responses

Delete preview

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

A unique integer value identifying this complex transaction import scheme.

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",
  • "rule_expr": "string",
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "book_uniqueness_settings": 1,
  • "expression_iterations_count": -32768,
  • "inputs": [
    ],
  • "calculated_inputs": [
    ],
  • "rule_scenarios": [
    ],
  • "selector_values": [
    ],
  • "recon_scenarios": [
    ],
  • "recon_layout": { },
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "column_matcher": "index",
  • "filter_expression": "string",
  • "has_header_row": true,
  • "data_preprocess_expression": "",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Complex Transaction Preprocess File

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "file": "http://example.com",
  • "stats_file_report": "string",
  • "task_status": "string"
}

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
provider
required
integer (Provider)
object (ProviderClass)
password
required
string or null (Password)
is_valid
boolean (Is valid)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "provider_object": {
    },
  • "password": "string",
  • "is_valid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
object (ProviderClass)
password
required
string or null (Password)
is_valid
boolean (Is valid)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "provider_object": {
    },
  • "password": "string",
  • "is_valid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
object (ProviderClass)
password
required
string or null (Password)
is_valid
boolean (Is valid)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "provider_object": {
    },
  • "password": "string",
  • "is_valid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
object (ProviderClass)
password
required
string or null (Password)
is_valid
boolean (Is valid)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "provider_object": {
    },
  • "password": "string",
  • "is_valid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
object (ProviderClass)
password
required
string or null (Password)
is_valid
boolean (Is valid)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "provider_object": {
    },
  • "password": "string",
  • "is_valid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

Read

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

A unique integer value identifying this import config.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

Update

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

A unique integer value identifying this import config.

Request Body schema: application/json
required
provider
required
integer (Provider)
object (ProviderClass)
password
required
string or null (Password)
is_valid
boolean (Is valid)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "provider_object": {
    },
  • "password": "string",
  • "is_valid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

Partial update

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

A unique integer value identifying this import config.

Request Body schema: application/json
required
provider
required
integer (Provider)
object (ProviderClass)
password
required
string or null (Password)
is_valid
boolean (Is valid)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "provider_object": {
    },
  • "password": "string",
  • "is_valid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

Delete

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

A unique integer value identifying this import 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 import config.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "provider_object": {
    },
  • "p12cert": "http://example.com",
  • "password": "string",
  • "has_p12cert": "string",
  • "has_password": "string",
  • "is_valid": true
}

Counterparty Classifier Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this responsible classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this responsible classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this responsible classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this responsible classifier mapping.

Responses

Delete preview

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

A unique integer value identifying this responsible classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Counterparty Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CounterpartyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CounterpartyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CounterpartyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CounterpartyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CounterpartyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this counterparty mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this counterparty mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CounterpartyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this counterparty mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CounterpartyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this counterparty mapping.

Responses

Delete preview

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

A unique integer value identifying this counterparty mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Csv

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
quotechar
string (Quotechar) = 1 characters
Default: "\""
encoding
string (Encoding) [ 1 .. 20 ] characters
Default: "utf-8-sig"
error_handler
string (Error handler)
Default: "continue"
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Default: "throw_error"
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Default: "skip"
Enum: "skip" "append"
mode
string (Mode)
Default: "skip"
Enum: "skip" "overwrite"
object (CsvImportScheme)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "scheme_object": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "file": "http://example.com",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "stats": "string",
  • "stats_file_report": "string",
  • "imported": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "scheme_object": {
    }
}

Execute

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
quotechar
string (Quotechar) = 1 characters
Default: "\""
encoding
string (Encoding) [ 1 .. 20 ] characters
Default: "utf-8-sig"
error_handler
string (Error handler)
Default: "continue"
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Default: "throw_error"
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Default: "skip"
Enum: "skip" "append"
mode
string (Mode)
Default: "skip"
Enum: "skip" "overwrite"
object (CsvImportScheme)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "scheme_object": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "file": "http://example.com",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "stats": "string",
  • "stats_file_report": "string",
  • "imported": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "scheme_object": {
    }
}

Scheme

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

Scheme 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

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

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

filter_expr
string or null (Filter expression) <= 1000 characters
content_type
required
string (Content type)
required
Array of objects (CsvField)
required
Array of objects (EntityField)
Array of objects (CsvImportSchemeCalculatedInput)
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
mode
string (Mode)
Enum: "skip" "overwrite"
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Enum: "skip" "append"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
instrument_reference_column
string or null (Instrument reference column) <= 255 characters
item_post_process_script
string or null (Item post process script) <= 4096 characters
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Scheme 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

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

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

filter_expr
string or null (Filter expression) <= 1000 characters
content_type
required
string (Content type)
required
Array of objects (CsvField)
required
Array of objects (EntityField)
Array of objects (CsvImportSchemeCalculatedInput)
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
mode
string (Mode)
Enum: "skip" "overwrite"
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Enum: "skip" "append"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
instrument_reference_column
string or null (Instrument reference column) <= 255 characters
item_post_process_script
string or null (Item post process script) <= 4096 characters
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Scheme 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

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

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

filter_expr
string or null (Filter expression) <= 1000 characters
content_type
required
string (Content type)
required
Array of objects (CsvField)
required
Array of objects (EntityField)
Array of objects (CsvImportSchemeCalculatedInput)
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
mode
string (Mode)
Enum: "skip" "overwrite"
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Enum: "skip" "append"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
instrument_reference_column
string or null (Instrument reference column) <= 255 characters
item_post_process_script
string or null (Item post process script) <= 4096 characters
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Scheme 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

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

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

filter_expr
string or null (Filter expression) <= 1000 characters
content_type
required
string (Content type)
required
Array of objects (CsvField)
required
Array of objects (EntityField)
Array of objects (CsvImportSchemeCalculatedInput)
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
mode
string (Mode)
Enum: "skip" "overwrite"
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Enum: "skip" "append"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
instrument_reference_column
string or null (Instrument reference column) <= 255 characters
item_post_process_script
string or null (Item post process script) <= 4096 characters
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Scheme 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

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

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

filter_expr
string or null (Filter expression) <= 1000 characters
content_type
required
string (Content type)
required
Array of objects (CsvField)
required
Array of objects (EntityField)
Array of objects (CsvImportSchemeCalculatedInput)
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
mode
string (Mode)
Enum: "skip" "overwrite"
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Enum: "skip" "append"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
instrument_reference_column
string or null (Instrument reference column) <= 255 characters
item_post_process_script
string or null (Item post process script) <= 4096 characters
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

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

Scheme Read

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

A unique integer value identifying this csv import scheme.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Scheme Update

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

A unique integer value identifying this csv import scheme.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

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

filter_expr
string or null (Filter expression) <= 1000 characters
content_type
required
string (Content type)
required
Array of objects (CsvField)
required
Array of objects (EntityField)
Array of objects (CsvImportSchemeCalculatedInput)
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
mode
string (Mode)
Enum: "skip" "overwrite"
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Enum: "skip" "append"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
instrument_reference_column
string or null (Instrument reference column) <= 255 characters
item_post_process_script
string or null (Item post process script) <= 4096 characters
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Scheme Partial update

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

A unique integer value identifying this csv import scheme.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

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

filter_expr
string or null (Filter expression) <= 1000 characters
content_type
required
string (Content type)
required
Array of objects (CsvField)
required
Array of objects (EntityField)
Array of objects (CsvImportSchemeCalculatedInput)
spreadsheet_start_cell
string (Spreadsheet start cell) [ 1 .. 255 ] characters
spreadsheet_active_tab_name
string or null (Spreadsheet active tab name) <= 255 characters
mode
string (Mode)
Enum: "skip" "overwrite"
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
error_handler
string (Error handler)
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Enum: "skip" "append"
column_matcher
string (Column matcher) [ 1 .. 255 ] characters
Default: "index"
instrument_reference_column
string or null (Instrument reference column) <= 255 characters
item_post_process_script
string or null (Item post process script) <= 4096 characters
data_preprocess_expression
string or null (Data preprocess expression) <= 4096 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Scheme Delete

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

A unique integer value identifying this csv import scheme.

Responses

Scheme Delete preview

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

A unique integer value identifying this csv import scheme.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "filter_expr": "string",
  • "content_type": "string",
  • "csv_fields": [
    ],
  • "entity_fields": [
    ],
  • "calculated_inputs": [
    ],
  • "spreadsheet_start_cell": "string",
  • "spreadsheet_active_tab_name": "string",
  • "mode": "skip",
  • "delimiter": ",",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "column_matcher": "index",
  • "instrument_reference_column": "string",
  • "item_post_process_script": "string",
  • "data_preprocess_expression": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Currency Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this currency mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this currency mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this currency mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this currency mapping.

Responses

Delete preview

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

A unique integer value identifying this currency mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Daily Pricing Model Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (DailyPricingModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (DailyPricingModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (DailyPricingModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (DailyPricingModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (DailyPricingModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this daily pricing model mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this daily pricing model mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (DailyPricingModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this daily pricing model mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (DailyPricingModel)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this daily pricing model mapping.

Responses

Delete preview

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

A unique integer value identifying this daily pricing model mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Factor Schedule Download 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 factor schedule download method.

Responses

Response samples

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

Company

Company Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
company_id
required
string (Company id) non-empty
task
integer or null (Task)
result_id
integer or null (Result id)

Responses

Request samples

Content type
application/json
{
  • "company_id": "string",
  • "task": 0,
  • "result_id": 0
}

Response samples

Content type
application/json
{
  • "company_id": "string",
  • "task": 0,
  • "result_id": 0,
  • "errors": "string"
}

api

api_v1_import_finmars-database_company_callback_create

receive database info and update task

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
request_id
required
integer (Request id) >= 1
task_id
required
integer or null (Task id)
required
object or null (Data)

Responses

Request samples

Content type
application/json
{
  • "request_id": 1,
  • "task_id": 0,
  • "data": {
    }
}

api_v1_import_finmars-database_currency_callback_create

receive database info and update task

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
request_id
required
integer (Request id) >= 1
task_id
required
integer or null (Task id)
required
object or null (Data)

Responses

Request samples

Content type
application/json
{
  • "request_id": 1,
  • "task_id": 0,
  • "data": {
    }
}

api_v1_import_finmars-database_instrument_callback_create

receive database info and update task

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
request_id
required
integer (Request id) >= 1
task_id
required
integer or null (Task id)
required
object or null (Data)

Responses

Request samples

Content type
application/json
{
  • "request_id": 1,
  • "task_id": 0,
  • "data": {
    }
}

Currency

Currency Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
required
string (User code) non-empty
task
integer or null (Task)
result_id
integer or null (Result id)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "task": 0,
  • "result_id": 0
}

Response samples

Content type
application/json
{
  • "user_code": "string",
  • "task": 0,
  • "result_id": 0,
  • "errors": "string"
}

Instrument

Instrument Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
required
string (User code) non-empty
instrument_type_user_code
required
string (Instrument type user code) non-empty
task
integer or null (Task)
result_id
integer or null (Result id)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "instrument_type_user_code": "string",
  • "task": 0,
  • "result_id": 0
}

Response samples

Content type
application/json
{
  • "user_code": "string",
  • "instrument_type_user_code": "string",
  • "task": 0,
  • "result_id": 0,
  • "errors": "string"
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
instrument_download_scheme
required
integer (Instrument download scheme)
instrument_code
required
string (Instrument code) non-empty
task
integer or null (Task)
object (CeleryTask)
task_result_overrides
object or null (Task result overrides)
Default: {}
object (ImportInstrumentView)

Responses

Request samples

Content type
application/json
{
  • "instrument_download_scheme": 0,
  • "instrument_code": "string",
  • "task": 0,
  • "task_object": {
    },
  • "task_result_overrides": { },
  • "instrument": {
    }
}

Response samples

Content type
application/json
{
  • "instrument_download_scheme": 0,
  • "instrument_code": "string",
  • "task": 0,
  • "task_object": {
    },
  • "task_result": "string",
  • "task_result_overrides": { },
  • "errors": "string",
  • "instrument": {
    }
}

Instrument Attribute Value Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
value_string
string (Value (String)) <= 255 characters
value_float
number (Value (Float))
value_date
string <date> (Value (Date))
classifier
required
string or null (Classifier)
object (ProviderClass)
object (GenericAttributeTypeView)
object (GenericClassifierView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
value_string
string (Value (String)) <= 255 characters
value_float
number (Value (Float))
value_date
string <date> (Value (Date))
classifier
required
string or null (Classifier)
object (ProviderClass)
object (GenericAttributeTypeView)
object (GenericClassifierView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
value_string
string (Value (String)) <= 255 characters
value_float
number (Value (Float))
value_date
string <date> (Value (Date))
classifier
required
string or null (Classifier)
object (ProviderClass)
object (GenericAttributeTypeView)
object (GenericClassifierView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
value_string
string (Value (String)) <= 255 characters
value_float
number (Value (Float))
value_date
string <date> (Value (Date))
classifier
required
string or null (Classifier)
object (ProviderClass)
object (GenericAttributeTypeView)
object (GenericClassifierView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
value_string
string (Value (String)) <= 255 characters
value_float
number (Value (Float))
value_date
string <date> (Value (Date))
classifier
required
string or null (Classifier)
object (ProviderClass)
object (GenericAttributeTypeView)
object (GenericClassifierView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Read

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

A unique integer value identifying this instrument attribute value mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Update

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

A unique integer value identifying this instrument attribute value mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
value_string
string (Value (String)) <= 255 characters
value_float
number (Value (Float))
value_date
string <date> (Value (Date))
classifier
required
string or null (Classifier)
object (ProviderClass)
object (GenericAttributeTypeView)
object (GenericClassifierView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_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 attribute value mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
value_string
string (Value (String)) <= 255 characters
value_float
number (Value (Float))
value_date
string <date> (Value (Date))
classifier
required
string or null (Classifier)
object (ProviderClass)
object (GenericAttributeTypeView)
object (GenericClassifierView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Delete

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

A unique integer value identifying this instrument attribute value mapping.

Responses

Delete preview

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

A unique integer value identifying this instrument attribute value mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "value_string": "string",
  • "value_float": 0,
  • "value_date": "2019-08-24",
  • "classifier": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    },
  • "classifier_object": {
    }
}

Instrument Classifier Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this instrument classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this instrument classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_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 classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this instrument classifier mapping.

Responses

Delete preview

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

A unique integer value identifying this instrument classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Instrument Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this instrument mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this instrument mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_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 mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this instrument mapping.

Responses

Delete preview

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

A unique integer value identifying this instrument mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Instrument Scheme Light

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
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

provider
required
integer (Provider)
object (ProviderClass)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

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

provider
required
integer (Provider)
object (ProviderClass)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

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

provider
required
integer (Provider)
object (ProviderClass)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

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

provider
required
integer (Provider)
object (ProviderClass)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

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

provider
required
integer (Provider)
object (ProviderClass)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Read

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

A unique integer value identifying this instrument download scheme.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Update

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

A unique integer value identifying this instrument download scheme.

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

provider
required
integer (Provider)
object (ProviderClass)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_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 download scheme.

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

provider
required
integer (Provider)
object (ProviderClass)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Delete

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

A unique integer value identifying this instrument download scheme.

Responses

Delete preview

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

A unique integer value identifying this instrument download scheme.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "provider": 0,
  • "provider_object": {
    }
}

Instrument Scheme

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
mode
string (Mode)
Enum: "skip" "overwrite_empty_values" "overwrite"
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

provider
required
integer (Provider)
object (ProviderClass)
required
Array of objects (InstrumentDownloadSchemeInput)
reference_for_pricing
string (Reference for pricing) <= 255 characters
instrument_user_code
required
string (Instrument user code) <= 4096 characters
instrument_name
required
string (Instrument name) [ 1 .. 4096 ] characters
instrument_short_name
required
string (Instrument short name) <= 4096 characters
instrument_public_name
required
string (Instrument public name) <= 4096 characters
instrument_notes
required
string (Instrument notes) <= 4096 characters
instrument_type
required
string (Instrument type) <= 4096 characters
pricing_currency
required
string (Pricing currency) <= 4096 characters
price_multiplier
required
string (Price multiplier) <= 4096 characters
accrued_currency
required
string (Accrued currency) <= 4096 characters
accrued_multiplier
required
string (Accrued multiplier) <= 4096 characters
user_text_1
required
string (User text 1) <= 4096 characters
user_text_2
required
string (User text 2) <= 4096 characters
user_text_3
required
string (User text 3) <= 4096 characters
maturity_date
required
string (Maturity date) <= 4096 characters
maturity_price
required
string (Maturity price) <= 4096 characters
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
factor_schedule_method
integer or null (Factor schedule method)
object (FactorScheduleDownloadMethod)
accrual_calculation_schedule_method
integer or null (Accrual calculation schedule method)
object (AccrualScheduleDownloadMethod)
required
Array of objects (InstrumentDownloadSchemeAttribute)

Responses

Request samples

Content type
application/json
{
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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
mode
string (Mode)
Enum: "skip" "overwrite_empty_values" "overwrite"
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

provider
required
integer (Provider)
object (ProviderClass)
required
Array of objects (InstrumentDownloadSchemeInput)
reference_for_pricing
string (Reference for pricing) <= 255 characters
instrument_user_code
required
string (Instrument user code) <= 4096 characters
instrument_name
required
string (Instrument name) [ 1 .. 4096 ] characters
instrument_short_name
required
string (Instrument short name) <= 4096 characters
instrument_public_name
required
string (Instrument public name) <= 4096 characters
instrument_notes
required
string (Instrument notes) <= 4096 characters
instrument_type
required
string (Instrument type) <= 4096 characters
pricing_currency
required
string (Pricing currency) <= 4096 characters
price_multiplier
required
string (Price multiplier) <= 4096 characters
accrued_currency
required
string (Accrued currency) <= 4096 characters
accrued_multiplier
required
string (Accrued multiplier) <= 4096 characters
user_text_1
required
string (User text 1) <= 4096 characters
user_text_2
required
string (User text 2) <= 4096 characters
user_text_3
required
string (User text 3) <= 4096 characters
maturity_date
required
string (Maturity date) <= 4096 characters
maturity_price
required
string (Maturity price) <= 4096 characters
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
factor_schedule_method
integer or null (Factor schedule method)
object (FactorScheduleDownloadMethod)
accrual_calculation_schedule_method
integer or null (Accrual calculation schedule method)
object (AccrualScheduleDownloadMethod)
required
Array of objects (InstrumentDownloadSchemeAttribute)

Responses

Request samples

Content type
application/json
{
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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
mode
string (Mode)
Enum: "skip" "overwrite_empty_values" "overwrite"
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

provider
required
integer (Provider)
object (ProviderClass)
required
Array of objects (InstrumentDownloadSchemeInput)
reference_for_pricing
string (Reference for pricing) <= 255 characters
instrument_user_code
required
string (Instrument user code) <= 4096 characters
instrument_name
required
string (Instrument name) [ 1 .. 4096 ] characters
instrument_short_name
required
string (Instrument short name) <= 4096 characters
instrument_public_name
required
string (Instrument public name) <= 4096 characters
instrument_notes
required
string (Instrument notes) <= 4096 characters
instrument_type
required
string (Instrument type) <= 4096 characters
pricing_currency
required
string (Pricing currency) <= 4096 characters
price_multiplier
required
string (Price multiplier) <= 4096 characters
accrued_currency
required
string (Accrued currency) <= 4096 characters
accrued_multiplier
required
string (Accrued multiplier) <= 4096 characters
user_text_1
required
string (User text 1) <= 4096 characters
user_text_2
required
string (User text 2) <= 4096 characters
user_text_3
required
string (User text 3) <= 4096 characters
maturity_date
required
string (Maturity date) <= 4096 characters
maturity_price
required
string (Maturity price) <= 4096 characters
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
factor_schedule_method
integer or null (Factor schedule method)
object (FactorScheduleDownloadMethod)
accrual_calculation_schedule_method
integer or null (Accrual calculation schedule method)
object (AccrualScheduleDownloadMethod)
required
Array of objects (InstrumentDownloadSchemeAttribute)

Responses

Request samples

Content type
application/json
{
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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
mode
string (Mode)
Enum: "skip" "overwrite_empty_values" "overwrite"
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

provider
required
integer (Provider)
object (ProviderClass)
required
Array of objects (InstrumentDownloadSchemeInput)
reference_for_pricing
string (Reference for pricing) <= 255 characters
instrument_user_code
required
string (Instrument user code) <= 4096 characters
instrument_name
required
string (Instrument name) [ 1 .. 4096 ] characters
instrument_short_name
required
string (Instrument short name) <= 4096 characters
instrument_public_name
required
string (Instrument public name) <= 4096 characters
instrument_notes
required
string (Instrument notes) <= 4096 characters
instrument_type
required
string (Instrument type) <= 4096 characters
pricing_currency
required
string (Pricing currency) <= 4096 characters
price_multiplier
required
string (Price multiplier) <= 4096 characters
accrued_currency
required
string (Accrued currency) <= 4096 characters
accrued_multiplier
required
string (Accrued multiplier) <= 4096 characters
user_text_1
required
string (User text 1) <= 4096 characters
user_text_2
required
string (User text 2) <= 4096 characters
user_text_3
required
string (User text 3) <= 4096 characters
maturity_date
required
string (Maturity date) <= 4096 characters
maturity_price
required
string (Maturity price) <= 4096 characters
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
factor_schedule_method
integer or null (Factor schedule method)
object (FactorScheduleDownloadMethod)
accrual_calculation_schedule_method
integer or null (Accrual calculation schedule method)
object (AccrualScheduleDownloadMethod)
required
Array of objects (InstrumentDownloadSchemeAttribute)

Responses

Request samples

Content type
application/json
{
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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
mode
string (Mode)
Enum: "skip" "overwrite_empty_values" "overwrite"
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

provider
required
integer (Provider)
object (ProviderClass)
required
Array of objects (InstrumentDownloadSchemeInput)
reference_for_pricing
string (Reference for pricing) <= 255 characters
instrument_user_code
required
string (Instrument user code) <= 4096 characters
instrument_name
required
string (Instrument name) [ 1 .. 4096 ] characters
instrument_short_name
required
string (Instrument short name) <= 4096 characters
instrument_public_name
required
string (Instrument public name) <= 4096 characters
instrument_notes
required
string (Instrument notes) <= 4096 characters
instrument_type
required
string (Instrument type) <= 4096 characters
pricing_currency
required
string (Pricing currency) <= 4096 characters
price_multiplier
required
string (Price multiplier) <= 4096 characters
accrued_currency
required
string (Accrued currency) <= 4096 characters
accrued_multiplier
required
string (Accrued multiplier) <= 4096 characters
user_text_1
required
string (User text 1) <= 4096 characters
user_text_2
required
string (User text 2) <= 4096 characters
user_text_3
required
string (User text 3) <= 4096 characters
maturity_date
required
string (Maturity date) <= 4096 characters
maturity_price
required
string (Maturity price) <= 4096 characters
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
factor_schedule_method
integer or null (Factor schedule method)
object (FactorScheduleDownloadMethod)
accrual_calculation_schedule_method
integer or null (Accrual calculation schedule method)
object (AccrualScheduleDownloadMethod)
required
Array of objects (InstrumentDownloadSchemeAttribute)

Responses

Request samples

Content type
application/json
{
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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 instrument download scheme.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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 instrument download scheme.

Request Body schema: application/json
required
mode
string (Mode)
Enum: "skip" "overwrite_empty_values" "overwrite"
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

provider
required
integer (Provider)
object (ProviderClass)
required
Array of objects (InstrumentDownloadSchemeInput)
reference_for_pricing
string (Reference for pricing) <= 255 characters
instrument_user_code
required
string (Instrument user code) <= 4096 characters
instrument_name
required
string (Instrument name) [ 1 .. 4096 ] characters
instrument_short_name
required
string (Instrument short name) <= 4096 characters
instrument_public_name
required
string (Instrument public name) <= 4096 characters
instrument_notes
required
string (Instrument notes) <= 4096 characters
instrument_type
required
string (Instrument type) <= 4096 characters
pricing_currency
required
string (Pricing currency) <= 4096 characters
price_multiplier
required
string (Price multiplier) <= 4096 characters
accrued_currency
required
string (Accrued currency) <= 4096 characters
accrued_multiplier
required
string (Accrued multiplier) <= 4096 characters
user_text_1
required
string (User text 1) <= 4096 characters
user_text_2
required
string (User text 2) <= 4096 characters
user_text_3
required
string (User text 3) <= 4096 characters
maturity_date
required
string (Maturity date) <= 4096 characters
maturity_price
required
string (Maturity price) <= 4096 characters
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
factor_schedule_method
integer or null (Factor schedule method)
object (FactorScheduleDownloadMethod)
accrual_calculation_schedule_method
integer or null (Accrual calculation schedule method)
object (AccrualScheduleDownloadMethod)
required
Array of objects (InstrumentDownloadSchemeAttribute)

Responses

Request samples

Content type
application/json
{
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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 instrument download scheme.

Request Body schema: application/json
required
mode
string (Mode)
Enum: "skip" "overwrite_empty_values" "overwrite"
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

provider
required
integer (Provider)
object (ProviderClass)
required
Array of objects (InstrumentDownloadSchemeInput)
reference_for_pricing
string (Reference for pricing) <= 255 characters
instrument_user_code
required
string (Instrument user code) <= 4096 characters
instrument_name
required
string (Instrument name) [ 1 .. 4096 ] characters
instrument_short_name
required
string (Instrument short name) <= 4096 characters
instrument_public_name
required
string (Instrument public name) <= 4096 characters
instrument_notes
required
string (Instrument notes) <= 4096 characters
instrument_type
required
string (Instrument type) <= 4096 characters
pricing_currency
required
string (Pricing currency) <= 4096 characters
price_multiplier
required
string (Price multiplier) <= 4096 characters
accrued_currency
required
string (Accrued currency) <= 4096 characters
accrued_multiplier
required
string (Accrued multiplier) <= 4096 characters
user_text_1
required
string (User text 1) <= 4096 characters
user_text_2
required
string (User text 2) <= 4096 characters
user_text_3
required
string (User text 3) <= 4096 characters
maturity_date
required
string (Maturity date) <= 4096 characters
maturity_price
required
string (Maturity price) <= 4096 characters
payment_size_detail
integer or null (Payment size detail)
object (PaymentSizeDetail)
default_price
number (Default price)
default_accrued
number (Default accrued)
factor_schedule_method
integer or null (Factor schedule method)
object (FactorScheduleDownloadMethod)
accrual_calculation_schedule_method
integer or null (Accrual calculation schedule method)
object (AccrualScheduleDownloadMethod)
required
Array of objects (InstrumentDownloadSchemeAttribute)

Responses

Request samples

Content type
application/json
{
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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 instrument download scheme.

Responses

Delete preview

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

A unique integer value identifying this instrument download scheme.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mode": "skip",
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "provider": 0,
  • "provider_object": {
    },
  • "inputs": [
    ],
  • "reference_for_pricing": "string",
  • "instrument_user_code": "string",
  • "instrument_name": "string",
  • "instrument_short_name": "string",
  • "instrument_public_name": "string",
  • "instrument_notes": "string",
  • "instrument_type": "string",
  • "pricing_currency": "string",
  • "price_multiplier": "string",
  • "accrued_currency": "string",
  • "accrued_multiplier": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "maturity_date": "string",
  • "maturity_price": "string",
  • "payment_size_detail": 0,
  • "payment_size_detail_object": {
    },
  • "default_price": 0,
  • "default_accrued": 0,
  • "factor_schedule_method": 0,
  • "factor_schedule_method_object": {
    },
  • "accrual_calculation_schedule_method": 0,
  • "accrual_calculation_schedule_method_object": {
    },
  • "attributes": [
    ],
  • "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"
}

Instrument Type Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this instrument type mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this instrument type mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_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 type mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (InstrumentTypeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this instrument type mapping.

Responses

Delete preview

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

A unique integer value identifying this instrument type mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Mapping Table

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 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User Code) <= 1024 characters
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

configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
required
Array of objects (MappingTableKeyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

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

Human Readable Name of the object

user_code
string or null (User Code) <= 1024 characters
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

configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
required
Array of objects (MappingTableKeyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

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

Human Readable Name of the object

user_code
string or null (User Code) <= 1024 characters
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

configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
required
Array of objects (MappingTableKeyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

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

Human Readable Name of the object

user_code
string or null (User Code) <= 1024 characters
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

configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
required
Array of objects (MappingTableKeyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

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

Human Readable Name of the object

user_code
string or null (User Code) <= 1024 characters
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

configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
required
Array of objects (MappingTableKeyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Read

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

A unique integer value identifying this mapping table.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Update

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

A unique integer value identifying this mapping table.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User Code) <= 1024 characters
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

configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
required
Array of objects (MappingTableKeyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Partial update

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

A unique integer value identifying this mapping table.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User Code) <= 1024 characters
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

configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
required
Array of objects (MappingTableKeyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Delete

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

A unique integer value identifying this mapping table.

Responses

Delete preview

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

A unique integer value identifying this mapping table.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "short_name": "string",
  • "notes": "string",
  • "configuration_code": "string",
  • "items": [
    ]
}

Payment Size Detail Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PaymentSizeDetail)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PaymentSizeDetail)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PaymentSizeDetail)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PaymentSizeDetail)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PaymentSizeDetail)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this payment size detail mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this payment size detail mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PaymentSizeDetail)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this payment size detail mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PaymentSizeDetail)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this payment size detail mapping.

Responses

Delete preview

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

A unique integer value identifying this payment size detail mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Periodicity Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (Periodicity)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (Periodicity)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (Periodicity)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (Periodicity)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (Periodicity)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this periodicity mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this periodicity mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (Periodicity)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this periodicity mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (Periodicity)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this periodicity mapping.

Responses

Delete preview

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

A unique integer value identifying this periodicity mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Portfolio Classifier Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this portfolio classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this portfolio classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this portfolio classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this portfolio classifier mapping.

Responses

Delete preview

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

A unique integer value identifying this portfolio classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Portfolio Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PortfolioView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PortfolioView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PortfolioView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PortfolioView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PortfolioView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this portfolio mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this portfolio mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PortfolioView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this portfolio mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PortfolioView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this portfolio mapping.

Responses

Delete preview

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

A unique integer value identifying this portfolio mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Price Download Scheme Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PriceDownloadSchemeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PriceDownloadSchemeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PriceDownloadSchemeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PriceDownloadSchemeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PriceDownloadSchemeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this price download scheme mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this price download scheme mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PriceDownloadSchemeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this price download scheme mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PriceDownloadSchemeView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this price download scheme mapping.

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 download scheme mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Pricing Condition Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PricingCondition)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PricingCondition)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PricingCondition)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PricingCondition)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PricingCondition)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this pricing condition mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this pricing condition mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PricingCondition)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this pricing condition mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
integer (Content object)
object (ProviderClass)
object (PricingCondition)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this pricing condition mapping.

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

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": 0,
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Pricing Policy Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PricingPolicyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PricingPolicyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PricingPolicyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PricingPolicyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PricingPolicyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this pricing policy mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this pricing policy mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PricingPolicyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

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

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (PricingPolicyView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this pricing policy mapping.

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

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Provider

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

Responses

Response samples

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

Responsible Classifier Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this responsible classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this responsible classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this responsible classifier mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
attribute_type
required
string (Attribute type)
content_object
required
string (Content object)
object (ProviderClass)
object (GenericAttributeType)
object or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this responsible classifier mapping.

Responses

Delete preview

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

A unique integer value identifying this responsible classifier mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "attribute_type": "string",
  • "content_object": "string",
  • "provider_object": {
    },
  • "attribute_type_object": {
    },
  • "content_object_object": {
    }
}

Responsible Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (ResponsibleView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (ResponsibleView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (ResponsibleView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (ResponsibleView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (ResponsibleView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this responsible mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this responsible mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (ResponsibleView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this responsible mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (ResponsibleView)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this responsible mapping.

Responses

Delete preview

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

A unique integer value identifying this responsible mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Simple Import

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
quotechar
string (Quotechar) = 1 characters
Default: "\""
encoding
string (Encoding) [ 1 .. 20 ] characters
Default: "utf-8-sig"
error_handler
string (Error handler)
Default: "continue"
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Default: "throw_error"
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Default: "skip"
Enum: "skip" "append"
mode
string (Mode)
Default: "skip"
Enum: "skip" "overwrite"
object (CsvImportScheme)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "scheme_object": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "file": "http://example.com",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "stats": "string",
  • "stats_file_report": "string",
  • "imported": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "scheme_object": {
    }
}

Execute

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)
delimiter
string (Delimiter) [ 1 .. 3 ] characters
Default: ","
quotechar
string (Quotechar) = 1 characters
Default: "\""
encoding
string (Encoding) [ 1 .. 20 ] characters
Default: "utf-8-sig"
error_handler
string (Error handler)
Default: "continue"
Enum: "break" "continue"
missing_data_handler
string (Missing data handler)
Default: "throw_error"
Enum: "throw_error" "set_defaults"
classifier_handler
string (Classifier handler)
Default: "skip"
Enum: "skip" "append"
mode
string (Mode)
Default: "skip"
Enum: "skip" "overwrite"
object (CsvImportScheme)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "scheme_object": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "file": "http://example.com",
  • "scheme": 0,
  • "delimiter": ",",
  • "quotechar": "\"",
  • "encoding": "utf-8-sig",
  • "error_handler": "break",
  • "missing_data_handler": "throw_error",
  • "classifier_handler": "skip",
  • "mode": "skip",
  • "stats": "string",
  • "stats_file_report": "string",
  • "imported": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "scheme_object": {
    }
}

Strategy1 Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy1View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy1View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy1View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy1View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy1View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this strategy1 mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this strategy1 mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy1View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this strategy1 mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy1View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this strategy1 mapping.

Responses

Delete preview

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

A unique integer value identifying this strategy1 mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Strategy2 Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy2View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy2View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy2View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy2View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy2View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this strategy2 mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this strategy2 mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy2View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this strategy2 mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy2View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this strategy2 mapping.

Responses

Delete preview

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

A unique integer value identifying this strategy2 mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Strategy3 Mapping

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
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy3View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy3View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy3View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy3View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy3View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Read

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

A unique integer value identifying this strategy3 mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Update

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

A unique integer value identifying this strategy3 mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy3View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Partial update

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

A unique integer value identifying this strategy3 mapping.

Request Body schema: application/json
required
provider
required
integer (Provider)
value
string (Value) <= 255 characters
Default: ""
content_object
required
string (Content object)
object (ProviderClass)
object (Strategy3View)

Responses

Request samples

Content type
application/json
{
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Delete

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

A unique integer value identifying this strategy3 mapping.

Responses

Delete preview

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

A unique integer value identifying this strategy3 mapping.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "provider": 0,
  • "value": "",
  • "content_object": "string",
  • "provider_object": {
    },
  • "content_object_object": {
    }
}

Test Certificate

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task
integer or null (Task)
object (CeleryTask)

Responses

Request samples

Content type
application/json
{
  • "task": 0,
  • "task_object": {
    }
}

Response samples

Content type
application/json
{
  • "task": 0,
  • "task_object": {
    },
  • "provider_id": "string"
}

Transaction Import

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "file": "http://example.com",
  • "stats_file_report": "string",
  • "task_status": "string"
}

Dry run

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "file": "http://example.com",
  • "stats_file_report": "string",
  • "task_status": "string"
}

Execute

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
task_id
string or null (Task id)
scheme
integer (Scheme)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "scheme": 0,
  • "file": "http://example.com",
  • "stats_file_report": "string",
  • "task_status": "string"
}

Unified Data Provide

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
id
required
string (Id) non-empty
entity_type
required
string (Entity type) non-empty
task
integer or null (Task)
result_id
integer or null (Result id)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "entity_type": "string",
  • "task": 0,
  • "result_id": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity_type": "string",
  • "task": 0,
  • "result_id": 0,
  • "errors": "string"
}