Saltar al contenido principal
Documentación
Documentación
Adaptive Planning
Última actualización: 2023-06-23
Valores de dimensión

Valores de dimensión

Versión: v1

VERB HTTP admitidos

HTTP Verb
Descripción
POST
Eliminar todos los valores de dimensión no utilizados existentes (los valores de dimensión en uso se ignorarán).

POST:

Solicitud:
/removeDimensionValues
Dado el nombre de dimensión y la lista de códigos de valor de dimensión, se eliminan sus valores de dimensión.
URI de solicitud de muestra:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues
o
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues?doValidateOnly=true&&showWarnings=true
Cabecera de solicitud de muestra:
Autorización: básica
Tipo de contenido: application/json
Cuerpo de solicitud de muestra
Solicitud POST de muestra
 
[
    {
        "dimensionName": "Dim1",
        "dimensionValueCodes": [
            "dimensionValueCode100"
        ]
    },
    {
        "dimensionName": "Dim2",
        "dimensionValueCodes": [
            "dimensionValueCode102",
            "dimensionValueCode103"
        ]
    },
    {
        "dimensionName": "Dim3",
        "dimensionValueCodes": [
            "dimensionValueCode104",
            "dimensionValueCode105",
            "dimensionValueCode106",
            "dimensionValueCode107"
            "dimensionValueCode108",
            "dimensionValueCode109"
        ]
    }
]
Parámetros de carga útil
Nombre
Descripción
Obligatorias
dimensionName
Nombre de dimensión
Sí
dimensionValueCodes
Lista de todos los códigos de valor de dimensión que se van a eliminar.
Sí
Parámetro de ruta
Nombre
Descripción
Obligatorias
entorno de cliente
Entorno de cliente en el que operar. p. ej., globosales
Sí
Parámetros de consulta
Nombre
Descripción
Obligatorias
Valor por defecto
doValidateOnly
Procese la solicitud en el modo de validación, lo que significa que no hay persistencia de los cambios en la base de datos.
No
falso
showWarnings
Lista de avisos detrás de cualquier valor de dimensión ignorado/omitido de la eliminación.
No
falso
Ejemplo de respuesta:
200 ACEPTAR
Respuesta correcta.
{
"total": 5
}
Respuesta correcta con 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 Solicitud incorrecta
El servidor no ha podido entender la solicitud.
401 No autorizado
El usuario no está autorizado.
403 Prohibido
El usuario no tiene suficientes permisos.
500 Error interno de servidor
Error interno de servidor.