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

Valores de dimensão

Versão: v1

VERBOS HTTP com suporte

Verbo HTTP
Descrição
POST
Excluir todos os valores de dimensão não utilizados existentes (os valores de dimensão em uso serão ignorados).

PUBLICAR:

Solicitação:
/removeDimensionValues
Um determinado nome de dimensão e uma lista de códigos de valor de dimensão exclui os valores de dimensão.
Exemplo de URI de solicitação:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues
ou
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues?doValidateOnly=true&&showWarnings=true
Cabeçalho de solicitação de amostra:
Autorização: básica
Content-Type: application/json
Corpo da solicitação de amostra
Exemplo de solicitação POST
 
[
    {
        "dimensionName": "Dim1",
        "dimensionValueCodes": [
            "dimensionValueCode100"
        ]
    },
    {
        "dimensionName": "Dim2",
        "dimensionValueCodes": [
            "dimensionValueCode102",
            "dimensionValueCode103"
        ]
    },
    {
        "dimensionName": "Dim3",
        "dimensionValueCodes": [
            "dimensionValueCode104",
            "dimensionValueCode105",
            "dimensionValueCode106",
            "dimensionValueCode107"
            "dimensionValueCode108",
            "dimensionValueCode109"
        ]
    }
]
Parâmetros de carga
Nome
Descrição
Obrigatório
dimensionName
Nome da dimensão
S
dimensionValueCodes
Lista de todos os códigos de valor de dimensão a serem excluídos.
S
Parâmetro de caminho
Nome
Descrição
Obrigatório
tenant
Locatário no qual operar. por exemplo, globosales
S
Parâmetros de consulta
Nome
Descrição
Obrigatório
Valor por padrão
doValidateOnly
Processe a solicitação no modo de validação, o que significa que não há persistência das alterações no banco de dados.
N
false
showWarnings
Lista de Avisos por trás de qualquer valor de dimensão ignorados/pulados para exclusão.
N
false
Exemplo de resposta:
200 OK
Resposta bem-sucedida.
{
"total": 5
}
Resposta bem-sucedida com avisos.
{
"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 Solicitação inválida
A solicitação não foi compreendida pelo servidor.
401 Não autorizado
O usuário não está autorizado.
403 Forbidden
O usuário não tem permissões suficientes.
500 Erro interno do servidor
Erro interno do servidor.