Attribute Values

Supported HTTP VERB(s)

POST:

Request:

/removeAttributeValues

Given attribute name and list of attribute value codes deletes its attribute values.

Sample Request URI:

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAttributeValues

or

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAttributeValues?doValidateOnly=true&&showWarnings=true

Sample Request Header:

Authorization: Basic

Content-Type: application/json

Sample Request Body

Sample POST Request

[ { "attributeName":"tax code", "attributeValueCodes":[ "TT-TRE", "test-67" ] }, { "attributeName":"AP Eligible", "attributeValueCodes":[ "Yes", "No" ] }, { "attributeName":"test-2", "attributeValueCodes":[ "test-22", "test-21", "test-5" ] }, { "attributeName":"test-3", "attributeValueCodes":[ "test-22", "test-21", "test-5" ] } ]

Payload Parameters

Name	Description	Required
attributeName	Attribute name.	Y
attributeValueCodes	List of all attribute value codes to delete.	Y

Path Parameter

Name	Description	Required
tenant	Tenant to operate on. e.g. globosales	Y

Query Parameters

Name	Description	Required	Default
doValidateOnly	Process the request in the validate mode which means no db persistence of the changes.	N	false
showWarnings	List of Warnings behind any dimension value ignored /skipped from deletion.	N	false

Sample Response:

200 OK

Successful response.

{ "total": 5 }

Successful response with warnings.

{ "total":5, "warning":{ "info":"Some attribute values were not deleted.", "warnings":[ { "field":"TEST-67", "warning":"Attribute value isn't available for deletion." }, { "field":"TEST-21", "warning":"Attribute value isn't available for deletion." }, { "field":"TEST-22", "warning":"Attribute value isn't available for deletion." }, { "field":"TEST-5", "warning":"Attribute value isn't available for deletion." } ] } }

400 Bad Request

The request could not be understood by the server.

401 Unauthorized

User is not authorized.

403 Forbidden

User has insufficient permissions.

500 Internal Server Error

Internal Server Error.