Auxiliary Data API

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.

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: void

Retrieve a single auxiliary data record¶

GET /auxData/{locator}/{key}

Request:

Name	Position	Type	Required
key	path	string	required
locator	path	string	required

Response: AuxDataResponse

Fetch a set of auxiliary data record keys¶

GET /auxData/{locator}

Request:

Name	Position	Type	Required
locator	path	string	required
page	query	integer	required

Response: AuxDataKeySetResponse

Delete an auxiliary data record¶

DELETE /auxData/{locator}/{key}

Request:

Name	Position	Type	Required
key	path	string	required
locator	path	string	required

Response: void

AuxDataSetCreateRequest¶

required
auxData [AuxDataCreateRequest]

AuxDataCreateRequest¶

required
key string

optional
value string
uiType string normal | hidden | readonly

AuxDataKeySetResponse¶

required
keys [AuxDataKeyResponse]
page integer

AuxDataKeyResponse¶

required
key string
uiType string normal | hidden | readonly

AuxDataResponse¶

required
locator string
key string
value string
uiType string normal | hidden | readonly