Skip to main content
Documentation
Documentation
Adaptive Planning
Last Updated: 2023-06-23
Sheet Availability

Sheet Availability

URL Endpoint

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
Version: v1
Category
Metadata Modification
Description
Retrieve or update dimension or attribute value availability for a given sheet and column.
Permissions Required to Invoke
Model Management Access
Model includes: sheets, accounts, dimensions, and formulas
Parameters Required on Request
sheetName, columnName

Supported HTTP VERB(s)

HTTP Verb
Single Resource
Collection Resource
Description
GET
Not Supported
Supported
Retrieve the availability of all values for a given sheet and column.
POST
Not Supported
Supported
Update the availability of values for a given sheet and column.
OPTIONS
Supported
Supported
Returns the list of HTTP verbs supported for this collection resource.

GET:

Request:
/sheet/availability:
Retrieves a collection of value availability.
Retrieves availability of all values in a sheet dimension. You can filter by instanceCode, sheetName and columnName.
Sample Request URI:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Sample Request Header:
Accept-Language: en
Sample Request Body
Query Parameters
Name
Description
Required
sheetName
The name of the sheet to retrieve availability values from.
Y
columnName
The name of the sheet column to retrieve availability values from. Required for cube sheets only.
Only columns where the value availability can be modified are supported.
For cube sheet account and level columns, the name of the column respects the locale set in the Accept-Language header.
Y
columnCode
The code of the sheet column to retrieve availability values from. Required for modeled sheets only.
Only columns where the value availability can be modified are supported.
Y
columnType
The type of column for the given columnName or columnCode.
Acceptable values: account, level, dimension, attribute
Y
instanceCode
The instanceCode to retrieve values from. For example, GLOBO. If no instanceCode is specified, the default instance of the user is used.
N
limit
The maximum number of objects in a single response.
N
offset
The zero-based index of the first object in a response collection. The default is 0.
Use offset with the limit parameter to control paging of a response collection.
N
Sample Response
200
Successful response.
Sample Response
 
{
    "data": [
        {
            "code": "Corporate Plan",
            "name": "Corporate Plan",
            "available": true
        },
        {
            "code": "Engineering",
            "name": "Engineering",
            "available": true
        },
        {
            "code": "Development",
            "name": "Development",
            "available": true
        },
        {
            "code": "Documentation",
            "name": "Documentation",
            "available": true
        },
        {
            "code": "QA",
            "name": "QA",
            "available": true
        },
        {
            "code": "2014-Development Organization",
            "name": "2014-Development Organization",
            "available": false
        },
        {
            "code": "Development-India",
            "name": "Development-India",
            "available": false
        },
        {
            "code": "QA-India",
            "name": "QA-India",
            "available": false
        },
        {
            "code": "G & A",
            "name": "G & A",
            "available": false
        },
        {
            "code": "Hosting",
            "name": "Hosting",
            "available": true
        },
        {
            "code": "Professional Services",
            "name": "Professional Services",
            "available": true
        },
        {
            "code": "Sales",
            "name": "Sales",
            "available": true
        },
        {
            "code": "Marketing",
            "name": "Marketing",
            "available": true
        },
        {
            "code": "US Sales",
            "name": "US Sales",
            "available": false
        },
        {
            "code": "Worldwide Sales",
            "name": "Worldwide Sales",
            "available": true
        },
        {
            "code": "Asia Sales",
            "name": "Asia Sales",
            "available": false
        },
        {
            "code": "Europe Sales",
            "name": "Europe Sales",
            "available": true
        },
        {
            "code": "Latin America Sales",
            "name": "Latin America Sales",
            "available": true
        }
    ],
    "total": 18
}

POST:

Request:
/sheet/availability:
Updates a collection of value availability.
Updates availability of all values in a sheet dimension.
Sample Request URI:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Sample Request Header:
Accept-Language: en
Request body:
JSON array of availability objects, matching the "data" property of the export. Each JSON object has the following structure:
Name
Description
Required
code
Code of the value. Used to uniquely identify values.
Y
name
Name of the value.
Y
accountGroup
Whether the value is an account group. Required for accounts.
N
available
Whether the value is available or not. If not present, no change is made.
N
deleteIfDataIsPresent
Whether to delete the data if present. Required when disabling a custom dimension value on cube sheets.
N
actionIfDataIsPresent
The action to take when data is present. Required when disabling a custom dimension value on modeled sheets.
N
Sample Request Body
Request Body
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
Query Parameters
Name
Description
Required
sheetName
The name of the sheet to retreive availability values from.
Y
columnName
the name of the sheet column to retrieve availability values from. Required for cube sheets only.
Only columns where the value availability can be modified are supported.
For cube sheet account and level columns, the name of the column respects the locale set in the Accept-Language header.
Y
columnCode
The code of the sheet column to retrieve availability from. Required for modeled sheets only.
Only columns where the value availability can be modified are supported.
Y
columnType
The type of column for the given columnName or columnCode.
Acceptable values: account, level, dimension, attribute.
Y
instanceCode
The instanceCode to retrieve values from. For example, GLOBO. If no instanceCode is specified, the default insantce of the user is used.
N
Sample Response:
204
Successful response is blank with status code 204.