Levels

Supported HTTP VERB(s)

POST

Request:

/removeLevels

Deletes the levels for the given level codes.

Sample Request URI:

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/removeLevels

or

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/removeLevels?forceRemove=false&&doValidateOnly=true&&showWarnings=true

Sample Request Header:

Authorization: Basic

Content-Type: application/json

Sample Request Body

Sample POST Request

{ "levelCodesToDelete": ["testLevel", "HQ"] }

Payload Parameters

Name	Description	Required
levelCodesToDelete	Level Codes to be deleted name.	Y

Path Parameter

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

Query Parameters

Name	Description	Required	Default
forceRemove	Deletes in-use accounts when forceRemove=true and ignores in-use accounts when forceRemove=false Default is always forceRemove=false	N
instanceCode	The instanceCode to retrieve values from. For example, GLOBO. If no instanceCode is specified, the default insantce of the user is used.	N
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": 1
}

Successful response with warnings

{
    "total": 0,
    "warning": {
        "info": "Some levels were not deleted.",
        "warnings": [
            {
                "field": "HQ",
                "warning": "Default Root Plans 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.