Aux Data API
| Action | Endpoint |
|---|---|
| Fetch Aux Data Keys for a Locator | GET/auxdata/{tenantLocator}/auxdata/{locator} |
| Fetch Aux Data | GET/auxdata/{tenantLocator}/auxdata/{locator}/{key} |
| Add Aux Data | PUT/auxdata/{tenantLocator}/auxdata/{locator} |
| Delete Aux Data | DELETE/auxdata/{tenantLocator}/auxdata/{locator}/{key} |
| Get the Size of Aux Data for a Tenant | GET/auxdata/{tenantLocator}/auxdata/size |
Fetch Aux Data Keys for a Locator
Fetch Aux Data Keys for a Locator
getAuxDataKeysGET
/auxdata/{tenantLocator}/auxdata/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | string | Yes | |
offset | query | integer? | No | |
count | query | integer? | No |
Response:
AuxDataKeySetResponseSecurity Group:
auxdataPermissions:
read,listAuxDataKeySetResponse
Required properties
| Property | Type | Description |
|---|---|---|
count | integer | |
offset | integer | |
keys | AuxDataKey[] |
AuxDataKey
Required properties
| Property | Type | Description |
|---|---|---|
key | string | |
uiType | Enum normal | hidden | readonly |
Optional properties
| Property | Type | Description |
|---|---|---|
auxDataSettingsName | string? |
Fetch Aux Data
Fetch Aux Data
getAuxDataGET
/auxdata/{tenantLocator}/auxdata/{locator}/{key}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | string | Yes | |
key | path | string | Yes |
Response:
AuxDataResponseSecurity Group:
auxdataPermission:
readAuxDataResponse
Required properties
| Property | Type | Description |
|---|---|---|
locator | string | |
key | string | |
modificationTimestamp | datetime | |
uiType | Enum normal | hidden | readonly | |
value | string |
Optional properties
| Property | Type | Description |
|---|---|---|
auxDataSettingsName | string? | |
expirationTimestamp | datetime? |
Add Aux Data
Add Aux Data
putAuxDataPUT
/auxdata/{tenantLocator}/auxdata/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | string | Yes |
AuxDataSetCreateRequest
Required properties
| Property | Type | Description |
|---|---|---|
auxData | AuxDataSet[] |
Optional properties
| Property | Type | Description |
|---|---|---|
auxDataSettingsName | string? |
AuxDataSet
Required properties
| Property | Type | Description |
|---|---|---|
key | string | |
uiType | Enum normal | hidden | readonly | |
value | string |
Delete Aux Data
Delete Aux Data
deleteAuxDataDELETE
/auxdata/{tenantLocator}/auxdata/{locator}/{key}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | string | Yes | |
key | path | string | Yes |
Response:
voidSecurity Group:
auxdataPermission:
writeGet the Size of Aux Data for a Tenant
Get the Size of Aux Data for a Tenant
getAuxDataSizeGET
/auxdata/{tenantLocator}/auxdata/sizeParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Response:
AuxDataSizeResponseSecurity Group:
auxdataPermission:
readAuxDataSizeResponse
Required properties
| Property | Type | Description |
|---|---|---|
dataSizeKb | integer |