Get Extra Values by Entity Type and ID

get

https://api.avionte.com/bo-prod/v3/{entityType}/{entityId}/extras

Returns the extra values (custom fields) for a given entity by Entity Type and ID.

Path Params

entityType

string

required

The Back Office entity type.

entityId

integer

required

The identifier for the entity.

Headers

FrontOfficeTenantId

integer

required

An integer identifier for the tenant that the request is being made for.

RequestId

uuid

required

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

RequestOrigin

string

required

length between 1 and 100

The string source name (such as application or function name) that indicates the origin of the request.

ExternalIdSource

string

enum

required

The external ID source that determines which external reference source is used to perform an external ID lookup.

Allowed:

RequestUserExternalId

string

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Responses

405

Unsupported method

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved extra values.

402Additional subscription required.

403Access Denied

404Not found