Permissions, published limits, the amount contract and the account/currency bindings
GET
/v1/entities/{entity_id}/capabilities
const url = 'https://example.com/v1/entities/example/capabilities';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/entities/example/capabilitiesParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”entity_id
required
Entity Id
The entity this path is relative to
string
The entity this path is relative to
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
Capabilities
object
entity_id
required
Entity Id
string
legal_name
required
Legal Name
string
base_currency
required
Base Currency
string
snapshot_seq
required
Snapshot Seq
integer
actor_recorded_as
required
Actor Recorded As
string
entities_in_scope
required
Entities In Scope
Array<string>
reads
required
Reads
Array<string>
writes
required
Writes
Array<string>
commands
required
Commands
The named write commands this installation serves: the command’s name, its verb and its path. The name is the same string as the OpenAPI operationId and the application handler
Array<object>
object
key
additional properties
string
service_reads
required
Service Reads
The /v1 reads that are not relative to an entity, as absolute paths
Array<string>
service_commands
required
Service Commands
The named write commands that are not relative to an entity, as absolute paths. initialize_entity is here: a book has to exist before there is an entity to address
Array<object>
object
key
additional properties
string
limits
required
Limits
object
default_limit
required
Default Limit
integer
max_limit
required
Max Limit
integer
event_default_limit
required
Event Default Limit
integer
event_max_limit
required
Event Max Limit
integer
max_entry_legs
required
Max Entry Legs
integer
max_batch_entries
required
Max Batch Entries
integer
amount_contract
required
Amount Contract
object
key
additional properties
string
commodities
required
Commodities
Array<object>
object
key
additional properties
any
account_commodities
required
Account Commodities
Array<object>
object
key
additional properties
string
idempotency
required
Idempotency
object
key
additional properties
any
pagination
required
Pagination
object
key
additional properties
any
dates
required
Dates
object
key
additional properties
string
Example generated
{ "entity_id": "example", "legal_name": "example", "base_currency": "example", "snapshot_seq": 1, "actor_recorded_as": "example", "entities_in_scope": [ "example" ], "reads": [ "example" ], "writes": [ "example" ], "commands": [ { "additionalProperty": "example" } ], "service_reads": [ "example" ], "service_commands": [ { "additionalProperty": "example" } ], "limits": { "default_limit": 1, "max_limit": 1, "event_default_limit": 1, "event_max_limit": 1, "max_entry_legs": 1, "max_batch_entries": 1 }, "amount_contract": { "additionalProperty": "example" }, "commodities": [ {} ], "account_commodities": [ { "additionalProperty": "example" } ], "idempotency": {}, "pagination": {}, "dates": { "additionalProperty": "example" }}Bad Request
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}