Accounts

En el siguiente listado se muestran todas las operaciones disponibles para el manejo de cuentas.

get

Obtiene todas las cuentas contextualizadas. Sólo se mostraran las cuentas que se encuentren asociadas a los mismos clientes que la identidad digital utilizada para realizar esta petición.

Permite obtener los datos de una cuenta.

get

Permite obtener dado su id los datos de una cuenta.

App Navigator

En el siguiente listado se muestran todas las operaciones disponibles para la consulta de elementos para el menú de navegación entre apps.

get

Permite listar las aplicaciones del menú de navegación. (DEPRECATED, usar /appNavigator/v2)

get

Permite listar las aplicaciones del menú de navegación y obtener los datos de la cuenta.

Applications

En el siguiente listado se muestran todas las operaciones disponibles para el manejo de Aplicaciones.

get

Permite obtener las aplicaciones a las que tiene acceso el usuario

post
get

Permite obtener información básica de la aplicación a un administrador de la misma.

get

Búsqueda básica de cuentas y grupos de una aplicación.

get

Búsqueda de cuentas disponibles para añadir a una aplicación

get

Permite obtener dado su id los datos de una cuenta.

get

Obtiene los roles de la aplicación indicada

post

Crea un rol en la aplicación indicada

get

Permite obtener la suscripción de una aplicación.

patch

Añadir un producto adicional a una aplicación

post

Relacionar dos aplicaciones

delete

Eliminar relación entre dos aplicaciones

Authorization

En el siguiente listado se muestran todas las operaciones disponibles para el uso del endpoint authorization

get

(DEPRECADO - Usar /functionalities) Comprueba si la cuenta tiene acceso a esa funcionalidad en la instancia de producto.

get

Obtiene las funcionalidades que tiene un usuario de una aplicación

Catalogs

Operaciones de la API de catalogos

get

Permite obtener la información básica de todos los catálogos de la instancia.

post

Permite crear un catalogo

get

Permite obtener la información de un catalogo con sus elementos.

put

Permite modificar la información básica de un catalogo.

delete

Permite eliminar un catalogo

post

Permite crear un elemento en un catalogo

put

Permite modificar un elemento de un catalogo.

delete

Permite eliminar un elemento de un catalogo

Documents

En el siguiente listado se muestran todas las operaciones disponibles para el manejo y la gestión de documentos.

Dado una instancia de producto(productInstanceId) y un fichero, el servicio permite la subida del fichero en la plataforma. El fichero debe incluirse en el body en binary.

post

Permite subir un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "WRITE_FILE")

get

Permite listar y buscar los ficheros subidos por una instancia. (DEPRECATED, usar /documents/{productInstanceId}/search)

Búsquedas sobre ficheros de una instancia (DEPRECATED, usar /documents/{productInstanceId}/search)

post

Obtiene los ficheros de una instancia en base a sus metadatos. (DEPRECATED, usar /documents/{productInstanceId}/search)

post

Inicia importación masiva de archivos desde una carpeta (dentro de un Azure blob storage).

Operaciones sobre un fichero de una instancia.

get

Obtiene la información de un fichero.

delete

Borrar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "DELETE_FILE")

put

Actualizar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "WRITE_FILE")

get

Permite descargar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "READ_FILE")

put

Actualizar los metadatos de un fichero.

post

Convertir un archivo csv a excel

Operaciones sobre carpetas de una instancia

post

Crear una directorio (carpeta)

get

Obtiene la información de un directorio.

put

Actualizar los datos de un directorio

delete

Borrar una carpeta con todo su contenido.

Model service

Operaciones de la API de modelos

get

Permite buscar un modelo, se puede poner uno o varios paramteros en la busqueda.

get

Permite obtener un modelo mediante su id

get

Filtrar modelos por nombre y descripción

get

Permite obtener la información de una imagen

get

Permite obtener un archivo guardado en un modelo

Multitenant

En el siguiente listado se muestran todas las operaciones disponibles para el manejo de los datos de configuración y parametrización de las instancias de un producto

Permite obtener, crear y modificar los datos de configuración de la instancia de un producto.

get

Permite obtener dada una instancia de producto sus datos de configuración.

post

Permite crear/actualizar dada una instancia de producto sus datos de configuración.

get

Permite obtener dada una instancia de producto sus datos de configuración.

post

Permite crear/actualizar dada una instancia de producto sus datos de configuración.

Permite obtener, crear y modificar los datos de parametrización de la instancia de un producto.

