Ir para o conteúdo principal
Documentação
Documentação
Adaptive Planning
Última atualização: 2023-06-23
Disponibilidade de planilha

Disponibilidade de planilha

Ponto de extremidade de URL

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
Versão: v1
Categoria
Modificação de metadados
Descrição
Recuperar ou atualizar a disponibilidade do valor de dimensão ou atributo para uma determinada planilha e coluna.
Permissões obrigatórias para invocar
Acesso a gerenciamento de modelos
O modelo inclui: planilhas, contas, dimensões e fórmulas
Parâmetros obrigatórios na solicitação
sheetName, columnName

VERBOS HTTP com suporte

Verbo HTTP
Recurso único
Recurso de cobrança
Descrição
GET
Sem suporte
Com suporte
Recupere a disponibilidade de todos os valores de uma determinada planilha e coluna.
POST
Sem suporte
Com suporte
Atualize a disponibilidade de valores para uma determinada planilha e coluna.
OPÇÕES
Com suporte
Com suporte
Retorna a lista de verbos HTTP com suporte para este recurso de coleção.

GET:

Solicitação:
/sheet/availability:
Recupera uma coleção de disponibilidade de valores.
Recupera a disponibilidade de todos os valores em uma dimensão da planilha. Você pode filtrar por instanceCode, sheetName e columnName.
Exemplo de URI de solicitação:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Cabeçalho de solicitação de amostra:
Accept-Language: en
Corpo da solicitação de amostra
Parâmetros de consulta
Nome
Descrição
Obrigatório
sheetName
O nome da planilha da qual recuperar os valores de disponibilidade.
S
columnName
O nome da coluna da planilha da qual recuperar os valores de disponibilidade. Obrigatório apenas para planilhas de cubo.
Somente colunas em que o valor de disponibilidade pode ser modificado têm suporte.
Para colunas de nível e de conta da planilha de cubo, o nome da coluna respeita os parâmetros regionais definidos no cabeçalho Accept-Language.
S
columnCode
O código da coluna da planilha do qual recuperar os valores de disponibilidade. Obrigatório apenas para planilhas modeladas.
Somente colunas em que o valor de disponibilidade pode ser modificado têm suporte.
S
columnType
O tipo de coluna para um determinado columnName ou columnCode.
Valores aceitáveis: conta, nível, dimensão, atributo
S
instanceCode
O instanceCode do qual recuperar valores. Por exemplo, GLOBO. Se nenhum instanceCode é especificado, a instância por padrão do usuário é usada.
N
limit
O número máximo de objetos em uma única resposta.
N
offset
O índice de base zero do primeiro objeto em uma coleção de respostas. O valor por padrão é 0.
Use o deslocamento com o parâmetro de limite para controlar a paginação de uma coleção de respostas.
N
Exemplo de resposta
200
Resposta bem-sucedida.
Exemplo de resposta
 
{
    "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
}

PUBLICAR:

Solicitação:
/sheet/availability:
Atualiza uma coleção de valores de disponibilidade.
Atualiza a disponibilidade de todos os valores em uma dimensão da planilha.
Exemplo de URI de solicitação:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Cabeçalho de solicitação de amostra:
Accept-Language: en
Corpo da solicitação:
Matriz JSON de objetos de disponibilidade, correspondendo à propriedade "data" da exportação. Cada objeto JSON tem a seguinte estrutura:
Nome
Descrição
Obrigatório
código
Código do valor. Usado para identificar valores de forma exclusiva.
S
nome
Nome do valor.
S
accountGroup
Se o valor é um grupo de contas. Obrigatório para contas.
N
disponível
Se o valor está disponível ou não. Se não estiver presente, nenhuma alteração será feita.
N
deleteIfDataIsPresent
Se os dados devem ser excluídos, se presentes. Obrigatório ao desabilitar um valor de dimensão personalizada em planilhas de cubo.
N
actionIfDataIsPresent
A ação a ser executada quando os dados estão presentes. Obrigatório ao desabilitar um valor de dimensão personalizada em planilhas modeladas.
N
Corpo da solicitação de amostra
Corpo da solicitação
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
Parâmetros de consulta
Nome
Descrição
Obrigatório
sheetName
O nome da planilha da qual recuperar os valores de disponibilidade.
S
columnName
o nome da coluna da planilha da qual recuperar os valores de disponibilidade. Obrigatório apenas para planilhas de cubo.
Somente colunas em que o valor de disponibilidade pode ser modificado têm suporte.
Para colunas de nível e de conta da planilha de cubo, o nome da coluna respeita os parâmetros regionais definidos no cabeçalho Accept-Language.
S
columnCode
O código da coluna da planilha do qual recuperar a disponibilidade. Obrigatório apenas para planilhas modeladas.
Somente colunas em que o valor de disponibilidade pode ser modificado têm suporte.
S
columnType
O tipo de coluna para um determinado columnName ou columnCode.
Valores aceitáveis: conta, nível, dimensão, atributo.
S
instanceCode
O instanceCode do qual recuperar valores. Por exemplo, GLOBO. Se nenhum instanceCode é especificado, a instância por padrão do usuário é usada.
N
Exemplo de resposta:
204
A resposta bem-sucedida está em branco com o código de status 204.