Dimension Values

Supported HTTP VERB(s)

POST:

Request:

/removeDimensionValues

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

Sample Request URI:

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

or

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

Sample Request Header:

Authorization: Basic

Content-Type: application/json

Sample Request Body

Sample POST Request

[ { "dimensionName": "Dim1", "dimensionValueCodes": [ "dimensionValueCode100" ] }, { "dimensionName": "Dim2", "dimensionValueCodes": [ "dimensionValueCode102", "dimensionValueCode103" ] }, { "dimensionName": "Dim3", "dimensionValueCodes": [ "dimensionValueCode104", "dimensionValueCode105", "dimensionValueCode106", "dimensionValueCode107" "dimensionValueCode108", "dimensionValueCode109" ] } ]

Payload Parameters

Name	Description	Required
dimensionName	Dimension name.	Y
dimensionValueCodes	List of all dimension 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 dimension values were not deleted.", "warnings": [ { "field": "TEST-67", "warning": "Dimension value isn't available for deletion." }, { "field": "TEST-5", "warning": "In-use dimension values cannot be deleted." } ] } }

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.