get

Permite obtener dada una instancia de producto sus datos de parametrización.

post

Permite crear/actualizar dada una instancia de producto sus datos de parametrización.

get

Permite obtener dada una instancia de producto sus datos de parametrización.

post

Permite crear/actualizar dada una instancia de producto sus datos de parametrización.

Notifications

Operaciones de la API de notificaciones

get

Obtiene las notificaciones enviadas (Deprecado, usar - /notifications/{serviceInstanceId}/search)

get

Obtiene una notificación

get

Obtiene el contenido de la notificación enviada

get

Obtiene un archivo adjunto de una notificación

Operaciones de la API de emails

post

Envía un correo electrónico. (El usuario que hace la petición necesita tener acceso a la funcionalidad "SEND_TEMPLATED_EMAILS")

Operaciones de la API de emails

post

Obtener la previsualización del correo electronico ataraves de una plantilla

Operaciones de la API de emails

post

Obtener el texto generado de un hueco de la plantilla.

Operaciones de la API de emails

post

Envía SMS ataraves de una plantilla. (El usuario que hace la petición necesita tener acceso a la funcionalidad "SEND_TEMPLATED_SMS")

post

Cancelación de una notificacion programada.

post

Cancelación de las notificaciones programadas de una planificación.

put

Editar una notificación planificada o de repeteción.

Planning service

Operaciones disponibles para la planificación de notificaciones

get

Permite buscar una planificación, se puede poner uno o varios paramteros en la busqueda.

get

Permite obtener una planificación mediante su id

get

Permite obtener la hora de envio segun una planificación y zona horaria

get

Filtrar planifiaciones por nombre y descripción

Profiles

En el siguiente listado se muestran todas las operaciones disponibles para el manejo de perfiles dentro de la plataforma.

get

Permite obtener todos los perfiles o los perfiles filtrados

post

Añade un perfil nuevo a la aplicación

get

Obtiene información sobre el perfil

delete

Permite eliminar un perfil de usuario

get

Permite obtener los roles de un perfil

post

Permite asignar un rol id a un perfil de usuario

Permite eliminar un rol id de un perfil de usuario

delete

Permite eliminar un rol de un perfil

Products

En el siguiente listado se muestran todas las operaciones disponibles para el manejo de productos dentro de la plataforma.

get

Obtiene los datos de un producto

put

Actualizar un producto existente

Permite la obtener las aplicaciones de un (productId).

get

Obtener las aplicaciones de un producto

Permite la alta/Consulta de funcionalidades sobre un producto (productId).

post

Permite dar de alta nuevas funcionalidades para ser asignadas a un rol

get

Permite obtener un listado con todas las funcionalidades de un producto.

Permite la Modificación/Eliminación de funcionalidades sobre un producto (productId).

delete

Permite elminar una funcionalidad que no esté siendo utilizada por ningún rol.

put

Permite modificar una funcionalidad.

Permite la Añadir o obtener los roles de un producto (productId).

get

Obtener los roles asignados a un producto

post

Añadir un nuevo rol a un producto

Permite gestionar la configuración del producto (productId).

get

Permite obtener el modelo actual de configuración del producto (productId).

Permite gestionar la parametrización del producto (productId).

get

Permite obtener el modelo actual de parametrización del producto (productId).

post

Permite añadir un fav icon a un producto (este fav icon se usa para la personalización del login)

post

Permite añadir un logo a un producto (este logo se usa para la personalización del login)

Roles

Operaciones sobre un rol

get

Obtiene los datos de un rol

put

Modificar un rol

delete

Eliminar un rol

Operaciones sobre un rol de un producto

get

Obtiene las funcionalidades de un rol

post

Asociar una funcionalidad a un rol

Operaciones sobre una funcionalidad asociada a un

delete

Desasociar una funcionalidad de un rol

Strucs

Operaciones de la API de estructuras

get

Endpoint para obtener relaciones

post

Endpoint para crear relaciones

get

Endpoint para obtener relaciones

put

Endpoint para modificar atributos de las relaciones

post

Endpoint para modificar relaciones (origen, destino, tipo y/o atributos)

delete

Endpoint para borrar relaciones

get

Endpoint para obtener nodos

post

Endpoint para añadir nodos

get

Endpoint para obtener nodos

get

Endpoint para buscar nodos en base a sus atributos

post

Endpoint para buscar nodos en base a sus atributos

get

Endpoint para buscar nodos en base a su key (Tipos)

