Descripcion general
Puede acceder a sus datos de beneficios acumulativos y exportarlos utilizando el punto final de la API de beneficios acumulativos de BulkIData. Para tener la capacidad de exportar estos datos, asegúrese de que su Rol tiene el permiso de Exportar Beneficios Acumulados para poder utilizar la API. Puede ir a Administración > Roles > seleccione su rol > en Permisos, seleccione Exportar Beneficios Acumulados.
BulkData Beneficios acumulados Endpoint
Puede obtener su API Endpoint de BulkIdeas utilizando Swagger (para más información sobre cómo acceder a Swagger, consulte el siguiente artículo: Cómo encontrar los API Endpoints disponibles). Una vez que haya introducido la URL, seleccione el punto final BulkData Beneficios acumulados para ver los parámetros disponibles.
Para el punto final de API de BulkData Beneficios acumulado se requiere lo siguiente (véase a continuación como ejemplo):
- La URL de su sitio
- La definición de la versión
- Los datos a incluir en el API Endpoint
- Su clave API (para más información sobre cómo obtener su clave API, consulte el siguiente artículo: Cómo acceder a su clave API)
Nota: Se puede acceder a la API de Beneficios Acumulados BulkData en la definición de versiones V2, V3 y V4.
Parámetros de BulkData Beneficios Acumulativos
Estos son los parámetros actualmente disponibles en la API de BulkData Beneficios Acumulativos:
- SiteIds
- BusinessUnitIds
- DepartmentIds
- TeamIds
- KpiTypeIds
- IdeaIds
Nota: estos ID primarios son generados por el sistema. Puede definir IDs primarios específicos en V4 seleccionando “Añadir elemento de cadena” en Swagger
- DesdeFecha - devuelve datos a partir de la fecha especificada.
- Periods - devuelve datos desde el periodo especificado. El número de elementos devueltos.
Nota: si no se especifica el número de periodos, la API devolverá por defecto los datos de 12 periodos
- IsAnnualizedBenefit - devuelve datos basados en la selección (true/false)
- Tags - devuelve datos con la etiqueta especificada
- CustomFields - devuelve datos basados en el campo personalizado especificado
- IdeaTypeId - devuelve datos basados en el IdeaTypeId especificado
- NonFinancialCategoryId - devuelve datos basados en el Id de categoría no financiera especificado
- IncludeCompleteIdeas - devuelve datos basados en la selección (true/false)