Referencia de IDs internos
Puede incluir IDs internos en una solicitud de API para obtener metadatos para los métodos de creación, actualización y lectura. Cuando realice solicitudes para estos métodos, utilice las llamadas a la API de exportación asociadas para obtener los ID que requiere su solicitud. Las solicitudes de todas las API de la siguiente tabla requieren un elemento de credenciales.
Ejemplo
Debe pasar el ID de dimensión para actualizar una dimensión en la solicitud de API updateDimensions . Puede pasar el ID de dimensión "7" para actualizar la dimensión "Educación
".
<dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> -------------------------- </dimension> </dimensions>
El ID de dimensión "7" para "Educación" se obtiene de la respuesta de API de exportDimensions .
<response success="true"> <output> <dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> -------------------------------------------- </dimension> </output> </response>
Exportar API e IDs de respuesta
API | Adaptive Planning IDs internos en respuesta | Metadatos recuperados |
|---|---|---|
ID de cuenta e ID de atributo de cuenta
Los ID de cuenta se pueden utilizar para identificar cuentas en otras llamadas a la API, como exportDimensionFamilies. El elemento de hoja es opcional. Si incluye el elemento de hoja, debe transmitir el ID de sistema interno de la hoja en su solicitud. Consulte exportSheets. | Lista de todas las cuentas, incluidos todos los tipos de cuenta: supuestos, cuentas de cubo, cuentas personalizadas, cuentas de libro mayor, cuentas de métrica y cuentas modeladas. | |
ID de moneda Esto se puede usar para identificar de forma exclusiva la moneda y se puede usar en la API customReportValues . | Lista de todas las monedas que se han configurado en el sistema. | |
ID de atributo e ID de elemento atributoValue | Lista de todos los atributos del sistema. | |
ID de dimensión y su ID de elemento dimensionValue Esto se puede utilizar para identificar dimensiones en otras llamadas a la API, como exportDimensionFamilies. | Lista de todas las dimensiones del sistema. | |
El ID de grupo de usuarios y el ID de usuario propietario de este grupo de usuarios (solo se establecen cuando isGlobal="false"). | Lista de todos los grupos definidos para la instancia determinada. Esto incluye los grupos definidos para global en toda la instancia y los grupos definidos por los usuarios. | |
Disponible en API v25+. | ID de conjunto de permisos Se utiliza para identificar el conjunto de permisos asignado a un usuario en la llamada a la API exportUsers. | Lista de todos los conjuntos de permisos de la instancia. |
ID de rol Se utiliza para identificar el rol asignado a un usuario en la llamada a la API exportUsers. | Lista de todos los roles de la instancia. | |
ID de hoja (pueden ser elementos de hoja estándar, de cubo y modelada) Esto se puede usar para identificar hojas en otras llamadas a la API, como exportSheetDefinition. | Lista de todas las hojas definidas para la instancia determinada. Esto incluye hojas "incompletas", así como hojas asignadas a usuarios. | |
ID de periodo temporal de saldo inicial | Metadatos de tiempo para una versión específica o para todas las versiones si no se especifica ninguna. | |
IDs para elementos de dimensión, selector de texto y valor. | La definición (columnas disponibles) de las transacciones en la instancia. | |
ID de usuario e ID de rol asignados a este usuario | Lista de todos los usuarios de la instancia. | |
ID de versión o carpeta Todos los ID son exclusivos entre todas las versiones, subversiones y carpetas. | Un documento XML que describe el conjunto de todas las versiones definidas en la instancia que no están ocultas para el usuario solicitante después de la verificación. |