get

Endpoint para buscar nodos en base a su key (Tipos) y sus propiedades

post

Endpoint para buscar nodos en base a su key (Tipos) y sus propiedades

get

Endpoint para obtener un nodo en base al identificador del nodo

put

Endpoint para editar un nodo en base al identificador del nodo

delete

Endpoint para borrar un nodo en base al identificador del nodo

get

Obtener sumario asociado a un nodo en base al identificador del nodo

get

Endpoint para obtener relaciones en base al identificador del nodo

get

Endpoint para obtener todas las relaciones salientes de un nodo en base al identificador del nodo

get

Endpoint para obtener todas las relaciones salientes de un nodo en base al identificador del nodo

Endpoint para obtener las explotaciones asociadas a un usuario

get

Endpoint para obtener las explotaciones asociadas a un usuario

get

Endpoint para obtener datos de una pizarra

get

Obtener la información completa asociad a un nodo en base al identificador del nodo

get

Obtener sumario asociado a un nodo en base al identificador del nodo

get

Obtener la información completa asociad a una relación en base al identificador de la relación

get

Endpoint para obtener todos los catálogos de una instancia

get

Endpoint para obtener un catálogo

get

Endpoint para obtener tipos de nodos en base a su identificador

get

Endpoint para obtener tipos de nodos en base a su tipo

get

Endpoint para obtener tipos de nodos en base a varios tipos

get

Endpoint para obtener tipos de relaciones en base a su identificador

get

Endpoint para obtener tipos de relaciones en base a su tipo

get

Endpoint para obtener tipos de relaciones en base a varios tipos

get

Endpoint para obtener figuras

post

Endpoint para insertar figuras

get

Endpoint para obtener una figura

put

Endpoint para editar una figura

delete

Endpoint para borrar una figura

Subscriptions

Operaciones de la API de suscripciones

post

Crea un nueva subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.

get

Obtiene los clientes en base a los filtros o todos al no usar ninguno. Sólo se puede usar un filtro. Para realizar la acción necesitas ser Administrador de la plataforma.

get

Obtiene una subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.

put

Actualiza la información de una subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.

get

Consulta si el usuario es o no administrador de la suscripción.

get

(DEPRECADO - Usar /accounts/available) Busca entre las cuentas disponibles para añadir a una suscripción.

get

Busca entre las cuentas de la suscripción.

post

Añade una cuenta a una suscripción. Si la cuenta no existe se preregistra en caso de un usuario, se registra en caso de que sea delegada y se crea en caso de una entidad digital. Para realizar la acción necesitas ser Administrador de la subscripción.

delete

Elimina una cuenta de una suscripción.

get

Permite obtener dado su id los datos de una cuenta.

put

Cambia los privilegios de una cuenta de usuario pudiendo pasar de usuario a administrador y viceversa.

get

Búsqueda de cuentas disponibles para añadir a una suscripción

get

Obtiene los grupos de usuario de una suscripción.

post

Crea un nuevo grupo de usuarios para un cliente.

Tags

Operaciones de la API de tags

post

Create a context

get

Get a context by Id

post

Creates and object

get

Get an object data (mainly its tags)

delete

Deletes and object

post

Add a tag in an object

delete

Deletes a tag in an object

get

Filter tags by containing text

get

Gets tag context data by name

Template service

Operaciones de la API de templates

get

Permite buscar una plantilla, se puede poner uno o varios paramteros en la busqueda.

get

Permite obtener una plantilla mediante su id

put

Añadir una planificación por defecto en una plantilla

get

Permite obtener los idiomas que tiene una plantilla

get

Permite filtrar las plantillas, el filtro aplica al nombre, descripción, etiquetas, repositorios, Publicadas/No publicadas, email y/o sms.

Translations

En el siguiente listado se muestran todas las operaciones disponibles para la consulta de traducciones

get

Obtiene todas las traducciones de un servicio.

get

Obtiene todas las traducciones de un servicio.

get

Obtiene todos los lenguajes disponibles.

get

Obtiene todos los lenguajes disponibles en una aplicación.

User Groups

Operaciones de la API de grupos

get

Obtiene un grupo de usuarios.

put

Actualiza un grupo de usuarios.

delete

Borra un grupo de usuarios y todos sus usuarios.

get

Obtienes las cuentas asociadas a un grupo de usuarios.

post

Asocia una cuenta a un grupo de usuarios.

delete

Borra una cuenta de un grupo de usuario.