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

Periodo

Punto final de URL

HTTPS://api.adaptiveinsights.com/api/rest/modeling/{version}/{tenant}/updateTime
Versión: v1
Categoría
Modificación de metadatos
Descripción
Actualizar estructura temporal en planificación
Permisos obligatorios para invocar
Configuración de calendario
Parámetros obligatorios en solicitud
N/D

Verbos HTTP admitidos

Verbo HTTP
Descripción
POST
En función del parámetro de operación, vuelva a cargar, actualice o añada la estructura temporal en Planning. Si no se especifica el parámetro de operación, utilice por defecto la operación de anexión.

POST

Solicitud
/updateTime: actualiza la estructura temporal
Actualiza la estructura temporal en Planning en función de la operación (recargar/actualizar/anexar) especificada como parámetro de consulta (anexar por defecto si no se especifica la operación):
  • Volver a cargar: vuelva a cargar toda la estructura temporal. Se borrarán todos los datos existentes. También permitimos definir el estrato por defecto mediante recargas.
  • Actualizar: actualice la estructura temporal existente, por ejemplo, cambie las etiquetas de los estratos temporales existentes, añada nuevos estratos, etc. También permitimos definir el estrato por defecto mediante actualizaciones.
  • Anexar: añada nuevos periodos a la estructura temporal. No puede modificar periodos, añadir un nuevo nivel de detalle para periodos ni eliminar periodos al añadir.
