Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Extra Value (Custom Field)

Get Extra Values by Entity Type and ID

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

get/v3/{entityType}/{entityId}/extras

Path parameters

entityTypestring required

The Back Office entity type.

entityIdinteger required

The unique identifier for the Back Office entity.

The identifier for the entity.

Headers

FrontOfficeTenantIdinteger required

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

RequestIdstring uuid required

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

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

RequestOriginstring required

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

ExternalIdSource'BOLD' required
Example:BOLD

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

RequestUserExternalIdstring
Example:ABC123

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.

Response

Successfully retrieved extra values.

extraValueIdinteger nullable

The unique identifier for the Extra row in the Back Office database, formatted as an integer.

optionIdinteger nullable

The unqiue identifier for the Custom Setup Option Row that relates to the current extra row.

optionNamestring

The display name of the Extra value setup option.

categorystring

The category for the current Extra, as defined in the accompanying custom setup option property value.

valuestring

The actual value of the Extra, formatted as a string.