Auxiliary Data
Endpoint Index
| Action | Endpoint |
|---|---|
| Set or update an auxiliary data record set | PUT /auxData/{locator} |
| Retrieve a single auxiliary data record | GET /auxData/{locator}/{key} |
| Fetch a set of auxiliary data record keys | GET /auxData/{locator} |
| Delete an auxiliary data record | DELETE /auxData/{locator}/{key} |
Note
See the Auxiliary Data Feature Guide for details on using these endpoints.
Details
Set or update an auxiliary data record set¶
PUT /auxData/{locator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| dataSet | body | AuxDataSetCreateRequest | required |
| locator | path | string | required |
Response:
voidRetrieve a single auxiliary data record¶
GET /auxData/{locator}/{key}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| key | path | string | required |
| locator | path | string | required |
Response:
AuxDataResponseFetch a set of auxiliary data record keys¶
GET /auxData/{locator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
| page | query | integer | required |
Response:
AuxDataKeySetResponseDelete an auxiliary data record¶
DELETE /auxData/{locator}/{key}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| key | path | string | required |
| locator | path | string | required |
Response:
voidAuxDataSetCreateRequest¶
requiredauxData [AuxDataCreateRequest]
AuxDataCreateRequest¶
requiredkey stringoptionalvalue stringuiType string normal | hidden | readonly
AuxDataKeySetResponse¶
requiredkeys [AuxDataKeyResponse]page integer
AuxDataKeyResponse¶
requiredkey stringuiType string normal | hidden | readonly
AuxDataResponse¶
requiredlocator stringkey stringvalue stringuiType string normal | hidden | readonly