URI de solicitud de muestra:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/TIMEREALM/updateTime?operation
Cabecera de solicitud de muestra
Autorización: básica o basada en token.
Tipo de contenido: application/json
Cuerpo de solicitud
Cuerpo de solicitud de muestra 
{
   "calendars": [
       {
           "name": "DefaultHierarchy",
           "strata": [
               {
                   "code": "month",
                   "label": "Month",
                   "shortName": "Mon"
               },
               {
                   "code": "qtr",
                   "label": "Quarter",
                   "shortName": "Qtr"
               },
               {
                   "code": "year",
                   "label": "Year",
                   "shortName": "Yr"
               }
           ]
       },
       {
           "name": "AltHierarchy",
           "strata": [
               {
                   "code": "month"
               },
               {
                   "code": "altQtr",
                   "label": "AltQuarter",
                   "shortName": "AltQtr"
               },
               {
                   "code": "altYear",
                   "label": "AltYear",
                   "shortName": "AltYr"
               }
           ]
       }
   ],
   "periods": [
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "2022",
           "label": "FY2022",
           "shortName": "2022",
           "stratum": "year"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-04-01",
           "code": "Q1-2022",
           "label": "Q1-FY2022",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-02-01",
           "code": "01/2022",
           "label": "Jan-2022",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2022-02-01",
           "endDate": "2022-03-01",
           "code": "02/2022",
           "label": "Feb-2022",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2022-03-01",
           "endDate": "2022-04-01",
           "code": "03/2022",
           "label": "Mar-2022",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-07-01",
           "code": "Q2-2022",
           "label": "Q2-FY2022",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-05-01",
           "code": "04/2022",
           "label": "April-2022",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-06-01",
           "code": "05/2022",
           "label": "May-2022",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2022-06-01",
           "endDate": "2022-07-01",
           "code": "06/2022",
           "label": "June-2022",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-10-01",
           "code": "Q3-2022",
           "label": "Q3-FY2022",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-08-01",
           "code": "07/2022",
           "label": "July-2022",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2022-08-01",
           "endDate": "2022-09-01",
           "code": "08/2022",
           "label": "Aug-2022",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2022-10-01",
           "code": "09/2022",
           "label": "Sept-2022",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2023-01-01",
           "code": "Q4-2022",
           "label": "Q4-FY2022",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2022-11-01",
           "code": "10/2022",
           "label": "Oct-2022",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2022-11-01",
           "endDate": "2022-12-01",
           "code": "11/2022",
           "label": "Nov-2022",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2022-12-01",
           "endDate": "2023-01-01",
           "code": "12/2022",
           "label": "Dec-2022",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "2023",
           "label": "FY2023",
           "shortName": "2023",
           "stratum": "year"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-04-01",
           "code": "Q1-2023",
           "label": "Q1-FY2023",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-02-01",
           "code": "01/2023",
           "label": "Jan-2023",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2023-02-01",
           "endDate": "2023-03-01",
           "code": "02/2023",
           "label": "Feb-2023",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2023-03-01",
           "endDate": "2023-04-01",
           "code": "03/2023",
           "label": "Mar-2023",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-07-01",
           "code": "Q2-2023",
           "label": "Q2-FY2023",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-05-01",
           "code": "04/2023",
           "label": "April-2023",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-06-01",
           "code": "05/2023",
           "label": "May-2023",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2023-06-01",
           "endDate": "2023-07-01",
           "code": "06/2023",
           "label": "June-2023",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-10-01",
           "code": "Q3-2023",
           "label": "Q3-FY2023",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-08-01",
           "code": "07/2023",
           "label": "July-2023",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2023-08-01",
           "endDate": "2023-09-01",
           "code": "08/2023",
           "label": "Aug-2023",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2023-10-01",
           "code": "09/2023",
           "label": "Sept-2023",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2024-01-01",
           "code": "Q4-2023",
           "label": "Q4-FY2023",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2023-11-01",
           "code": "10/2023",
           "label": "Oct-2023",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2023-11-01",
           "endDate": "2023-12-01",
           "code": "11/2023",
           "label": "Nov-2023",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2023-12-01",
           "endDate": "2024-01-01",
           "code": "12/2023",
           "label": "Dec-2023",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "alt2022",
           "label": "Alt FY2022",
           "shortName": "Alt2022",
           "stratum": "altYear"    
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-05-01",
           "code": "altQ1-2022",
           "label": "Alt Q1-FY2022",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-07-01",
           "code": "altQ2-2022",
           "label": "Alt Q2-FY2022",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-09-01",
           "code": "altQ3-2022",
           "label": "Alt Q3-FY2022",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2023-01-01",
           "code": "altQ4-2022",
           "label": "Alt Q4-FY2022",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "alt2023",
           "label": "Alt FY2023",
           "shortName": "Alt2023",
           "stratum": "altYear"    
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-05-01",
           "code": "altQ1-2023",
           "label": "Alt Q1-FY2023",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-07-01",
           "code": "altQ2-2023",
           "label": "Alt Q2-FY2023",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-09-01",
           "code": "altQ3-2023",
           "label": "Alt Q3-FY2023",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2024-01-01",
           "code": "altQ4-2023",
           "label": "Alt Q4-FY2023",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       }
   ]
}
Parámetros de consulta
Nombre
Descripción
Obligatorias
operación
La operación de importación de estructura temporal que queremos realizar. Tiene que volver a cargar, actualizar o anexar. Si no se especifica ninguna operación, realizaremos append por defecto.
No
procedaWithWarnings
Un parámetro de consulta opcional que se utiliza para descartar mensajes de aviso. Si no se establece en verdadero, se devolverán posibles avisos antes de que se ejecute la llamada. Para descartarlos, especifique este parámetro como verdadero en la URL.
No
skipAwaitCacheRefresh
Un parámetro de consulta opcional. Si se establece como verdadero, la respuesta se devolverá tan pronto como esté lista, sin esperar a que se actualice la caché.
No
Parámetros de carga útil
Objeto de estructura temporal
Nombre
Descripción
Obligatorias
calendarios
Lista de todos los objetos de calendario que se van a importar. El calendario por defecto debe ir en primer lugar. Para actualizar y anexar, los usuarios deben incluir todos los calendarios existentes.
No
periodos
Lista de todos los objetos de periodo temporal de los calendarios. Los periodos deben enumerarse en orden de búsqueda en profundidad para cada calendario. Los periodos temporales del calendario por defecto deben ir en primer lugar. En el caso de los calendarios alternativos, es opcional volver a enumerar los periodos en el estrato de horquilla o en un nivel inferior.
No
Objeto de calendario
Nombre
Descripción
Obligatorias
nombre
Nombre del calendario.
Sí
estratos
La lista de objetos de estrato en el calendario debe estar en orden ascendente de nivel, siendo el nivel más bajo el estrato más detallado. En el caso de los calendarios alternativos, es opcional volver a enumerar los estratos por debajo del estrato de horquilla.
Sí
código
Código del calendario. Se admite cuando hay códigos de calendario presentes.
No
Objeto de estrato
Nombre
Descripción
Obligatorias
código
El código del estrato temporal debe ser exclusivo.
Sí
etiqueta
La etiqueta del estrato temporal debe ser exclusiva. No es obligatorio para los estratos compartidos que se vuelven a incluir en un calendario alternativo.
Sí
shortName
El nombre corto del estrato temporal debe ser exclusivo. No es obligatorio para los estratos compartidos que se vuelven a incluir en calendarios alternativos.
No
isDefaultStratum
Si el estrato temporal es el estrato por defecto. Solo permitimos definir el estrato por defecto en las operaciones de recarga o actualización. Si no se especifica isDefaultStratum para ningún estrato, supondremos que el estrato hoja es el estrato por defecto para la operación de recarga, y el estrato por defecto existente permanece sin cambios para la operación actualizada.
No
Objeto de periodo
Nombre
Descripción
Obligatorias
startDate
La fecha inicial del periodo debe tener el formato aaaa-MM-dd.
Sí
endDate
La fecha final del periodo debe tener el formato aaaa-MM-dd.
Sí
código
El código del periodo temporal debe ser exclusivo.
Sí
etiqueta
Etiqueta del periodo temporal
Sí
shortName
Nombre corto del periodo temporal.
No
estrato
El código del estrato al que pertenece este periodo temporal.
Sí
instanceCode
El instanceCode de donde se van a recuperar los valores. Por ejemplo, GLOBO. Si no se especifica instanceCode, se utiliza la instancia por defecto del usuario.
No

Respuesta

204 Sin contenido
La respuesta correcta está en blanco con el código de estado 204.
400 Solicitud incorrecta
El servidor no ha podido entender la solicitud.
Ejemplo: 
{
   "message": "Include only one of these valid operation parameters in the request: reload, update, or append.",
   "status": 400
}
{
   "error": "Errors occurred while processing the request.",
   "errors": [
       {
           "error": "Stratum code is required. Specify a code.",
           "field": "calendars[0].strata[2].code",
           "code": "PLN310002"
       }
   ]
}
{
   "error": "Errors occurred while processing the request",
   "errors": [
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (Q4-2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       },
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       }
   ]
}
401 No autorizado
El usuario no está autorizado.
Ejemplo: 
{
   "message": "Invalid credential",
   "status": 401
}
401 Prohibido
El usuario no tiene suficientes permisos.
Ejemplo: 
{
   "message": "This resource is only available when the JSON based time API feature and the alternate time roll-up feature are enabled.",
   "status": 403
}
500 Error interno de servidor
Error interno de servidor.