Aux Data API

Fetch Aux Data Keys for a Locator
getAuxDataKeys
GET /auxdata/{tenantLocator}/auxdata/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:auxdata   Permissions:read,list
AuxDataKeySetResponse
required
count int
offset int
keys AuxDataKey[]
AuxDataKey
required
key string
uiType Enum normal | hidden | readonly

optional
auxDataSettingsName string?
Fetch Aux Data
getAuxData
GET /auxdata/{tenantLocator}/auxdata/{locator}/{key}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    keypathstringrequired
    Security Group:auxdata   Permission:read
AuxDataResponse
required
locator string
key string
modificationTimestamp datetime
uiType Enum normal | hidden | readonly
value string

optional
auxDataSettingsName string?
expirationTimestamp datetime?
Add Aux Data
putAuxData
PUT /auxdata/{tenantLocator}/auxdata/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:void
    Security Group:auxdata   Permission:write
AuxDataSetCreateRequest
required
auxData AuxDataSet[]

optional
auxDataSettingsName string?
AuxDataSet
required
key string
uiType Enum normal | hidden | readonly
value string
Delete Aux Data
deleteAuxData
DELETE /auxdata/{tenantLocator}/auxdata/{locator}/{key}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    keypathstringrequired
    Response:void
    Security Group:auxdata   Permission:write
Get the Size of Aux Data for a Tenant
getAuxDataSize
GET /auxdata/{tenantLocator}/auxdata/size
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Security Group:auxdata   Permission:read
AuxDataSizeResponse
required
dataSizeKb int