Public version 1.0
Bienvenido
Bienvenido a la Api pública, la cual proporciona servicios para terceros. Para tener acceso a nuestros recursos es necesario disponer de una identidad digital (Authorization). Para disponer identidad digital es necesario los siguientes pasos:
- Acceder a la web del portal e ir a Mis suscripciones>Cuentas (el usuario ha de ser admnistrador de la suscripción).
- Crear una nueva entidad digital y obtener la Clave de Api (Api Token).
- Cada vez que se quiera invocar algún sevicio de la api pública, es necesario invocar al login
/apitoken
pasando en el header la clave Api Token. El servicio debe devolver un Authorization válido.
Ejemplo Petición:
GET /apitoken
Headers
{
Authorization:Basic ZTQ0OTc1ZWYtZjM3OC00YmI2LWJmZmQtNjllNTVkMGZhZWQ5Oj54Lk8zMSJzNmB=
}
Ejemplo Resultado:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJlNDQ5NzVlZi1mMzc4LTRiYjYtYmZmZC02OWU1NWQwZmFlZDkiLCJuYmYiOiIyMDE4LTA1LTAzVDA5OjI4OjE2LjAwMFoiLCJleHAiOjE1MjUzNTU5ODAsInRva2VuVHlwZSI6IkFQSV9UT0tFTiIsImxvY2FsZSI6IkVOIn0.WbKHJngLHLQWxRxHRy9vR0QS8olsQaDR1U-tWMpJEhMyKV9jyC9FZOyYNSWkkFa87VKO3M05ICoyT2GC0WKvxEBLYvKZnTvWJ-r1w7loQg4MlToMAvBjMECKVz4wO1fEzJnvg5YRGJFo4VZPz1MxkzYKFeTRim30B-Gcc-sD4Jo"
}
Recursos de estado
/(raiz): indica que la API está funcionando si aparece el texto API Started!
.
/version: permite obtener la versión actual de la API, el último commit y la fecha del último despliegue.
- Ejemplo:
{ "version":"latest", "buildDate":"31/05/2017 - 12:22:15", "commit":"1ede9a7bec508f6b7cfc3ebb174cba1ae3423db2", "branch_name":"develop", "build_number":"11", "name":"api" }
- Ejemplo:
/health: muestra el estado actual de la API y de sus dependencias.
Ejemplo:
{ "version":"latest", "buildDate":"13/06/2017 - 12:39:05", "commit":"dd7758e51c6750b04b0573705dd1af788f913cad", "branch_name":"develop", "build_number":"11", "name":"api" }
Accounts
En el siguiente listado se muestran todas las operaciones disponibles para el manejo de cuentas.
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.
get /accounts
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.
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- email: (string)
filtra por email (devuelve un único registro)
Example:
/accounts?email=email2@test.com
- page: (integer)
Los elementos se paginan de 20 en 20. Por defecto se devuelve la página 0. Las páginas van de 0 a n
Example:
/accounts?page=0
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 200 (No query params)
Devuelve un array con las cuentas (sólo la primera página).
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 2,
"items": [
{
"id": "044d49d0-0521-4b56-80d0-c9aaf2d0f01d",
"name": "johnalexander.munoz",
"surname": null,
"language": "es_ES",
"email": "johnalexander.munoz@aqualogybs.co",
"contactemail": "johnalexander.munoz@aqualogybs.co",
"type": "User"
},
{
"id": "d51fac32-f6e6-42dd-9e21-70e6df69dd41",
"name": "Admin",
"surname": "Pérez",
"language": "es-ES",
"email": "admin@admin.com",
"contactemail": "admin@admin.com",
"type": "User"
}
]
}
}
HTTP status code 200 (Case of 'email' as query param)
Devuelve una única cuenta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "16c83d75-2697-47f0-ad6d-e42cc03faad8",
"name": "juancarlos.lloret",
"surname": null,
"language": "es-ES",
"email": "juancarlos.lloret@aqualogybs.net",
"contactemail": "juancarlos.lloret@aqualogybs.net",
"type": "User"
}
}
}
Permite obtener los datos de una cuenta.
Permite obtener dado su id los datos de una cuenta.
get /accounts/{accountId}
Permite obtener dado su id los datos de una cuenta.
URI Parameters
- accountId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve los datos de una cuenta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "d51fac32-f6e6-42dd-9e21-70e6df69dd41",
"name": "Admin",
"surname": "Pérez",
"language": "es-ES",
"email": "admin@admin.com",
"contactemail": "admin@admin.com",
"type": "User",
"isAdmin": true,
"isDeveloper": true
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
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.
Permite listar las aplicaciones del menú de navegación. (DEPRECATED, usar /appNavigator/v2)
get /appNavigator
Permite listar las aplicaciones del menú de navegación. (DEPRECATED, usar /appNavigator/v2)
Headers
- Authorization: required(string)
Token de la cuenta del usuario
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve un listado de las aplicaciones del menú de navegación a las que puede acceder el usuario.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"apps": [
{
"name": "Mi cuenta",
"url": "https://myaccount.dev.aquacis.absapp.net",
"icon": "swap-account_circle"
},
{
"name": "Portal",
"url": "https://portal.dev.aquacis.absapp.net"
},
{
"name": "Aplicación anti ramella",
"url": "http://google.es"
}
],
"actions": {
"more": {
"title": "Más"
}
}
}
}
}
HTTP status code 400
Petición mal formada. Devuelve la siguiente salida.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "XXX_XXX",
"message": "xxx xxx",
"errors": []
}
}
HTTP status code 401
Token no correcto o Token caducado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "XXX_XXX",
"message": "xxx xxx",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
Permite listar las aplicaciones del menú de navegación y obtener los datos de la cuenta.
get /appNavigator/v2
Permite listar las aplicaciones del menú de navegación y obtener los datos de la cuenta.
Headers
- Authorization: required(string)
Token de la cuenta del usuario
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve un listado de las aplicaciones del menú de navegación a las que puede acceder el usuario, junto a sus datos de la cuenta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"apps": [
{
"name": "Mi cuenta",
"url": "https://myaccount.dev.aquacis.absapp.net",
"icon": "swap-account_circle"
},
{
"name": "Portal",
"url": "https://portal.dev.aquacis.absapp.net"
},
{
"name": "Aplicación anti ramella",
"url": "http://google.es"
}
],
"actions": {
"more": {
"title": "Más"
}
},
"accountData": {
"id": "552ecaa9-1227-434b-8696-5a82ee5e1075",
"name": "Admin",
"surname": "SuperAdmin",
"language": "es-ES",
"email": "admin@nautilus.app",
"contactemail": "admin@nautilus.app",
"avatar": {
"original": {
"url": "XXX.jpg"
},
"small": {
"url": "XXX.jpg"
},
"medium": {
"url": "XXX.jpg"
},
"large": {
"url": "XXX.jpg"
}
},
"preferences": {
"language": "es-ES",
"volumeUnit": "l",
"currency": "EUR"
},
"type": "User"
}
}
}
}
HTTP status code 400
Petición mal formada. Devuelve la siguiente salida.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "XXX_XXX",
"message": "xxx xxx",
"errors": []
}
}
HTTP status code 401
Token no correcto o Token caducado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "XXX_XXX",
"message": "xxx xxx",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
Applications
En el siguiente listado se muestran todas las operaciones disponibles para el manejo de Aplicaciones.
Permite obtener las aplicaciones a las que tiene acceso el usuario
get /applications
Permite obtener las aplicaciones a las que tiene acceso el usuario
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- productId: (string)
filtra por id de producto (devuelve un único registro)
Example:
/applications?productId=726000ce-7b25-48d6-a39c-17f5d7dc36bc
- accountId: (string)
usuario para el que se queren obtener los tenants (sino se informa, se obtiene el usuario del token)
Example:
/applications?productId=726000ce-7b25-48d6-a39c-17f5d7dc36bc&accountId=1231000ce-7b25-48d6-a39c-17f5d7dc36ff
HTTP status code 200
Devuelve las aplicaciones que tiene acceso el usuario.
Body
Media type: application/json
Type: any
Examples:
Sin Query Param:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 5,
"items": [
{
"id": "21335ff1-63fa-4b30-a71f-98c149001248",
"name": "App 1",
"description": "Descripción de la aplicación 1",
"url": "http://google.es",
"productid": "726000ce-7b25-48d6-a39c-17f5d7dc36bc",
"productname": "Nombre del producto de la app 1"
},
{
"id": "d7a84c10-e7d6-4153-8d72-3fb80b5050d9",
"name": "App 2",
"description": "Descripción de la aplicación 2",
"url": "http://google.es",
"productid": "d459ee36-eae9-479e-b6a0-38e5a43b9996",
"productname": "Nombre del producto de la app 2"
}
]
}
}
Con query param:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "d7a84c10-e7d6-4153-8d72-3fb80b5050d9",
"name": "App 2",
"description": "Descripción de la aplicación 2",
"url": "http://google.es",
"productid": "d459ee36-eae9-479e-b6a0-38e5a43b9996",
"productname": "Nombre del producto de la app 2"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /applications
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Permite obtener información básica de la aplicación a un administrador de la misma.
get /applications/{applicationId}
Permite obtener información básica de la aplicación a un administrador de la misma.
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de la aplicación.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"_id": "d7a84c10-e7d6-4153-8d72-3fb80b5050d9",
"accountId": null,
"activated": true,
"clientId": "cbb0bf01-33c1-49df-ae82-4e6822c95533",
"description": "Descripción de la aplicación 2",
"id": "d7a84c10-e7d6-4153-8d72-3fb80b5050d9",
"imageUrl": "https://sharedresources.dev.aquacis.absapp.net/logo/app03.svg",
"name": "App 2",
"productId": "a73e7318-2fe8-446f-bba2-445e3b7ff4e9",
"subscriptionId": "cbb0bf01-33c1-49df-ae82-4e6822c95533",
"url": "http://google.es",
"updatedAt": 1690531383023,
"editionAvailable": true,
"urlType": "baseId",
"products": [
{
"id": "652990ce-9e1c-44f3-967d-ee0d209e25d4",
"type": "ticket",
"url": "https://portal-apps.dev.nautilus.app/ticketing?apps=8f0374bb-84c2-4cbd-93c1-47c428a047c2"
}
]
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Búsqueda básica de cuentas y grupos de una aplicación.
get /applications/{applicationId}/members
Búsqueda básica de cuentas y grupos de una aplicación.
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: (string)
Filtra las cuentas y grupos a devolver en base al nombre del grupo o al nombre y/o el correo de una cuenta.
Example:
Mike
- offset: (integer)
Número del elemento a partir del cual vamos a obtener resultados.
Example:
0
- limit: (integer)
Especifica el número máximo de elementos que va a devolver la petición. Máximo 100.
Example:
15
HTTP status code 200
Lista de cuentas y grupos encontradas
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"id": "1b69eff9-e0bc-4967-b28b-c315c6508812",
"email": "albertosinnombre@yopmail.com",
"registerat": 1521554501141,
"fullName": "Alberto Alexander Buitrago García",
"avatar": null,
"isDigitalEntity": false,
"type": "ACCOUNT",
"userGroups": {
"e4b3e5cc-ec86-4e7b-8e3b-09c9d89c171f": {},
"7ede5613-b09f-409d-ab01-f177d1a22770": {}
},
"profileId": "b691d80a-0cd6-4d49-a30e-f73c0472e3a3",
"isApplicationAdmin": false,
"isSubscriptionAdmin": true
},
{
"id": "6627a12d-b865-46e3-a9d1-42fd503bb546",
"name": "Probando",
"description": "",
"type": "USERGROUP"
},
{
"id": "08eb82d8-aae1-40e6-98be-85a5606947ee",
"email": "xavier.serrano@aqualogybs.net",
"registerat": 1483228800000,
"fullName": "Xavier Especial",
"avatar": "{\n \"original\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_original.jpg\"\n },\n \"medium\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_medium.jpg\"\n },\n \"small\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_small.jpg\"\n },\n \"large\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_large.jpg\"\n }\n}",
"isDigitalEntity": false,
"type": "ACCOUNT",
"profileId": "b691d80a-0cd6-4d49-a30e-f73c0472e3a3",
"isApplicationAdmin": false,
"isSubscriptionAdmin": true
}
],
"pagination": {
"offset": 3,
"limit": 3,
"totalItems": 7,
"previous": {
"offset": 0
},
"next": {
"offset": 6
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "NotFound",
"reasons": [
{
"message": "NOT_FOUND",
"details": "PRODUCT_INSTANCE_NOT_EXIST"
}
],
"origin": {
"service": "Licensing",
"version": "0.0.0",
"traceId": "69948bf8d3f40d31:69948bf8d3f40d31:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Búsqueda avanzada de cuentas y grupo de usuarios de una aplicación.
post /applications/{applicationId}/members/search
Búsqueda avanzada de cuentas y grupo de usuarios de una aplicación.
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- search: (string)
filtra coincidencias por nombre completo o email.
- isAccount: (boolean)
Filtrar por cuentas de usuarios
- isGroup: (boolean)
Filtrar por grupo de usuarios
- isDigitalEntity: (boolean)
Filtrar por identidades digitales
- isAdmin: (string)
Filtrar por administradores
- roles: (array)
Filtrar por roles
Example:
{
"filter": {
"search": "ramon",
"isAccount": false,
"isGroup": true,
"isDigitalEntity": true,
"isAdmin": false,
"roles": [
{
"id": "f39da4b4-8b7d-48e4-b8b7-17cec2471288"
},
{
"id": "173a7c3f-bb9b-4619-803e-72dea3eab0a3"
}
]
},
"pagination": {
"offset": 0,
"limit": 20
}
}
HTTP status code 200
Lista de cuentas y grupos encontradas
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"data": [
{
"id": "1b69eff9-e0bc-4967-b28b-c315c6508812",
"email": "albertosinnombre@yopmail.com",
"registerat": 1521554501141,
"fullName": "Alberto Alexander Buitrago García",
"avatar": null,
"isDigitalEntity": false,
"type": "ACCOUNT",
"userGroups": {
"e4b3e5cc-ec86-4e7b-8e3b-09c9d89c171f": {},
"7ede5613-b09f-409d-ab01-f177d1a22770": {}
},
"profileId": "b691d80a-0cd6-4d49-a30e-f73c0472e3a3",
"isApplicationAdmin": false,
"isSubscriptionAdmin": true
},
{
"id": "6627a12d-b865-46e3-a9d1-42fd503bb546",
"name": "Probando",
"description": "",
"type": "USERGROUP"
},
{
"id": "08eb82d8-aae1-40e6-98be-85a5606947ee",
"email": "xavier.serrano@aqualogybs.net",
"registerat": 1483228800000,
"fullName": "Xavier Especial",
"avatar": "{\n \"original\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_original.jpg\"\n },\n \"medium\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_medium.jpg\"\n },\n \"small\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_small.jpg\"\n },\n \"large\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mdhlyjgyzdgtywflms00mgu2ltk4ymutodvhntywnjk0n2vl-avatarcontent/YTx7RXb58rTMQa835fSzk0t3vfL5OtSZNu3YpiSyESBh3VE6iSE6TJNQFUX2PQyu_large.jpg\"\n }\n}",
"isDigitalEntity": false,
"type": "ACCOUNT",
"profileId": "b691d80a-0cd6-4d49-a30e-f73c0472e3a3",
"isApplicationAdmin": false,
"isSubscriptionAdmin": true
}
],
"pagination": {
"offset": 3,
"limit": 3,
"totalItems": 7,
"previous": {
"offset": 0
},
"next": {
"offset": 6
}
}
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "NotFound",
"reasons": [
{
"message": "NOT_FOUND",
"details": "PRODUCT_INSTANCE_NOT_EXIST"
}
],
"origin": {
"service": "Licensing",
"version": "0.0.0",
"traceId": "69948bf8d3f40d31:69948bf8d3f40d31:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Búsqueda de cuentas disponibles para añadir a una aplicación
get /applications/{applicationId}/accounts/available
Búsqueda de cuentas disponibles para añadir a una aplicación
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: required(string)
Email o nombre de cuenta por el cual filtrar
Example:
test@mail.com
- isDigitalEntity: (boolean - default: false)
Especifica si se quiere consultar Identidades Digitales
- fromSubscriptionId: (string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción a la que pertenece una Identidad Digital
Example:
e564824a-14ec-4087-8e0b-e74ade6e21cf
- offset: (integer - default: 0 - minimum: 0)
Página de resultados
- limit: (integer - default: 5 - minimum: 1 - maximum: 100)
Límite de resultados por página
HTTP status code 200
Búsqueda correcta de una cuenta
Body
Media type: application/json
Type: any
Examples:
User:
{
"apiVersion": "AUTO",
"data": {
"itemsCount": 1,
"items": [
{
"id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595",
"email": "abusquiel@test.com",
"registerat": 1483228800000,
"preregisterat": null,
"fullName": "abusquiel",
"avatar": null,
"isDigitalEntity": false,
"type": "ACCOUNT",
"normalizedName": "abusquiel",
"fromDU": false
}
]
}
}
Digital Identity:
{
"apiVersion": "AUTO",
"data": {
"itemsCount": 1,
"items": [
{
"id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595",
"email": "DI@e564824a-14ec-4087-8e0b-e74ade6e21cf",
"registerat": 1483228800000,
"preregisterat": null,
"fullName": "DI",
"avatar": null,
"isDigitalEntity": true,
"type": "ACCOUNT",
"normalizedName": "DI",
"fromDU": false,
"ownedBy": "e564824a-14ec-4087-8e0b-e74ade6e21cf"
}
]
}
}
Permite obtener dado su id los datos de una cuenta.
get /applications/{applicationId}/accounts/{accountId}
Permite obtener dado su id los datos de una cuenta.
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- accountId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve los datos de una cuenta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "d51fac32-f6e6-42dd-9e21-70e6df69dd41",
"name": "Admin",
"surname": "Pérez",
"language": "es-ES",
"email": "admin@admin.com",
"contactemail": "admin@admin.com",
"type": "User",
"isAdmin": true,
"isDeveloper": true
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtiene los roles de la aplicación indicada
Crea un rol en la aplicación indicada
get /applications/{applicationId}/roles
Obtiene los roles de la aplicación indicada
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Los roles de la aplicación
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 3,
"items": [
{
"id": "2e189be7-dd45-4b26-bd17-bd12be58cb09",
"name": "Administrador2",
"description": null,
"type": "product"
},
{
"id": "3e0a002e-0be0-47de-972b-176e90636070",
"name": "Invitado",
"description": null,
"type": "product"
},
{
"id": "02b33527-c4ab-4318-80f9-dbf16f934abd",
"name": "Operador telelectura",
"description": null,
"type": "instance"
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /applications/{applicationId}/roles
Crea un rol en la aplicación indicada
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "Administrador",
"description": "Quien administra"
}
HTTP status code 201
Se ha creado correctamente
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "b37e768e-5fda-4cb1-980f-ba3b4c09911e"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "NotFound",
"reasons": [
{
"message": "NOT_FOUND",
"details": "PRODUCT_INSTANCE_NOT_EXIST"
}
],
"origin": {
"service": "Licensing",
"version": "0.0.0",
"traceId": "69948bf8d3f40d31:69948bf8d3f40d31:0:1"
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite obtener la suscripción de una aplicación.
get /applications/{applicationId}/subscription
Permite obtener la suscripción de una aplicación.
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la suscripción de la aplicación.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"data": {
"self": {
"_id": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"subscriptionId": "cbb0bf01-33c1-49df-ae82-4e6822c95533"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "NotFound",
"reasons": [
{
"message": "NOT_FOUND",
"details": "PRODUCT_INSTANCE_NOT_EXIST"
}
],
"origin": {
"service": "Licensing",
"version": "0.0.0",
"traceId": "69948bf8d3f40d31:69948bf8d3f40d31:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Añadir un producto adicional a una aplicación
patch /applications/{applicationId}/activate/{productId}
Añadir un producto adicional a una aplicación
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- productId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- activated: required(boolean)
Activar/desactivar una producto adicional para una aplicación
Example:
{
"activated": true
}
HTTP status code 204
El producto se ha activado/desactivado correctamente
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Relacionar dos aplicaciones
Eliminar relación entre dos aplicaciones
post /applications/{applicationId}/relate/{relatedAppId}
Relacionar dos aplicaciones
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- relatedAppId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 201
Se ha relacionado correctamente
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"related": "true"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
delete /applications/{applicationId}/relate/{relatedAppId}
Eliminar relación entre dos aplicaciones
URI Parameters
- applicationId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la aplicación
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- relatedAppId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
La relación se ha eliminado correctamente
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Authorization
En el siguiente listado se muestran todas las operaciones disponibles para el uso del endpoint authorization
(DEPRECADO - Usar /functionalities) Comprueba si la cuenta tiene acceso a esa funcionalidad en la instancia de producto.
get /authorization/check
(DEPRECADO - Usar /functionalities) Comprueba si la cuenta tiene acceso a esa funcionalidad en la instancia de producto.
Query Parameters
- accountId: required(string)
Identificador de la cuenta.
Example:
/chech?accontId=2054ad89-2bb8-477c-a877-06be3dfefed6
- productInstanceId: required(string)
Identificador de una instancia de producto.
Example:
chech?productInstanceId=f354ad89-cc11-bb7c-cc77-cccccccefed6
- functionalityId: required(string)
Identificador de una funcionalidad
Example:
chech?functionalityId=bbbba345-3453-5434-1233-24234aaa2344
HTTP status code 200
Nos dice si la cuenta de usuario tiene acceso a la funcionalidad para la instancia de producto dada.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"isAllowed": true
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtiene las funcionalidades que tiene un usuario de una aplicación
get /authorization/functionalities
Obtiene las funcionalidades que tiene un usuario de una aplicación
Query Parameters
- accountId: required(string)
Identificador de la cuenta.
Example:
/functionalities?accontId=2054ad89-2bb8-477c-a877-06be3dfefed6
- productInstanceId: required(string)
Identificador de una instancia de producto.
Example:
/functionalities?productInstanceId=f354ad89-cc11-bb7c-cc77-cccccccefed6
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"data": {
"itemsCount": 3,
"items": [
"SEND_TEMPLATED_EMAILS",
"MODEL_MANAGER",
"TEMPLATE_MANAGER"
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Búsqueda de funcionalidades para multiples aplicaciones
post /authorization/functionalities/search
Búsqueda de funcionalidades para multiples aplicaciones
Body
Media type: application/json
Type: object
Properties- accountId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la cuenta
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- applicationIds: required(array of string)
Identificadores de las aplicaciones
Example:
[ "0dae5b93-9451-4b08-b7bb-f0b944fbcdf2" ]
HTTP status code 200
Búsqueda correcta de funcionalidades
Body
Media type: application/json
Type: object
Example:
Functionalities:
{
"4f07a620-a604-4776-8fd1-15b4cf44df31": [
"FUNC0"
],
"6decade8-0bec-4980-b58d-53e3ae844d87": [
"FUNC0",
"FUNC1"
]
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Catalogs
Operaciones de la API de catalogos
Permite obtener la información básica de todos los catálogos de la instancia.
Permite crear un catalogo
get /catalogs/{instanceId}
Permite obtener la información básica de todos los catálogos de la instancia.
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- limit: (string)
Permite limitar el resultado
Example:
10
- page: (string)
Permite solicitar una página respecto al limite
Example:
1
HTTP status code 200
Devuelve los catalogos
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "626feab94c27c25a8b85c109",
"name": "Catalogo de prueba",
"description": "Descripción de catalogo de prueba",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"isPrivate": true,
"createdAt": 1651501753512,
"updatedAt": 1651505074570
},
{
"_id": "62e10d0e2a97a13727fffd5b",
"name": "Coches",
"description": "",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"isPrivate": true,
"createdAt": 1658916110366
},
{
"_id": "6315d38b813fd246b2a44960",
"name": "awdwad",
"description": "",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"isPrivate": false,
"createdAt": 1662374795344
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /catalogs/{instanceId}
Permite crear un catalogo
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- name: required(string - minLength: 3 - maxLength: 50)
Nombre del catalogo.
- description: (string - maxLength: 120)
Descripción del catalogo.
- isPrivate: (boolean - default: true)
Tipo de catalogo. Un catalogo público es accesible por todos.
Example:
{
"name": "Nautilus_master",
"description": "Este es un catalogo de prueba",
"isPrivate": true
}
HTTP status code 200
Devuelve la información del catalogo creado
Body
Media type: application/json
Type: any
Example:
{
"_id": "6322ecc77eddcf2063160235",
"name": "Nautilus_master",
"description": "Este es un catalogo de prueba",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"isPrivate": true,
"createdAt": 1663233223568
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite obtener la información de un catalogo con sus elementos.
Permite modificar la información básica de un catalogo.
Permite eliminar un catalogo
get /catalogs/{instanceId}/{id}
Permite obtener la información de un catalogo con sus elementos.
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
- id: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve el catalogo
Body
Media type: application/json
Type: any
Example:
{
"_id": "632318d77eddcf2063160236",
"name": "Nautilus_master",
"description": "Este es un catalogo de prueba",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"isPrivate": true,
"createdAt": 1663244503694,
"items": [
{
"_id": "6323190aea644eec916e8447",
"name": "Usuari",
"description": "Usuarios de la aplicación",
"type": "node",
"icon": "people",
"color": "#673ab7",
"schema": {
"title": "Attributes",
"type": "object",
"properties": {
"nom": {
"_id": "ed4a9e23-ea7d-447d-a16a-eb2ff7f7eb69",
"title": "nom",
"type": "string"
},
"tePares": {
"_id": "e8a216ff-b5df-4a86-b5e0-524a3c4b10f9",
"title": "tePares",
"type": "boolean"
}
}
},
"catalogId": "632318d77eddcf2063160236",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"createdAt": 1663244554086
}
]
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
put /catalogs/{instanceId}/{id}
Permite modificar la información básica de un catalogo.
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
- id: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- name: required(string - minLength: 3 - maxLength: 50)
Nombre del catalogo.
- description: (string - maxLength: 120)
Descripción del catalogo.
- isPrivate: (boolean - default: true)
Tipo de catalogo. Un catalogo público es accesible por todos.
Example:
{
"name": "Nautilus_master",
"description": "Este es un catalogo de prueba modificado",
"public": true
}
HTTP status code 200
Devuelve el catalogo editado
Body
Media type: application/json
Type: any
Example:
{
"_id": "626feab94c27c25a8b85c109",
"name": "Nautilus_master",
"description": "Este es un catalogo de prueba modificado",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"isPrivate": true,
"createdAt": 1651501753512,
"updatedAt": 1651505074570
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
delete /catalogs/{instanceId}/{id}
Permite eliminar un catalogo
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
- id: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Empty body
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite crear un elemento en un catalogo
post /catalogs/{instanceId}/{id}/items
Permite crear un elemento en un catalogo
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
- id: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- type: required(one of node, edge)
Tipo del elemento.
- name: required(string - minLength: 3 - maxLength: 50)
Nombre del elemento.
- displayLabel: (string)
Etiqueta del elemento a mostrar en web.
- description: (string - maxLength: 120)
Descripción del elemento.
- icon: required(string)
icono
- color: (string)
Color elemento
- schema: required(string)
Esquema en formato http://json-schema.org/draft-07/schema#
Example:
{
"name": "Usuari",
"description": "Usuarios de la aplicación",
"type": "node",
"icon": "people",
"color": "#673ab7",
"schema": {
"title": "Attributes",
"type": "object",
"properties": {
"nom": {
"_id": "ed4a9e23-ea7d-447d-a16a-eb2ff7f7eb69",
"title": "nom",
"type": "string"
},
"tePares": {
"_id": "e8a216ff-b5df-4a86-b5e0-524a3c4b10f9",
"title": "tePares",
"type": "boolean"
}
}
}
}
HTTP status code 200
Devuelve el elemento creado
Body
Media type: application/json
Type: any
Example:
{
"_id": "6323190aea644eec916e8447",
"name": "Usuari",
"description": "Usuarios de la aplicación",
"type": "node",
"icon": "people",
"color": "#673ab7",
"schema": {
"title": "Attributes",
"type": "object",
"properties": {
"nom": {
"_id": "ed4a9e23-ea7d-447d-a16a-eb2ff7f7eb69",
"title": "nom",
"type": "string"
},
"tePares": {
"_id": "e8a216ff-b5df-4a86-b5e0-524a3c4b10f9",
"title": "tePares",
"type": "boolean"
}
}
},
"catalogId": "632318d77eddcf2063160236",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"createdAt": 1663244554086
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite modificar un elemento de un catalogo.
Permite eliminar un elemento de un catalogo
put /catalogs/{instanceId}/{id}/items/{itemId}
Permite modificar un elemento de un catalogo.
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
- id: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b2
- itemId: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b1
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- type: required(one of node, edge)
Tipo del elemento.
- name: required(string - minLength: 3 - maxLength: 50)
Nombre del elemento.
- displayLabel: (string)
Etiqueta del elemento a mostrar en web.
- description: (string - maxLength: 120)
Descripción del elemento.
- icon: required(string)
icono
- color: (string)
Color elemento
- schema: required(string)
Esquema en formato http://json-schema.org/draft-07/schema#
Example:
{
"name": "Usuari",
"description": "Usuarios de la aplicación",
"type": "node",
"icon": "people",
"color": "#673ab7",
"schema": {
"title": "Attributes",
"type": "object",
"properties": {
"nom": {
"_id": "ed4a9e23-ea7d-447d-a16a-eb2ff7f7eb69",
"title": "nom",
"type": "string"
},
"tePares": {
"_id": "e8a216ff-b5df-4a86-b5e0-524a3c4b10f9",
"title": "tePares",
"type": "boolean"
}
}
}
}
HTTP status code 200
Devuelve el catalogo editado
Body
Media type: application/json
Type: any
Example:
{
"_id": "6323190aea644eec916e8447",
"name": "Usuari",
"description": "Usuarios de la aplicación",
"type": "node",
"icon": "people",
"color": "#673ab7",
"schema": {
"title": "Attributes",
"type": "object",
"properties": {
"nom": {
"_id": "ed4a9e23-ea7d-447d-a16a-eb2ff7f7eb69",
"title": "nom",
"type": "string"
},
"tePares": {
"_id": "e8a216ff-b5df-4a86-b5e0-524a3c4b10f9",
"title": "tePares",
"type": "boolean"
}
}
},
"catalogId": "632318d77eddcf2063160236",
"instanceId": "cf2db0b7-ee12-479e-9335-86dfa1c8f28a",
"createdAt": 1663244554086
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
delete /catalogs/{instanceId}/{id}/items/{itemId}
Permite eliminar un elemento de un catalogo
URI Parameters
- instanceId: required(string)
Example:
b173f20b-8e60-49fd-928b-d7f91552b39d
- id: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b2
- itemId: required(string)
MongoDB ObjectId
Example:
6322c44bdd996542d21078b1
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Empty body
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "VALIDATION_ERROR_PATTERN",
"params": {
"pattern": "^[0-9a-fA-F]{24}$"
},
"details": "must match pattern \"^[0-9a-fA-F]{24}$\""
}
],
"origin": {
"service": "catalogs-api",
"version": "0.2.0",
"traceId": "21f79557d029a6b:fbe4eda759ba77a9:21f79557d029a6b:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"reasons": [
{
"message": "ERROR_APPLICATION_NOT_FOUND"
}
],
"origin": {
"service": "catalogs-main-api",
"version": "0.1.1",
"traceId": "a42fa332267546a2:aa8646349b9f7fdf:a42fa332267546a2:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
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.
Permite subir un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "WRITE_FILE")
Permite listar y buscar los ficheros subidos por una instancia. (DEPRECATED, usar /documents/{productInstanceId}/search)
post /documents/{productInstanceId}
Permite subir un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "WRITE_FILE")
URI Parameters
- productInstanceId: required(string)
Headers
- Source: required(string)
Indica quien realiza la petición.
Example:
Postman
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
- File-Name: required(string)
Nombre del fichero de subida con extensión.
Example:
prueba.txt
- File-Date: required(number)
Fecha de creación del fichero. No confundir con la fecha de subida en la plataforma.
Example:
2017-05-16T16:00:15.960+02:00
- File-Size: required(number)
Indica el tamaño del fichero a subir en la platarma en Bytes.
Example:
72228
- Content-MD5: required(string)
Checksum del fichero.
Example:
U6Dkokb1o6PfeVrQy8Ggkw==
- Metadata: (object)
Example:
{ "invoiceId": "357834534556" }
- Deadline: (number)
Fecha final del archivo, después de esta el archivo se eliminará permanentemente
Example:
2021-11-16T16:00:15.960+01:00
- FileType: (string)
Tipo de archivo para la validación de los metadatos (obligatorio si esta activada la validación)
Example:
Nautilus
- ParentDirId: (string)
Identificador de la carpeta a la que queremos añadir el archivo
Example:
Jiu-coUBNZgprGfV_jkE
HTTP status code 200
Devuelve un listado de todos los ficheros del 'productInstacedId'
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"id": "5964abda84c29b0008b8736e"
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
get /documents/{productInstanceId}
Permite listar y buscar los ficheros subidos por una instancia. (DEPRECATED, usar /documents/{productInstanceId}/search)
URI Parameters
- productInstanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- search: (string)
Permite buscar aquellos ficheros que contengan la cadena contenida en el parámetro.
Example:
.pdf
- limit: (string)
Permite limitar el resultado
Example:
10
- page: (string)
Permite solicitar una página respecto al limite
Example:
1
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 200 (Añadiendo {limit} y {page} en los queryparams)
Devuelve un listado de todos los ficheros del 'productInstacedId'
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"edges": [
{
"_id": "5a1446b3f3197e2d909c9cf1",
"name": "index2.html",
"internalName": "index2.html",
"date": "2017-11-12T09:05:21.365Z",
"size": 22138,
"contentType": "application/octet-stream",
"charset": null,
"contentTransferEncoding": null,
"tags": [],
"md5": "5acfahobU9IroF3/Uyjt9w==",
"storage": {
"type": "AZURE_CLOUD",
"Transfer-Encoding": "chunked",
"Content-MD5": "5acfahobU9IroF3/Uyjt9w==",
"Last-Modified": "Tue, 21 Nov 2017 15:32:25 GMT",
"ETag": "\"0x8D530F51152D466\"",
"Server": "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"x-ms-request-id": "8e324219-001e-0004-64dd-62c4fb000000",
"x-ms-version": "2016-05-31",
"x-ms-request-server-encrypted": "true",
"Date": "Tue, 21 Nov 2017 15:32:25 GMT"
},
"source": {
"serviceInstanceId": "2054ad89-2bb8-477c-a877-06be3dfefed6",
"accountId": "201e8c27-aed5-47f6-8b0d-bf6a57ceea2f",
"applicationName": "MDM"
},
"registrationDate": "2017-11-21T15:30:59.3Z"
}
],
"pageInfo": {
"count": 5
}
}
}
}
HTTP status code 200 (DEPRECATED Omitiendo {limit} y {page} en los queryparams)
Devuelve un listado de todos los ficheros del 'productInstacedId'
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 1,
"items": [
{
"_id": "5a1446b3f3197e2d909c9cf1",
"name": "index2.html",
"internalName": "index2.html",
"date": "2017-11-12T09:05:21.365Z",
"size": 22138,
"contentType": "application/octet-stream",
"charset": null,
"contentTransferEncoding": null,
"tags": [],
"md5": "5acfahobU9IroF3/Uyjt9w==",
"storage": {
"type": "AZURE_CLOUD",
"Transfer-Encoding": "chunked",
"Content-MD5": "5acfahobU9IroF3/Uyjt9w==",
"Last-Modified": "Tue, 21 Nov 2017 15:32:25 GMT",
"ETag": "\"0x8D530F51152D466\"",
"Server": "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"x-ms-request-id": "8e324219-001e-0004-64dd-62c4fb000000",
"x-ms-version": "2016-05-31",
"x-ms-request-server-encrypted": "true",
"Date": "Tue, 21 Nov 2017 15:32:25 GMT"
},
"source": {
"serviceInstanceId": "2054ad89-2bb8-477c-a877-06be3dfefed6",
"accountId": "201e8c27-aed5-47f6-8b0d-bf6a57ceea2f",
"applicationName": "MDM"
},
"registrationDate": "2017-11-21T15:30:59.3Z"
}
]
}
}
Obtiene los ficheros y/o directorios de una instancia.
post /documents/{productInstanceId}/search
Obtiene los ficheros y/o directorios de una instancia.
URI Parameters
- productInstanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- date: (object)
Fecha indicada al guardar el documento.
- start: (string)
Fecha inicio busqueda (formato ISO 8601).
- end: (string)
Fecha final busqueda (formato ISO 8601).
- start: (string)
- registrationDate: (object)
Fecha de registro.
- start: (string)
Fecha inicio busqueda (formato ISO 8601).
- end: (string)
Fecha final busqueda (formato ISO 8601).
- start: (string)
- updatedAt: (object)
Fecha de modificación.
- start: (string)
Fecha inicio busqueda (formato ISO 8601).
- end: (string)
Fecha final busqueda (formato ISO 8601).
- start: (string)
- name: (string)
Nombre del documento (busqueda parcial)
- contentType: (string)
Tipo de documento (busqueda estricta).
- storageType: (one of AZURE_CLOUD, DISK)
Sitio donde esta guardado el documento.
- metadata: (object)
Objeto con datos enviados al guardar los documentos
- partialSearch: (boolean - default: false)
Se puede activar esta propiedad, dentro del objeto metadatos para que el sistema haga una busqueda parcial de las propiedades informadas.
- partialSearch: (boolean - default: false)
- count: (boolean - default: false)
Número de registros disponibles según el filtro proporcionado
- itemType: (one of FILE, FOLDER)
Tipo de documento
- parentDirId: (string)
Identificador de la carpeta que contiene los archivos
- limit: (integer - default: 10)
Numnero de documentos a devolver
- page: (integer - default: 1)
Página a devolver.
Example:
{
"count": true,
"date": {
"start": "2021-07-01T09:05:21.365Z",
"end": "2022-07-05T09:05:21.365Z"
},
"registrationDate": {
"start": "2021-07-01T09:05:21.365Z",
"end": "2022-09-07T09:05:21.365Z"
},
"updatedAt": {
"start": "2024-07-01T09:05:21.365Z"
},
"itemType": "FILE",
"parentDirId": "52104ed3848ae4c03d6bc35e",
"name": "nautilus",
"contentType": "image/jpg",
"storageType": "AZURE_CLOUD",
"metadata": {
"myId": "56123fdgkhy"
},
"limit": 10,
"page": 1
}
HTTP status code 200
La petición al recursos finaliza correctamente.
Body
Media type: application/json
Type: any
Example:
{
"items": [
{
"_id": "63104ed3848ae4c03d6bc35e",
"internalName": "375bd551-dfd9-4be5-8463-d71187eae296",
"source": {
"serviceInstanceId": "77fb2d9c-81b1-4056-a96b-f409cc427b4c"
},
"contentType": "image/jpg",
"date": "2021-07-05T09:05:21.365Z",
"md5": "lldRBINywWNIZXj+1SJ1zQ==",
"name": "Nautilus_book.jpg",
"registrationDate": "2022-09-01T06:18:56.397Z",
"size": 109321,
"storage": {
"type": "AZURE_CLOUD"
},
"updatedAt": "2022-09-01T06:18:56.397Z"
},
{
"_id": "63104e3a848ae4c03d6ba564",
"internalName": "52740bdf-de35-4b11-8531-7c0766686e1b",
"source": {
"serviceInstanceId": "77fb2d9c-81b1-4056-a96b-f409cc427b4c"
},
"contentType": "image/jpg",
"date": "2021-07-05T09:05:21.365Z",
"md5": "lldRBINywWNIZXj+1SJ1zQ==",
"name": "Nautilus_book.jpg",
"registrationDate": "2022-09-01T06:16:25.132Z",
"size": 109321,
"storage": {
"type": "AZURE_CLOUD"
},
"updatedAt": "2022-09-01T06:20:07.632Z"
}
],
"count": 19,
"path": [
{
"name": "1.2.2 level",
"id": "624eaef543f015202266d56d",
"order": 1
},
{
"name": "1.2 level",
"id": "624eaef543f015202266d52d",
"order": 2
},
{
"name": "1 Level",
"id": "624eaef543f015202266d50d",
"order": 3
}
]
}
HTTP status code 400
Parametros no permitidos
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "must NOT have additional properties",
"params": {
"additionalProperty": "internal"
}
}
],
"origin": {
"service": "filestorage",
"APP_VERSION": "AUTO",
"traceId": "c2cc45b215cad7da:c2cc45b215cad7da:0:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Búsquedas sobre ficheros de una instancia (DEPRECATED, usar /documents/{productInstanceId}/search)
Obtiene los ficheros de una instancia en base a sus metadatos. (DEPRECATED, usar /documents/{productInstanceId}/search)
post /documents/{productInstanceId}/search/metadata
Obtiene los ficheros de una instancia en base a sus metadatos. (DEPRECATED, usar /documents/{productInstanceId}/search)
URI Parameters
- productInstanceId: required(string)
Query Parameters
- search: (string)
Permite buscar aquellos ficheros que contengan la cadena contenida en el parámetro
Example:
.pdf
- startCreationDate: (string)
Permite buscar aquellos ficheros con fecha de creación (X-FILEDATE) después de la fecha indicada
Example:
2017-10-22T00:00Z
- endCreationDate: (string)
Permite buscar aquellos ficheros con fecha de creación (X-FILEDATE) antes de la fecha indicada
Example:
2017-12-28T11:05:21Z
- startRegistrationDate: (string)
Permite buscar aquellos ficheros que se han registrado después de la fecha indicada
Example:
2017-01-01T10:10Z
- endRegistrationDate: (string)
Permite buscar aquellos ficheros que se han registrado antes de la fecha indicada
Example:
2017-11-28T11:05:21Z
- limit: (integer)
Cantidad de resultados devueltos, por defecto es 10.
Example:
50
- page: (integer)
Los resultados se organizan en páginas teniendo en cuenta el límite, por defecto es 1.
Body
Media type: application/json
Type: any
Example:
{
"metadata": {
"invoiceId": "357834534556"
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"type": "GET_FILE",
"message": "File 24fdac6d-414d-48e0-b14d-5e51518bef44 not found"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 200 ( Añadiendo {limit} y {page} en query params)
La petición al recursos finaliza correctamente.
Body
Media type: application/json
Type: any
Example:
{
"edges": [
{
"_id": "5a0bfc6d034e2f093c03099d",
"name": "LearningNeo4j_eBook.pdf",
"internalName": "learningneo4j_ebook.pdf",
"date": "2017-11-12T09:05:21.365Z",
"size": 8353556,
"contentType": "application/octet-stream",
"charset": null,
"contentTransferEncoding": null,
"tags": [],
"md5": "YKUMcU0ehqHdjDTjj7+OqA==",
"storage": {
"type": "AZURE_EMULATOR",
"Transfer-Encoding": "chunked",
"Content-MD5": "YKUMcU0ehqHdjDTjj7+OqA==",
"Last-Modified": "Wed, 15 Nov 2017 08:38:00 GMT",
"ETag": "\"0x8D52C042DA67C10\"",
"Server": "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"x-ms-request-id": "4bd1e448-4972-409e-915d-1a0b4e5b39e3",
"x-ms-version": "2016-05-31",
"x-ms-request-server-encrypted": "true",
"Date": "Wed, 15 Nov 2017 08:38:00 GMT"
},
"source": {
"serviceInstanceId": "1054ad89-2bb8-477c-a877-06be3dfefed1",
"accountId": "101e8c27-aed5-47f6-8b0d-bf6a57ceea1f",
"applicationName": "DILIGENTIA"
},
"metadata": {
"invoiceId": "357834534556"
},
"registrationDate": "2017-11-15T08:35:54.204Z"
}
],
"pageInfo": {
"count": 5
}
}
HTTP status code 200 ([DEPRECATED] Omitiendo {limit} y {page} en query params)
La petición al recursos finaliza correctamente. Esta opción será eliminada y devolverá el objeto con paginación.
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "5a0bfc6d034e2f093c03099d",
"name": "LearningNeo4j_eBook.pdf",
"internalName": "learningneo4j_ebook.pdf",
"date": "2017-11-12T09:05:21.365Z",
"size": 8353556,
"contentType": "application/octet-stream",
"charset": null,
"contentTransferEncoding": null,
"tags": [],
"md5": "YKUMcU0ehqHdjDTjj7+OqA==",
"storage": {
"type": "AZURE_EMULATOR",
"Transfer-Encoding": "chunked",
"Content-MD5": "YKUMcU0ehqHdjDTjj7+OqA==",
"Last-Modified": "Wed, 15 Nov 2017 08:38:00 GMT",
"ETag": "\"0x8D52C042DA67C10\"",
"Server": "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"x-ms-request-id": "4bd1e448-4972-409e-915d-1a0b4e5b39e3",
"x-ms-version": "2016-05-31",
"x-ms-request-server-encrypted": "true",
"Date": "Wed, 15 Nov 2017 08:38:00 GMT"
},
"source": {
"serviceInstanceId": "1054ad89-2bb8-477c-a877-06be3dfefed1",
"accountId": "101e8c27-aed5-47f6-8b0d-bf6a57ceea1f",
"applicationName": "DILIGENTIA"
},
"metadata": {
"invoiceId": "357834534556"
},
"registrationDate": "2017-11-15T08:35:54.204Z"
}
]
Inicia importación masiva de archivos desde una carpeta (dentro de un Azure blob storage).
post /documents/{productInstanceId}/files/import
Inicia importación masiva de archivos desde una carpeta (dentro de un Azure blob storage).
URI Parameters
- productInstanceId: required(string)
Body
Media type: application/json
Type: object
Properties- path: required(string)
Ruta a la carpeta ubicada en Azure blob storage.
- metadataFile: (string)
Nombre del archivo en formato .json que contiene la información necesaria para cada archivo.
- importAll: (boolean - default: false)
Importación de todos los archivos de una carpeta sin metadatos.
Examples:
With metadataFile:
{
"path": "Facturas/2023/Febrero",
"metadataFile": "metadata.json"
}
Import all files of folder:
{
"path": "Facturas/2023/Marzo",
"importAll": true
}
Metadata file example:
[
{
"name": "miFoto.png",
"metadata": {
"primero": "1",
"segundo": "2"
}
},
{
"name": "misLogs.log",
"metadata": {
"primero": "1",
"segundo": "2"
},
"deadline": "2023-11-16T16:00:15.960+01:00",
"parentDirId": "Jiu-coUBNZgprGfV_jkE",
"fileType": "Factura"
}
]
HTTP status code 202
La petición al recursos finaliza correctamente.
HTTP status code 400
Parametros no permitidos
Body
Media type: application/json
Type: any
Example:
{
"status": 400,
"reasons": [
{
"message": "must NOT have additional properties",
"params": {
"additionalProperty": "internal"
}
}
],
"origin": {
"service": "filestorage",
"APP_VERSION": "AUTO",
"traceId": "c2cc45b215cad7da:c2cc45b215cad7da:0:1"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"type": "PATH_NOT_FOUND",
"message": "Path '/facturas/2023/febrero' not found"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Operaciones sobre un fichero de una instancia.
Obtiene la información de un fichero.
Borrar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "DELETE_FILE")
Actualizar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "WRITE_FILE")
get /documents/{productInstanceId}/files/{fileId}
Obtiene la información de un fichero.
URI Parameters
- productInstanceId: required(string)
- fileId: required(string)
Identificador del fichero
Example:
e60ac104-6a01-4928-89a5-f5bbd751ff4c
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Información de un fichero
Body
Media type: application/json
Type: any
Example:
{
"_id": "5925ae04144d1418b80e175e",
"name": "FileZilla_3.24.1_win64-setup_bundled2.exe",
"internalName": "filezilla_3.24.1_win64-setup_bundled2.exe",
"contentType": "application/x-msdownload",
"size": "6985944",
"charSet": "UTF-8",
"contentTransferEncoding": "7bit",
"tags": [],
"date": "2017-05-20T09:00:00Z",
"registrationDate": "2017-05-24T16:00:04.258Z",
"storage": {
"type": "AZURE_EMULATOR",
"Transfer-Encoding": "chunked",
"Content-MD5": "SSD3t/Z1Z35cA7ExNn6Qew==",
"Last-Modified": "Wed, 24 May 2017 16:00:07 GMT",
"ETag": "\"0x8D4A2BDF3377860\"",
"Server": "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"x-ms-request-id": "d3fd7551-3760-4d5a-bc0f-aac04119b4c4",
"x-ms-version": "2016-05-31",
"x-ms-request-server-encrypted": "true",
"Date": "Wed, 24 May 2017 16:00:07 GMT"
},
"source": {
"serviceInstanceId": "2054ad89-2bb8-477c-a877-06be3dfefed6",
"accountId": "account0001",
"applicationName": "MDM"
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"type": "GET_FILE",
"message": "File 24fdac6d-414d-48e0-b14d-5e51518bef44 not found"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
delete /documents/{productInstanceId}/files/{fileId}
Borrar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "DELETE_FILE")
URI Parameters
- productInstanceId: required(string)
- fileId: required(string)
Identificador del fichero
Example:
e60ac104-6a01-4928-89a5-f5bbd751ff4c
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 202
Operación aceptada
Body
Media type: text/plain
Type: any
Example:
Accepted
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"type": "GET_FILE",
"message": "File 24fdac6d-414d-48e0-b14d-5e51518bef44 not found"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
put /documents/{productInstanceId}/files/{fileId}
Actualizar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "WRITE_FILE")
URI Parameters
- productInstanceId: required(string)
- fileId: required(string)
Identificador del fichero
Example:
e60ac104-6a01-4928-89a5-f5bbd751ff4c
Headers
- Source: required(string)
Indica quien realiza la petición.
Example:
Postman
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
- File-Name: required(string)
Nombre del fichero de subida con extensión.
Example:
prueba.txt
- File-Date: required(number)
Fecha de creación del fichero. No confundir con la fecha de subida en la plataforma.
Example:
2017-05-16T16:00:15.960+02:00
- File-Size: required(number)
Indica el tamaño del fichero a subir en la platarma en Bytes.
Example:
72228
- Content-MD5: required(string)
Checksum del fichero.
Example:
U6Dkokb1o6PfeVrQy8Ggkw==
- Metadata: (object)
Example:
{ "invoiceId": "357834534556" }
HTTP status code 200
Fichero insertado correctamente
Body
Media type: application/json
Type: any
Example:
{
"id": "5926c221144d1444bc0280ee"
}
HTTP status code 400
Petición incorrecta. Se esperaba algún parámetro o tiene un formato incorrecto.
Body
Media type: application/json
Type: any
Example:
{
"type": "SAVE_FILE",
"code": "WrongArguments",
"message": "Received wrong arguments. Check if all parameters are specified and are in correct format",
"cause": "For input string: \"72228adfasd\""
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite descargar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "READ_FILE")
get /documents/{productInstanceId}/files/{fileId}/download
Permite descargar un fichero. (El usuario que hace la petición necesita tener acceso a la funcionalidad "READ_FILE")
URI Parameters
- productInstanceId: required(string)
- fileId: required(string)
Identificador del fichero
Example:
e60ac104-6a01-4928-89a5-f5bbd751ff4c
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve el fichero binario
Body
Media type: application/octet-stream
Type: any
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"type": "GET_FILE",
"message": "File 24fdac6d-414d-48e0-b14d-5e51518bef44 not found"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Actualizar los metadatos de un fichero.
put /documents/{productInstanceId}/files/{fileId}/metadata
Actualizar los metadatos de un fichero.
URI Parameters
- productInstanceId: required(string)
- fileId: required(string)
Identificador del fichero
Example:
e60ac104-6a01-4928-89a5-f5bbd751ff4c
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- metadata: required(object)
Objeto en formato json, que permite añadir información propia. Las propiedades que incluye el objeto se añaden al objeto ya existente.
- overwrite: (boolean - default: false)
Sobreescribir/reemplazar todo el objeto de metadatos.
- fileType: (string)
Tipo de documento, si la validación es obligatoria, será necesario informar en caso de reemplzar los metadatos.
Example:
{
"metadata": {
"tercero": "noveno",
"isUpdate": true,
"myNumber": 44.89,
"newDate": "2022-06-12T08:05:21.365+02:00"
},
"overwrite": true,
"fileType": "Factura"
}
HTTP status code 200
Fichero insertado correctamente
Body
Media type: application/json
Type: any
Example:
{
"id": "5926c221144d1444bc0280ee"
}
HTTP status code 400
Petición incorrecta. Se esperaba algún parámetro o tiene un formato incorrecto.
Body
Media type: application/json
Type: any
Example:
{
"type": "SAVE_FILE",
"code": "WrongArguments",
"message": "Received wrong arguments. Check if all parameters are specified and are in correct format",
"cause": "For input string: \"72228adfasd\""
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Convertir un archivo csv a excel
post /documents/{productInstanceId}/files/{fileId}/csvToExcel
Convertir un archivo csv a excel
URI Parameters
- productInstanceId: required(string)
- fileId: required(string)
Identificador del fichero
Example:
e60ac104-6a01-4928-89a5-f5bbd751ff4c
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 201
Fichero convertido correctamente
Body
Media type: application/json
Type: any
Example:
{
"itemType": "FILE",
"name": "tickets.xlsx",
"size": 8512,
"contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"md5": "SXyasRyXXNvNnsJCRwxK1A==",
"storage": {
"type": "AZURE_CLOUD"
},
"source": {
"serviceInstanceId": "c57ce04c-e867-44dd-a022-0339c687e8fc"
},
"date": "2024-01-10T09:43:47.666Z",
"internalName": "890b784d-9081-42cf-ad4a-c303bf83efd1",
"registrationDate": "2024-01-10T09:43:47.769Z",
"updatedAt": "2024-01-10T09:44:50.875Z",
"_id": "2BfB8owBfpiRnvsjq_JB"
}
HTTP status code 400
Petición incorrecta. Se esperaba algún parámetro o tiene un formato incorrecto.
Body
Media type: application/json
Type: any
Example:
{
"type": "SAVE_FILE",
"code": "WrongArguments",
"message": "Received wrong arguments. Check if all parameters are specified and are in correct format",
"cause": "For input string: \"72228adfasd\""
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Operaciones sobre carpetas de una instancia
Crear una directorio (carpeta)
post /documents/{productInstanceId}/folders
Crear una directorio (carpeta)
URI Parameters
- productInstanceId: required(string)
Body
Media type: application/json
Type: object
Properties- name: required(string)
Nombre del carpeta
- parentDirId: (string)
Identificador de la carpeta que contiene los archivos
- metadata: (object)
Objeto en formato json, que permite añadir información propia. Las propiedades que incluye el objeto se añaden al objeto ya existente.
Example:
{
"name": "Movies",
"parentDirId": "55ebcf44b277ad386e4ecc06"
}
HTTP status code 201
Carpeta creada correctamente
Body
Media type: application/json
Type: any
Example:
{
"id": "635bae22b26868254900aa54"
}
HTTP status code 400
Petición incorrecta. Se esperaba algún parámetro o tiene un formato incorrecto.
Body
Media type: application/json
Type: any
Example:
{
"code": "WrongArguments",
"message": "Received wrong arguments. Check if all parameters are specified and are in correct format",
"cause": "For input string: \"72228adfasd\""
}
HTTP status code 500
Se ha pruducido algún error interno en el servidor
Obtiene la información de un directorio.
Actualizar los datos de un directorio
Borrar una carpeta con todo su contenido.
get /documents/{productInstanceId}/folders/{folderId}
Obtiene la información de un directorio.
URI Parameters
- productInstanceId: required(string)
- folderId: required(string)
HTTP status code 200
Información de un directorio
Body
Media type: application/json
Type: any
Example:
{
"_id": "635bae22b26868254900aa54",
"itemType": "FOLDER",
"source": {
"serviceInstanceId": "c57ce04c-e867-44dd-a022-0339c687e8fc"
},
"registrationDate": "2022-10-28T10:25:38.174Z",
"name": "My dir"
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"error": {
"code": "NOT FOUND",
"message": "File not found",
"errors": []
}
}
HTTP status code 500
Se ha pruducido algún error interno en el servidor
put /documents/{productInstanceId}/folders/{folderId}
Actualizar los datos de un directorio
URI Parameters
- productInstanceId: required(string)
- folderId: required(string)
Body
Media type: application/json
Type: object
Properties- name: required(string)
Nombre del carpeta
- parentDirId: (string)
Identificador de la carpeta que contiene los archivos (Indicar vacío si se quiere establecer en raíz)
- metadata: (object)
Objeto en formato json, que permite añadir información propia. Las propiedades que incluye el objeto se añaden al objeto ya existente.
Example:
{
"name": "Movies",
"parentDirId": "55ebcf44b277ad386e4ecc06"
}
HTTP status code 200
Fichero actualizado correctamente
Body
Media type: application/json
Type: any
Example:
{
"_id": "635bae22b26868254900aa54",
"itemType": "FOLDER",
"source": {
"serviceInstanceId": "c57ce04c-e867-44dd-a022-0339c687e8fc"
},
"registrationDate": "ISODate(\"2022-10-28T12:25:38.174+02:00\")",
"parentDirId": "55ebcf44b277ad386e4ecc06",
"name": "Movies"
}
HTTP status code 400
Petición incorrecta. Se esperaba algún parámetro o tiene un formato incorrecto.
Body
Media type: application/json
Type: any
Example:
{
"code": "WrongArguments",
"message": "Received wrong arguments. Check if all parameters are specified and are in correct format",
"cause": "For input string: \"72228adfasd\""
}
HTTP status code 500
Se ha pruducido algún error interno en el servidor
delete /documents/{productInstanceId}/folders/{folderId}
Borrar una carpeta con todo su contenido.
URI Parameters
- productInstanceId: required(string)
- folderId: required(string)
HTTP status code 202
Operación aceptada
Body
Media type: text/plain
Type: any
Example:
Accepted
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"error": {
"code": "NOT FOUND",
"message": "File not found",
"errors": []
}
}
HTTP status code 500
Se ha pruducido algún error interno en el servidor
Model service
Operaciones de la API de modelos
Permite buscar un modelo, se puede poner uno o varios paramteros en la busqueda.
get /model/{instanceId}
Permite buscar un modelo, se puede poner uno o varios paramteros en la busqueda.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- name: (string)
buscar por nombre del modelo
Example:
/model/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?name=Mi modelo
- description: (string)
buscar por descripción del modelo
Example:
/model/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?description=Modelo facturas
- tags: (string)
Etuiquetas de los modelos
Example:
/model/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?tags=Factura
HTTP status code 200
Devuelve el/los modelo/s que cumplen con la condición
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "5b88e9f414457d4e9c5f89cb",
"serviceInstanceId": "a26cb412-18bd-4dab-9408-4985a622ae4e",
"name": "Otro modelo. Con el título lo más largo posible!!!",
"description": "Este modelo es igual que el anterior pero se ha creado para hacer pruebas.",
"tags": null,
"html": {
"file": {},
"name": "Test OK (2).html",
"content": "<!DOCTYPE html>\n<html>\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n <title>Test</title>\n </head>\n\n <body>\n Hola!\n <p aq-slot=\"header\" type=\"text\" name=\"Texto de cabecera\" description=\"No debería superar los 50 caracteres\"></p>\n <img aq-slot=\"avatar\" type=\"image\" name=\"Logotipo para el banner\" description=\"En formato cuadrado\">\n <img aq-slot=\"banner\" type=\"image\" name=\"Banner publicitario\">\n <p aq-slot=\"body\" type=\"text\" name=\"Cuerpo del mensaje\"></p>\n <img aq-slot=\"footer\" type=\"image\" name=\"Texto al pié\" description=\"No más de 140 caracteres\">\n </body>\n</html>",
"slots": [
{
"id": "header",
"type": "text",
"description": "No debería superar los 50 caracteres",
"name": "Texto de cabecera"
},
{
"id": "avatar",
"type": "image",
"description": "En formato cuadrado",
"name": "Logotipo para el banner"
},
{
"id": "banner",
"type": "image",
"description": null,
"name": "Banner publicitario"
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje"
},
{
"id": "footer",
"type": "image",
"description": "No más de 140 caracteres",
"name": "Texto al pié"
}
],
"html": {}
},
"sample": {
"name": "email.png",
"id": "407814a3-2585-474c-a50c-e7f3bcfe7d94",
"images": {
"original": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_original.png"
},
"medium": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_medium.png"
},
"large": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_large.png"
},
"small": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_small.png"
}
}
},
"creationDate": "2018-08-31T07:10:44.204Z",
"sms": {
"slots": [
{
"id": "_content",
"type": "plain_text",
"name": "Contenido del SMS",
"description": "El texto máximo por SMS es 160 caracteres"
}
]
},
"modificationDate": "2018-09-26T15:41:01.328Z"
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Permite obtener un modelo mediante su id
get /model/{instanceId}/{modelId}
Permite obtener un modelo mediante su id
URI Parameters
- instanceId: required(string)
- modelId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve el modelo
Body
Media type: application/json
Type: any
Example:
{
"_id": "5b88e9f414457d4e9c5f89cb",
"serviceInstanceId": "a26cb412-18bd-4dab-9408-4985a622ae4e",
"name": "Otro modelo. Con el título lo más largo posible!!!",
"description": "Este modelo es igual que el anterior pero se ha creado para hacer pruebas.",
"tags": null,
"html": {
"file": {},
"name": "Test OK (2).html",
"content": "<!DOCTYPE html>\n<html>\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n <title>Test</title>\n </head>\n\n <body>\n Hola!\n <p aq-slot=\"header\" type=\"text\" name=\"Texto de cabecera\" description=\"No debería superar los 50 caracteres\"></p>\n <img aq-slot=\"avatar\" type=\"image\" name=\"Logotipo para el banner\" description=\"En formato cuadrado\">\n <img aq-slot=\"banner\" type=\"image\" name=\"Banner publicitario\">\n <p aq-slot=\"body\" type=\"text\" name=\"Cuerpo del mensaje\"></p>\n <img aq-slot=\"footer\" type=\"image\" name=\"Texto al pié\" description=\"No más de 140 caracteres\">\n </body>\n</html>",
"slots": [
{
"id": "header",
"type": "text",
"description": "No debería superar los 50 caracteres",
"name": "Texto de cabecera"
},
{
"id": "avatar",
"type": "image",
"description": "En formato cuadrado",
"name": "Logotipo para el banner"
},
{
"id": "banner",
"type": "image",
"description": null,
"name": "Banner publicitario"
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje"
},
{
"id": "footer",
"type": "image",
"description": "No más de 140 caracteres",
"name": "Texto al pié"
}
],
"html": {}
},
"sample": {
"name": "email.png",
"id": "407814a3-2585-474c-a50c-e7f3bcfe7d94",
"images": {
"original": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_original.png"
},
"medium": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_medium.png"
},
"large": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_large.png"
},
"small": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_small.png"
}
}
},
"creationDate": "2018-08-31T07:10:44.204Z",
"sms": {
"slots": [
{
"id": "_content",
"type": "plain_text",
"name": "Contenido del SMS",
"description": "El texto máximo por SMS es 160 caracteres"
}
]
},
"modificationDate": "2018-09-26T15:41:01.328Z"
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Filtrar modelos por nombre y descripción
get /model/{instanceId}/filter
Filtrar modelos por nombre y descripción
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: (string)
buscar por nombre del modelo
Example:
/model/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc/filter?filter=Mi modelo
- tags: (string)
Etuiquetas de los modelos
Example:
/model/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?tags=Barcelona,Aqualogy
HTTP status code 200
Devuelve el modelo
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "5b88e9f414457d4e9c5f89cb",
"serviceInstanceId": "a26cb412-18bd-4dab-9408-4985a622ae4e",
"name": "Otro modelo. Con el título lo más largo posible!!!",
"description": "Este modelo es igual que el anterior pero se ha creado para hacer pruebas.",
"tags": null,
"html": {
"file": {},
"name": "Test OK (2).html",
"content": "<!DOCTYPE html>\n<html>\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n <title>Test</title>\n </head>\n\n <body>\n Hola!\n <p aq-slot=\"header\" type=\"text\" name=\"Texto de cabecera\" description=\"No debería superar los 50 caracteres\"></p>\n <img aq-slot=\"avatar\" type=\"image\" name=\"Logotipo para el banner\" description=\"En formato cuadrado\">\n <img aq-slot=\"banner\" type=\"image\" name=\"Banner publicitario\">\n <p aq-slot=\"body\" type=\"text\" name=\"Cuerpo del mensaje\"></p>\n <img aq-slot=\"footer\" type=\"image\" name=\"Texto al pié\" description=\"No más de 140 caracteres\">\n </body>\n</html>",
"slots": [
{
"id": "header",
"type": "text",
"description": "No debería superar los 50 caracteres",
"name": "Texto de cabecera"
},
{
"id": "avatar",
"type": "image",
"description": "En formato cuadrado",
"name": "Logotipo para el banner"
},
{
"id": "banner",
"type": "image",
"description": null,
"name": "Banner publicitario"
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje"
},
{
"id": "footer",
"type": "image",
"description": "No más de 140 caracteres",
"name": "Texto al pié"
}
],
"html": {}
},
"sample": {
"name": "email.png",
"id": "407814a3-2585-474c-a50c-e7f3bcfe7d94",
"images": {
"original": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_original.png"
},
"medium": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_medium.png"
},
"large": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_large.png"
},
"small": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_small.png"
}
}
},
"creationDate": "2018-08-31T07:10:44.204Z",
"sms": {
"slots": [
{
"id": "_content",
"type": "plain_text",
"name": "Contenido del SMS",
"description": "El texto máximo por SMS es 160 caracteres"
}
]
},
"modificationDate": "2018-09-26T15:41:01.328Z"
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Permite obtener la información de una imagen
get /model/{instanceId}/image/{imageId}
Permite obtener la información de una imagen
URI Parameters
- instanceId: required(string)
- imageId: required(string)
HTTP status code 200
Devuelve la información de la imagen
Body
Media type: application/json
Type: any
Example:
{
"id": "a26cb412-18bd-4dab-9408-4985a622ae4e",
"images": {
"large": {
"name": "OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_large.png",
"url": "https://absneargodevimages1002.blob.core.windows.net/yti2y2i0mtitmthizc00zgfiltk0mdgtndk4nwe2mjjhztrl-logocontent/OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_large.png",
"lastModified": "Tue, 07 Aug 2018 07:31:23 GMT",
"contentLength": "13392",
"contentType": "image/png",
"contentEncoding": "7bit"
},
"medium": {
"name": "OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_medium.png",
"url": "https://absneargodevimages1002.blob.core.windows.net/yti2y2i0mtitmthizc00zgfiltk0mdgtndk4nwe2mjjhztrl-logocontent/OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_medium.png",
"lastModified": "Tue, 07 Aug 2018 07:31:23 GMT",
"contentLength": "9343",
"contentType": "image/png",
"contentEncoding": "7bit"
},
"original": {
"name": "OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_original.png",
"url": "https://absneargodevimages1002.blob.core.windows.net/yti2y2i0mtitmthizc00zgfiltk0mdgtndk4nwe2mjjhztrl-logocontent/OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_original.png",
"lastModified": "Tue, 07 Aug 2018 07:31:23 GMT",
"contentLength": "40244",
"contentType": "image/png",
"contentEncoding": "7bit"
},
"small": {
"name": "OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_small.png",
"url": "https://absneargodevimages1002.blob.core.windows.net/yti2y2i0mtitmthizc00zgfiltk0mdgtndk4nwe2mjjhztrl-logocontent/OZqIfJHfXG3Qx0m2Qq26TOHk6YVqNNBYEiucuN1icWanFWf5zastZtgO0a9i3tph_small.png",
"lastModified": "Tue, 07 Aug 2018 07:31:23 GMT",
"contentLength": "4685",
"contentType": "image/png",
"contentEncoding": "7bit"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Permite obtener un archivo guardado en un modelo
get /model/{instanceId}/file/{fileId}
Permite obtener un archivo guardado en un modelo
URI Parameters
- instanceId: required(string)
- fileId: required(string)
HTTP status code 200
Devuelve el archivo
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
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.
Permite obtener dada una instancia de producto sus datos de configuración.
Permite crear/actualizar dada una instancia de producto sus datos de configuración.
get /product-instances/{instanceId}/configuration
Permite obtener dada una instancia de producto sus datos de configuración.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la configuración de la instancia.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2b442e802c5014954e77",
"data": {
"isValid": true,
"name": "LDAP 1",
"description": "LDAP de prueba para probar los formularios",
"server": "192.168.1.1",
"port": 23,
"dnBase": "ou=Test,dc=agbar,dc=com",
"objectClass": "person",
"userDn": "cn=John,ou=Test,dc=agbar,dc=com",
"password": "123456",
"nameField": "name",
"mailField": "mail"
}
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de configuración la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "PRODUCT_INSTANCE_DONT_HAVE_DATA",
"message": "Product instance configuration not found",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
post /product-instances/{instanceId}/configuration
Permite crear/actualizar dada una instancia de producto sus datos de configuración.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"data": {
"isValid": true,
"name": "LDAP 1",
"description": "LDAP de prueba para probar los formularios",
"server": "192.168.1.1",
"port": 23,
"dnBase": "ou=Test,dc=agbar,dc=com",
"objectClass": "person",
"userDn": "cn=John,ou=Test,dc=agbar,dc=com",
"password": "123456",
"nameField": "name",
"mailField": "mail"
}
}
HTTP status code 200
Devuelve la configuración de la instancia.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2b442e802c5014954e77"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de configuración la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 460
La instancia de producto ya tiene datos de configuración.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "CONFIGURATION_ALREADY_EXISTS",
"message": "Configuration data already exists",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
Permite obtener dada una instancia de producto sus datos de configuración.
Permite crear/actualizar dada una instancia de producto sus datos de configuración.
get /product-instances/{instanceId}/configuration/{productId}
Permite obtener dada una instancia de producto sus datos de configuración.
URI Parameters
- instanceId: required(string)
- productId: required(string)
Identificador el producto.
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la configuración de la instancia.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2b442e802c5014954e77",
"data": {
"isValid": true,
"name": "LDAP 1",
"description": "LDAP de prueba para probar los formularios",
"server": "192.168.1.1",
"port": 23,
"dnBase": "ou=Test,dc=agbar,dc=com",
"objectClass": "person",
"userDn": "cn=John,ou=Test,dc=agbar,dc=com",
"password": "123456",
"nameField": "name",
"mailField": "mail"
}
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de configuración la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "PRODUCT_INSTANCE_DONT_HAVE_DATA",
"message": "Product instance configuration not found",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
post /product-instances/{instanceId}/configuration/{productId}
Permite crear/actualizar dada una instancia de producto sus datos de configuración.
URI Parameters
- instanceId: required(string)
- productId: required(string)
Identificador el producto.
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"data": {
"isValid": true,
"name": "LDAP 1",
"description": "LDAP de prueba para probar los formularios",
"server": "192.168.1.1",
"port": 23,
"dnBase": "ou=Test,dc=agbar,dc=com",
"objectClass": "person",
"userDn": "cn=John,ou=Test,dc=agbar,dc=com",
"password": "123456",
"nameField": "name",
"mailField": "mail"
}
}
HTTP status code 200
Devuelve la configuración de la instancia.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2b442e802c5014954e77"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de configuración la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 460
La instancia de producto ya tiene datos de configuración.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "CONFIGURATION_ALREADY_EXISTS",
"message": "Configuration data already exists",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
Permite obtener, crear y modificar los datos de parametrización de la instancia de un producto.
Permite obtener dada una instancia de producto sus datos de parametrización.
Permite crear/actualizar dada una instancia de producto sus datos de parametrización.
get /product-instances/{instanceId}/settings
Permite obtener dada una instancia de producto sus datos de parametrización.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la parametrización de la instancia.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2e9530c445519866b57b",
"data": {
"id": "0af0d6bb-505e-4fa5-9859-c049c6987361",
"name": "AGBAR",
"description": "Empresa para la gestión de agua de barcelona",
"owner": "2409f66d-d484-4875-b0a8-41342554e385"
}
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de parametrización de la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "PRODUCT_INSTANCE_DONT_HAVE_DATA",
"message": "Product instance settings not found",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
post /product-instances/{instanceId}/settings
Permite crear/actualizar dada una instancia de producto sus datos de parametrización.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"data": {
"isValid": true,
"name": "LDAP 1",
"description": "LDAP de prueba para probar los formularios",
"server": "192.168.1.1",
"port": 23,
"dnBase": "ou=Test,dc=agbar,dc=com",
"objectClass": "person",
"userDn": "cn=John,ou=Test,dc=agbar,dc=com",
"password": "123456",
"nameField": "name",
"mailField": "mail"
}
}
HTTP status code 200
Crea los datos de parametrización.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2e9530c445519866b57b"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de parametrización la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 460
La instancia de producto ya tiene datos de parametrización.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "SETTINGS_ALREADY_EXISTS",
"message": "Settings data already exists",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
Permite obtener dada una instancia de producto sus datos de parametrización.
Permite crear/actualizar dada una instancia de producto sus datos de parametrización.
get /product-instances/{instanceId}/settings/{productId}
Permite obtener dada una instancia de producto sus datos de parametrización.
URI Parameters
- instanceId: required(string)
- productId: required(string)
Identificador el producto.
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la parametrización de la instancia.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2e9530c445519866b57b",
"data": {
"id": "0af0d6bb-505e-4fa5-9859-c049c6987361",
"name": "AGBAR",
"description": "Empresa para la gestión de agua de barcelona",
"owner": "2409f66d-d484-4875-b0a8-41342554e385"
}
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de parametrización de la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "PRODUCT_INSTANCE_DONT_HAVE_DATA",
"message": "Product instance settings not found",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
post /product-instances/{instanceId}/settings/{productId}
Permite crear/actualizar dada una instancia de producto sus datos de parametrización.
URI Parameters
- instanceId: required(string)
- productId: required(string)
Identificador el producto.
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"data": {
"isValid": true,
"name": "LDAP 1",
"description": "LDAP de prueba para probar los formularios",
"server": "192.168.1.1",
"port": 23,
"dnBase": "ou=Test,dc=agbar,dc=com",
"objectClass": "person",
"userDn": "cn=John,ou=Test,dc=agbar,dc=com",
"password": "123456",
"nameField": "name",
"mailField": "mail"
}
}
HTTP status code 200
Crea los datos de parametrización.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "5a0c2e9530c445519866b57b"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos de parametrización la instancia
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 460
La instancia de producto ya tiene datos de parametrización.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "SETTINGS_ALREADY_EXISTS",
"message": "Settings data already exists",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
Notifications
Operaciones de la API de notificaciones
Obtiene las notificaciones enviadas (Deprecado, usar - /notifications/{serviceInstanceId}/search)
get /notifications/{serviceInstanceId}
Obtiene las notificaciones enviadas (Deprecado, usar - /notifications/{serviceInstanceId}/search)
URI Parameters
- serviceInstanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- search: (string)
busqueda por ID, destinario o asunto.
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?search=nautilus
- mediaType: (string)
tipo de medio, disponibles [email, sms]
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?mediaType=email
- application: (string)
busqueda por aplicación. (strict)
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?application=MyApp
- tags: (string)
Etuiquetas de las plantillas
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?tags=Barcelona,Aqualogy
- provider: (string)
busqueda por proveedor. (strict)
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?provider=SendGrid
- page: (string)
numero de pagina que se pide. Sino se informa se devuelve la primera
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?page=1
- limit: (string)
limite de registros por pagina. Sino se informa se devuelven 10 resultados
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?limit=20
- startDate: (string)
Fecha inicial de envio de las notificaciones
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?startDate=2018-11-20
- endDate: (string)
Fecha final de envio de las notificaciones
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?endDate=2018-11-30
- order: (string)
Ordena por el campo deseado en orden asendiente (1) o desendiente (-1), en formato "campo,1"
Example:
/notifications/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?order=deliveryDate,-1
HTTP status code 200
Devuelve las notificaciones
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "618d365cfe02b22bc4547957",
"notificationId": "3a597d0f-054a-4649-b105-cbd3e15ff1f7",
"templateId": "6135dd19a785822cb4b2938a",
"alias": "PlanningNowWhitRepeat",
"serviceInstanceId": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"user": null,
"application": null,
"from": "no-reply@dev.nautilus.app",
"language": "ca_ES",
"template_name": "Lyubo1",
"tags": null,
"subject": null,
"provider": "SendGrid",
"send_date": null,
"metadata": "Devuelve me esta frase.",
"hasAttachments": false,
"mediaType": "email",
"total": 1,
"totalFinished": 0,
"massive": false,
"generalState": 0,
"totalErrors": 0,
"recipients": [
{
"to": "lyubomir.torutev@mailinator.com",
"finished": false,
"singleNotificationId": null,
"state": 0,
"statusCode": 202,
"reference": 1,
"hasAttachments": false
}
],
"reference": "111121.1",
"creationDate": "2021-11-11T15:27:24.708Z",
"deliveryDate": "2021-11-11T15:27:24.708Z"
},
{
"_id": "610bef14e6ca130018e76d4f",
"notificationId": "e3590be7-59df-4a99-86b9-b323e7f4f6c7",
"templateId": "610b9e9ab454a10018880771",
"alias": "PlanningNowWhitRepeat",
"serviceInstanceId": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"user": null,
"application": null,
"from": "no-reply@nautilus.dev.absapp.net",
"language": "es_ES",
"template_name": "Responsive",
"tags": null,
"subject": "repositorio de plantillas",
"provider": "SendGrid",
"send_date": null,
"metadata": "Devuelve me esta frase.",
"hasAttachments": false,
"mediaType": "email",
"total": 1,
"totalFinished": 0,
"massive": false,
"generalState": 0,
"totalErrors": 0,
"recipients": [
{
"to": "lyubomir.torutev@aqualogybs.net",
"finished": false,
"state": 0,
"statusCode": 202,
"reference": 1,
"hasAttachments": false
}
],
"creationDate": "2021-08-05T14:00:52.835Z",
"deliveryDate": "2021-08-05T14:00:52.835Z",
"reference": "050821.9"
},
{
"_id": "610bed0de6ca130018e76d46",
"notificationId": "39d5703e-9185-4468-9cfc-ad7bfb7bbf60",
"templateId": "610b9e9ab454a10018880771",
"alias": "PlanningNowWhitRepeat",
"serviceInstanceId": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"user": null,
"application": null,
"from": "no-reply@nautilus.dev.absapp.net",
"language": "es_ES",
"template_name": "Responsive",
"tags": null,
"subject": "repositorio de plantillas",
"provider": "SendGrid",
"send_date": null,
"metadata": "Devuelve me esta frase.",
"hasAttachments": false,
"mediaType": "email",
"total": 1,
"totalFinished": 0,
"massive": false,
"generalState": 0,
"totalErrors": 0,
"recipients": [
{
"to": "lyubomir.torutev@aqualogybs.net",
"finished": false,
"state": 0,
"statusCode": 202,
"reference": 1,
"hasAttachments": false
}
],
"creationDate": "2021-08-05T13:52:13.396Z",
"deliveryDate": "2021-08-05T13:52:13.396Z",
"reference": "050821.2"
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtiene una notificación
get /notifications/{serviceInstanceId}/{notificationId}
Obtiene una notificación
URI Parameters
- serviceInstanceId: required(string)
- notificationId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la notifiación
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"data": {
"self": {
"_id": "60e71779911aef001213f7b0",
"notificationId": "365d2083-fd46-4439-98c6-08edbe4211db",
"templateId": "6059c4423e32d40011586c5d",
"alias": "PlanningNowWhitRepeat",
"serviceInstanceId": "b4f49337-40be-4702-9405-ac62b38b5d89",
"user": null,
"application": null,
"from": "no-reply@nautilus.dev.absapp.net",
"language": "es_ES",
"template_name": "Plantilla Responsive",
"tags": [
"pdf",
"lala"
],
"subject": null,
"provider": "SendGrid",
"send_date": null,
"metadata": "Devuelve me esta frase.",
"hasAttachments": true,
"mediaType": "email",
"total": 1,
"totalFinished": 1,
"massive": false,
"generalState": 2,
"totalErrors": 0,
"recipients": [
{
"to": "lyubomir.torutev@aqualogybs.net",
"finished": true,
"state": 2,
"statusCode": 202,
"reference": 1,
"hasAttachments": true,
"deliveryDate": "2021-07-08T15:19:23.000Z",
"message": "open",
"attachmentsMetadata": [
{
"content": "null",
"type": "image/png",
"filename": "yellow_mini_shared5.png",
"content_id": "aquacislogoShared",
"disposition": null,
"fileId": "5cec0d0c-42ef-474e-b55c-026f4bf7fcf2"
}
]
}
],
"creationDate": "2021-07-08T15:19:21.439Z",
"deliveryDate": "2021-07-08T15:19:29.224Z",
"reference": "080721.13"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtiene el contenido de la notificación enviada
get /notifications/{serviceInstanceId}/{notificationId}/{to}/content
Obtiene el contenido de la notificación enviada
URI Parameters
- serviceInstanceId: required(string)
- notificationId: required(string)
- to: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve el contenido en forma de archivo (email -> html), (sms -> txt)
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtiene un archivo adjunto de una notificación
get /notifications/{serviceInstanceId}/{notificationId}/{to}/{fileId}
Obtiene un archivo adjunto de una notificación
URI Parameters
- serviceInstanceId: required(string)
- notificationId: required(string)
- to: required(string)
- fileId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve el archivo adjunto con el formato correspondiente (imagen, pdf, excel, etc.)
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Buscar notificaciones enviadas
post /notifications/{serviceInstanceId}/search
Buscar notificaciones enviadas
URI Parameters
- serviceInstanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- search: (string)
Búsqueda por ID, destinatario o asunto. Tipo parcial, no es necesario poner palabras completas.
- mediaType: (one of email, sms)
Tipo de medio.
- from: (string)
Remitente.
- generalState: (one of 0, 1, 2, 3, 4)
Estado de la notificación. [Planificada = 0, EnProgreso = 1, Entregada = 2, Error = 3, Cancelada = 4]
- templateId: (string)
Búsqueda por identificador de la plantilla utilizada para el envío de la notificación.
- application: (string)
Búsqueda por aplicación. Tipo estricto.
- uniqueMessageId: (array)
Búsqueda por identificador único de mensaje.
- tags: (array)
Etiquetas de las plantillas
- provider: (one of SendGrid, Telefónica)
Búsqueda por proveedor.
- metadata: (object)
Búsqueda por metadatos (predefinidos por los usuarios)
- period: (object)
- fromCreationDate: (date)
Fecha con hora inicio de la creación del envío, en formato ISO 8601.
- toCreationDate: (date)
Fecha con hora fin de la creación del envío, en formato ISO 8601.
- fromDeliveryDate: (date)
Fecha con hora inicio de la entrega del envío, en formato ISO 8601.
- toDeliveryDate: (date)
Fecha con hora fin de la entrega del envío, en formato ISO 8601.
- fromCreationDate: (date)
- pagination: (object)
- page: (number - default: 1)
Número de página.
- limit: (number - default: 10)
Límite de registros por pagina.
- page: (number - default: 1)
- sort: (object)
- field: (string - default: creationDate)
Propiedad por la cual se ordenará la búsqueda.
- order: (number - default: -1)
Ascendiente 1, descendiente -1
- field: (string - default: creationDate)
Example:
{
"search": "nautilus",
"mediaType": "email",
"generalState": 2,
"from": "no-reply@nautilus.app",
"templateId": "622fb7643e85c20019524346",
"application": "Facturador",
"uniqueMessageId": [
"123dfs343"
],
"tags": [
"Factura",
"Importe"
],
"provider": "SendGrid",
"metadata": {
"userId": "A4K9L856MH"
},
"period": {
"fromCreationDate": "2022-05-10T15:27:34.914+02:00",
"toCreationDate": "2022-05-11T18:11:00.000+02:00"
},
"pagination": {
"page": 1,
"limit": 10
},
"sort": {
"field": "creationDate",
"order": -1
}
}
HTTP status code 200
Devuelve las notificaciones
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "618d365cfe02b22bc4547957",
"notificationId": "3a597d0f-054a-4649-b105-cbd3e15ff1f7",
"templateId": "6135dd19a785822cb4b2938a",
"alias": "PlanningNowWhitRepeat",
"serviceInstanceId": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"user": null,
"application": null,
"from": "no-reply@dev.nautilus.app",
"language": "ca_ES",
"template_name": "Lyubo1",
"tags": null,
"subject": null,
"provider": "SendGrid",
"send_date": null,
"metadata": "Devuelve me esta frase.",
"hasAttachments": false,
"mediaType": "email",
"total": 1,
"totalFinished": 0,
"massive": false,
"generalState": 0,
"totalErrors": 0,
"recipients": [
{
"to": "lyubomir.torutev@mailinator.com",
"finished": false,
"singleNotificationId": null,
"state": 0,
"statusCode": 202,
"reference": 1,
"hasAttachments": false
}
],
"reference": "111121.1",
"creationDate": "2021-11-11T15:27:24.708Z",
"deliveryDate": "2021-11-11T15:27:24.708Z"
},
{
"_id": "610bef14e6ca130018e76d4f",
"notificationId": "e3590be7-59df-4a99-86b9-b323e7f4f6c7",
"templateId": "610b9e9ab454a10018880771",
"alias": "PlanningNowWhitRepeat",
"serviceInstanceId": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"user": null,
"application": null,
"from": "no-reply@nautilus.dev.absapp.net",
"language": "es_ES",
"template_name": "Responsive",
"tags": null,
"subject": "repositorio de plantillas",
"provider": "SendGrid",
"send_date": null,
"metadata": "Devuelve me esta frase.",
"hasAttachments": false,
"mediaType": "email",
"total": 1,
"totalFinished": 0,
"massive": false,
"generalState": 0,
"totalErrors": 0,
"recipients": [
{
"to": "lyubomir.torutev@aqualogybs.net",
"finished": false,
"state": 0,
"statusCode": 202,
"reference": 1,
"hasAttachments": false
}
],
"creationDate": "2021-08-05T14:00:52.835Z",
"deliveryDate": "2021-08-05T14:00:52.835Z",
"reference": "050821.9"
},
{
"_id": "610bed0de6ca130018e76d46",
"notificationId": "39d5703e-9185-4468-9cfc-ad7bfb7bbf60",
"templateId": "610b9e9ab454a10018880771",
"alias": "PlanningNowWhitRepeat",
"serviceInstanceId": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"user": null,
"application": null,
"from": "no-reply@nautilus.dev.absapp.net",
"language": "es_ES",
"template_name": "Responsive",
"tags": null,
"subject": "repositorio de plantillas",
"provider": "SendGrid",
"send_date": null,
"metadata": "Devuelve me esta frase.",
"hasAttachments": false,
"mediaType": "email",
"total": 1,
"totalFinished": 0,
"massive": false,
"generalState": 0,
"totalErrors": 0,
"recipients": [
{
"to": "lyubomir.torutev@aqualogybs.net",
"finished": false,
"state": 0,
"statusCode": 202,
"reference": 1,
"hasAttachments": false
}
],
"creationDate": "2021-08-05T13:52:13.396Z",
"deliveryDate": "2021-08-05T13:52:13.396Z",
"reference": "050821.2"
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"status": 401,
"type": "WrongToken",
"reasons": [
{
"message": "Token decode error",
"details": "Token expired"
}
],
"origin": {
"service": "api",
"version": "Unknown",
"traceId": "d314beacf78497c8:d314beacf78497c8:0:1"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Operaciones de la API de emails
Envía un correo electrónico. (El usuario que hace la petición necesita tener acceso a la funcionalidad "SEND_TEMPLATED_EMAILS")
post /notifications/{serviceInstanceId}/email/template/{templateId}
Envía un correo electrónico. (El usuario que hace la petición necesita tener acceso a la funcionalidad "SEND_TEMPLATED_EMAILS")
URI Parameters
- serviceInstanceId: required(string)
- templateId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- from: required(string)
Correo que envía la notificación.
- alias: (string)
Alias del correo que envía la notificación.
- application: (string)
Aplicación desde la que se envía la notificación.
- uniqueMessageId: (string)
Control para mensaje único, si se informa no se aceptará otro mensaje con el mismo id.
- language: (string)
Idioma de la plantilla.
- metadata: (object)
Objeto en formato json, que permite añadir información propia, que servirá para poder buscar las notificaciones.
- scheduledDelivery: (object)
Entrega programada de la notificación.
- planningId: (string)
Identificación de la planificación.
- timeZone: required(string)
Zona horaria (TZ database name), lista de zonas disponibles - https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- sendDate: (string)
Fecha con hora en formato ISO 8601 para enviar la notificación. (Limite de 40 dias en futuro). Se puede usar solo sino se ha indicado "planningId".
- repeat: (object)
- cron: (string)
Expresión cron, formatos suportados - https://github.com/harrisiirak/cron-parser#readme.
- endDate: (string)
Fecha limite para la repetición de la notificación (formato ISO 8601).
- every: (integer)
Repetición, cada milisegundos (la configuración de cron no se puede usar junto con esta configuración).
- limit: (integer)
Número máximo de veces que se puede repetir la notificaión (Máximo 52) .
- cron: (string)
- planningId: (string)
- sharedAttachments: (array of object)
Archivo adjuntado para todos los destinatarios.
Items: Attachment
- content: (string)
Contenido en base 64
- type: required(string)
Tipo de archivo
- filename: required(string)
Nombre del archivo
- content_id: required(string)
Identificador del archivo
- disposition: (string)
La disposición del contenido del adjunto que especifica cómo le gustaría que se muestre el adjunto. Por ejemplo, "inline" da como resultado que el archivo adjunto se muestre automáticamente dentro del mensaje, mientras que "attachment" hace que el archivo adjunto requiera alguna acción antes de que se muestre (por ejemplo, abrir o descargar el archivo). Posibles valores "inline" y "attachment", valor por defecto "attachment". ADVERTENCIA, la mayoria de SMTPs empresariales rechazan la opción "inline", por lo que el adjunto no se mostrara ni estarà adjuntado en el cliente.
- document_link: (string)
Enlace comleto para descargar el contenido.
- content: (string)
- sharedData: (array of object)
Información de las variables de la plantilla para todos los destinatarios.
Items: Data
- key: required(string)
Nombre de la variable en la plantilla.
- value: required(string)
Valor de la variable.
- key: required(string)
- sharedSlots: (array of object)
Información de los huecos para todos los destinatarios.
Items: Slot
- key: required(string)
Nombre del hueco en el modelo.
- value: required(string)
Valor del hueco.
- key: required(string)
- recipients: required(array of object)
Destinatarios de las notificaciones.
Items: Recipient
- to: required(array of string)
Correos electrónicos a los que se enviara la notificación.
- cc: (array of string)
Correos electrónicos a los que se enviara una copia de la notificación.
- bcc: (array of string)
Correos electrónicos a los que se enviara una copia sin que quede constancia para los otros receptores.
- dedicatedAttachments: (array of Attachment)
Archivo adjuntado solo a los destinatarios de este recipiente.
Items: Attachment
- content: (string)
Contenido en base 64
- type: required(string)
Tipo de archivo
- filename: required(string)
Nombre del archivo
- content_id: required(string)
Identificador del archivo
- disposition: (string)
La disposición del contenido del adjunto que especifica cómo le gustaría que se muestre el adjunto. Por ejemplo, "inline" da como resultado que el archivo adjunto se muestre automáticamente dentro del mensaje, mientras que "attachment" hace que el archivo adjunto requiera alguna acción antes de que se muestre (por ejemplo, abrir o descargar el archivo). Posibles valores "inline" y "attachment", valor por defecto "attachment". ADVERTENCIA, la mayoria de SMTPs empresariales rechazan la opción "inline", por lo que el adjunto no se mostrara ni estarà adjuntado en el cliente.
- document_link: (string)
Enlace comleto para descargar el contenido.
- content: (string)
- dedicatedData: (array of Data)
Información de las variables de la plantilla solo a los destinatarios de este recipiente.
Items: Data
- key: required(string)
Nombre de la variable en la plantilla.
- value: required(string)
Valor de la variable.
- key: required(string)
- dedicatedSlots: (array of Slot)
Información de los huecos solo a los destinatarios de este recipiente.
Items: Slot
- key: required(string)
Nombre del hueco en el modelo.
- value: required(string)
Valor del hueco.
- key: required(string)
- to: required(array of string)
Examples:
full_example:
{
"from": "no-reply@nautilus.app",
"alias": "Plataforma",
"language": "es_ES",
"application": "Nautilus",
"uniqueMessageId": "548512",
"metadata": {
"myOwnInternId": "Abc1234",
"myTittle": "Tittle"
},
"scheduledDelivery\"": {
"planningId": "5f71abd9273bae2e98f6049b",
"timeZone": "Europe/Madrid"
},
"sharedAttachments": [
{
"content": "iVBORw0KGgoAAAANSUhEUgAAAFQAAABUCAIAAACTCYeWAAAR1ElEQVR42uWcCXwU1R3HlyQzs3NsOIWAWCJnjERbRRCsiBYVUJBaqwX8WFRUDrlErkC0RYjcRkRQqdAWbbmFingrBARa5AxXKKccQu7d2d3Za3b6e/MmsyQGE7KzC3zK5zGf9zZvju/7/9///d//vRmbFsd/odBBf/ATxb/Ao2R5lEluZajs/aPHh/x4xf+WP7A8GPpPOOyO2/PYYkx7wOub6nTfV+S0FZbZivSEfLGREoqdiTRfRFN5nTL5ZrcyMhD86tqDDwQ3yd7HL0JNKnYKxU6pxOUoT5I3yPtCfJlbRLFSQs1iJ1ustwWazOnu4vMvvtrhw2GnR8nUBUilWhnMJA9rYk5O28zMm34411j28VVXizQEQ1vB5fldMLTjqoNX1R+d7vsLCTOS8DMwSN4Av2BhiyP5L2varJdGPnDidGOnxzilulZIQCuUuJr6gxuuBnhIO+zyPKRjJ1LFrjb5VO6VyV01bZqmZWna9EEDO2ua6PbxPhUqINagFTjaBMHQ7isJD2OmYyfUDFvy+AUlJGha0tiX7wJ8Xt4gTZu8OXfgosXtNuamTRjXwR9u4lJoL6i+CfSO0P0KwKvh4hJXI0iAYteEXNWEpR9k5MxsvWZNmzmz0zTt9YKC0bt2Pq1p2Tlze4wa2kjz2ka/eMP+Q+18IXvN+NER6uAZ/IHV8YP3+d/TBc7VDJukgMbNnXXLuWO2XdtsE8emLVvevLBw/KaNAzbnPnXu3MjVKx97ddKv+vdL37YxIWss++XX6W4f4a9ZE4jgR9eLB7zL07vmAqcJ9izvYPra5bYFc5Nz3uygavXyj96wZmX//PzBqpp57sfRYfXV99+/TtMSZk6/GY805OkUv5pK+3/NklTkhBVIDoeDMYQvkVvgNjXHLrdwwiuT03GvOTNvQoeHVmuaNGPa7zVt6oULo9DtNW3GsBduy5l3a9bYZFRbOKdOQUnLUrnm8FQFWEglpB6NCbzuqCRcLjmSEhJnZjfFvcYMb6aEMmbPaTclK6Nn95Y+/xRN+zMsX+7GJ9+cY3MV4mFIGjuidUATIE+ce5n8PPpjILjVYnh9JGNwg1rBC1OnEMmrim3mawlnjxmQK5ba9u4bvDn3yX9v0n8JkuOLz9Tfd7CVyyvU7l4wATr/ZsvgS1xNAI9L1y7Bh/tkw627txnMmt8W9NhCXpL//F+2RW+x9Ee/y/bcH1PPXmjp9hvWLhr+YCjPAvgyOb24xv380v5s8rDn0hQnATaSShShrKBOybk6INfCtuEvwCI0KDO9vaj4BfT/cDgQFbzs7a+7U46okxjSGk99rf2saS3mZDefNLbtF+vr4O4/HEnwy6QtZk9r4gk2LZUtIDftH1Sg9vA+/4eFJrkV/EqIV0LJ3hBMer3MMam4+9H9iejqYcU2PTvDpxrabh0/ZoR31wYeQYVCczy3Mkmywm/K7fj5OiLwwtNE/nOz6xaWptKxzdoEtVX8Cy8bvsSVAs2xnNwbgG/PT89ujFu7CkhvLzhtW7L4Fsx2LCenLnAh6fzyZcB7fbMs6uqV3fv33m2fldnykd63nThCJF963pbR9salH94Y1BqiQmz4mVK53WXA6w6sxUqoauz7i26WCwxrv3NrIo5hr678ZzClyYDzZzm5qfwIENYI3uXpg9mSVTcuc5OEoXvt2l+npqQMHyJNHCeNHCq2SOG7dLI/3IN9tHfisGf5bnf+YsHbjwY0ovxOLxLOslD4Arzy6uFVtchCOweAsxekM+clZNDV/WHxXCFm9Y5il+T2k796g46Q5iiRJadXOF/EnjgtubwOHI//IBWVSZpmGT/gvb6Z1cC7PD2pM2dJCmuO3r3ZDh3gwyV/vEGw2RL27hd7PsTZbIk2WxJS/ye5xX8TzKLkSHK6HbSI412/Zim/VW7Pz8GrYSfEDrFYCD/gSa7vb7ljpySQb94qohV69OJeGMJpWl3kkeYvFOo3SDKLJ36QgK3nSSusXCN4A5YJX/HnXBLe7X2eerIWwg98mmvfnoUk138qggepT1+uRSozfKT9qYH25auEJX8X8NdRL9mfGWTPnGwvLHVcDP/PFYI3aJXweaQK8DE18oB/5lmuQQMGGNt3iGo5fKvWzPiJ9sFD7WvWCYt1+MzJ/LDh9ilT7QUlhDm5Ljkl/WaovcVmPxD8rgp4f2Ct5WM7Vfsn/mD/xzLS4fMOSVTtBz3PIWOqfb36ldX+wGHp6ElUtnzMT3B5flsFvNN9L5ZWLIfv25ft1IkF1Utj7KCC5dcNXtIvf8W2as1mvcr/ZQkxeLfdzqbdxN7TDbMRB5oJ9WVfTBw+CLgK+Fh48rLi2PYfceNmERmIcfVaAT1/x25xxSph2Urhg38KW7aLsIXL9eI/lguogKHur0txtBS7suZ/YcCbq2umzlvOj0TzsNtuHykqQSMh7/REinABSmVkYkWOBP/N7R1UAd6tDLfWzptOjl9F3NpRSYd9IUCadVBEpkIRR6PoMYuW2fwSZ7IJb4ZrWGvJIUA8d848flIWvycP41zEELwxj5cV8OsuYIE05w3eGzDI4d7hlAvFEvJQivNFEirDTbSOn8zzDPgYdXgo8O59IvXVMKrDhvUfwKkaaZG1HxML91o2H9KI2u85IFELR8/66ltyVo+eHHUK7r6HQxGXkhVru/03BrwaPmd5h8dzA7vfAGNI+267iCEdbMg3acJc15jBX1EHJmD/YQl4JvymLSL1bWEIYRpp8+07CHjr/XybPsKvtxYetvrwUYpkdFdAAswTIGwUFUjz5sPfqgyPoQHFIcPs8AsbNWImv8KjaC08RnvZ08+AV/xvFllq7dBXfywkykx7Pvp2SCMJqK3bsHd2ZiFV+LbgB/P+fAMeTeZXDXgUcaQVYgDPON0dDXi313pTD85Wrdi6dZnzhRLyw0fYn+jHnTpLOG9KZxtdx7Rpy4Jt5Wrh+Gniz/pUMvmFncv9zoAfNdq+aLEQG3gY/AYGPLZ7QBOsH+TCjrQ04qJTGWJK17KlMb1Fc+AI3cbvYEaF8pSw7hOB2j+3j2gNMiju3GMlPF3YNeF70zm85fyAREwC/R8ZqDQEq2BIlyNjYWGphGpQeKAiIQNIGvwxL1Iqm0WLRzvy3+nuStfhYpEom5k3yc1f6JEms/iTOjGDx6a36jwc6x1eFwnUUesIPNMLjlO6WO37QO3jRo7Rbscu8fs94qEjEgY/zF7hxsEifL1RrH4+Y73ae3rFDR4O74zZPOzcuvVi06YMpvFt2jAL3xX6PMLNmsN7g3GHxyyHxqrjk2DAW7dmcMQcHoENNASmtAjaPNybC2nxeAB9l4XdgPf6suDkxBHe0bAh8V70Y10MhwveEUaMsn/xNXbjxQeeK5VbGvBKYEk84UG47mMhqBnHDZ8JR09I4H/jTd7jjw98ktPT3YAPhnZR3z6O/BcfzXgGivGBt3mUMRWmtHSd8P8hQc19gaUReHQDmIEoe3IgbOT9KorUw4skiDesVQjaqCiqFS4SNCojQ5UCeSPmEzKujyJ+jMop0HesHTfgo/dw8WSIvb4+gwce8gve5TGMgTM1lUm9kbnhF4woMliN6Psoh2ks5Qf5E3/gMOyZ/ECakMmjJhIysIhffisi5o9rovKLI+yICOHiGA4R1d+2A95+VI59BB6vfkRj8xCE+vQLETMQiBdsmKJgHYYuucCqITiDhToUW7QgaxVUqiimpzNACpUXO3Yk8zyYPSRk7uzC0ikdQrp0/u9wMMjQtT1Ni2Y+26UCvBouirLb42nuf4Drchd7d1e2wx3kud0Kma6dOiNBUeHDoQIC9ZOyIvC3/pLFKhXgod7w+VCZRripVqN48ozU7V4OIS2E2FCkzB07sQ89zCFT+xU732wT3tyH0gBDf5RzOLrYigwcVcAjTxOdsbdtWzU8lGX+Qp5lyeBvOkIskwT1QfALp89fwHfqzKalsfgFl1r/KVYva+/bqeGSyvAeZUI0mk95Hn+cw6oztXZU8nTqjkTDG69N45EHMI6AHz+Rp3869F9SmV5Elyop7j0gmQ264B0+ewZP81HoPKSbUsWKjaoWRK/5UNGH+xjwsg6/9EOyDoNjWCOSv/12dtwEO8IYX34jdu7MZmSAnxQ//8pYt0frICFz730sbQh0JRQLSqT8Y+SCvR7C9aMKXVa9SouNO9HMbTEUjR1vnzDJjgz6udMjwWNHHBJxq5QUpqjUMeh5O5boIHC0Qs5bwsvjyovtWCxOQwWmTecR223chJn2OjTCMKWrPhKg87Qh0FiffSl6/LXfmXXJJWp/YFV0rh74zdEe/JXHeTVSJL5AKFKkZ+FoFisMJaaokaHktYJPdHl6/dy2FH3XJh9/r6tUjrFLq5u6kHri5+AV/6KfCt/lrSBDVasgtLBWQdRK0Dyrggy9QRSpP19BjLJPz+jilSv+lcY26PhHfrmk4uCylSvISuXJTJm7U/Vb0VCPCt9kyDtILE2dOkm8QFZaXhhsz5xkN4exrl058FNyFNFFwY+zDuRLKOa8RdwyxC3Xfyai+M0m0XxQFOEaYeMVHQtxRNyaPrSqO0iH/yvhUjv3GsHsWzJYc+CEI4TNHLRYrx6Td0ikjpBZYcs2XMokp2I/WT28P/DRxcIHFVYgsJYOc2XnkrDShh1V2GnTrRsHYSLwjL/CtoMQ7i3uiqUoPIesUHi68GCgoghvD9I24XO3iPd04+69j4OC/GkKD/nTO9KI9fFTEqrtO2TAN2xADCFsB3Y4wFkY+Iy9cxdy4iN9OUFgqDv4750iIsKnf5R+siGjR013YJbKbc14rqnP77wn1E1OosPyU09xd9zBIg4H93vXXmPvAXVOKSEe7qAOf/31DAIVM2fzdjvRmkrwG3NFeLj0d9pkF8EnLl8l5m4V//aBQOFTmrC4FLx6hD0QEccGJoyOCIdgzVMUDfhlKwScghEBQ2OpXMGZryk8XpOstG6LPjZvvuCQkmgnf3YQCT9hxlK/PoOHwI+IRuhCrottRtc3J48CeLreiCMS2uinkl/3sYjMiJF2qiOQmMsbgW/WjGnenMEcicKnprKiRH6RJGblR8JLL/PmighQ6SlNmzHNrmc4jtmfj3CoufF6Xs3h6d7jGTitSnhzd53puuGYlEQ6GwZw3BsPgb1Hx04ai3B3dGTbtWPRLpeCp9fBxObBHrhmBL6whGROnDGu06ghA/fWvCnU/v4HOXodzCPpKXDSaAW3z7Bz0OJavGxAdywkmvDYQpCYYMD368fBb0G8FauoK1YLHy4jmrn9e3HD5yK22WApEo5NQbGxtejgEQkmk3ZjKOTF8F9/K/7uMY7lyD48FEcTVz/S5xHbxn2xUE2vU78e0/1+7vWZxNTt2idiqbPTnUQAEzLt6FMUHteZms3Dazx6EpaIKHztXzPR337naVwBlnnIUHtQH8zeX8I//gT36GNc7z7c7Lk8NlXNe5unQxcsEKw0nhJ7LB7oweHpoX5IMOBQlj15UOzIfP773SRo//Sz9ts7sGPGovtEItyYI2JGiPseOS4hD7ZxE4yb9uzFYY4MWwBvH9cB52+6c8g89nuOVoBG7D8slsq2YHBL7eFD6im984uUH+TmMltYMxLwAHxRTAao+J0eK+06x48VirIS8fwqxa3Dxto+DQHROE/kpmhlJYhbm7eDvph/pefCjZ8S7dtV+HYDNX7XVpTO6XnQmvfq4PaB/xoiL5NvsfKNSq9vOpX/tUCeYf27tD7/X8z+f1UmsrXU6e4Wq7eo6UbNGK1nR/8KqVsZFdv35/GOeomrIRkCXdJVQ87QrXVx+mwEvmykdwH+SmMTVS+VW+C12bh+MCQY3E6a3HnFrCC8TwjA68u+Yp+K8SjjiArEtwlgdHBTvCdrCjz+8KYVCOFl6/ImEGOq5NC1QqLnacHQvqvo81BoArf3ufKPYbGWKgJ9N8gGbISigqG9V++HweAOYhZZGPkkmBiFnDn6eTBkPMpE82txVy28qQhexf82dvhV/Awco8tQQqoKVdBVJqFIB9bVuw2YQ2r+tfg9PHNqeAzeods7GMujJa7GAKsyYS2pTG4vewd4fbODoa3X+McAq//GlFNVz165+wP+//jf/wDBiz9SculpBQAAAABJRU5ErkJggg==",
"type": "image/png",
"filename": "yellow_mini_shared.png",
"content_id": "aquacislogoShared"
}
],
"sharedData": [
{
"key": "company",
"value": "Aqualogy BS"
}
],
"sharedSlots": [
{
"key": "body",
"value": "Aqui se va a sustituiar la etiqueta con el nombre body de la plantilla"
}
],
"recipients": [
{
"to": [
"rok.torutev2@gmail.com",
"rok.torutev3@gmail.com"
],
"dedicatedAttachments": [
{
"content": "R0lGODlh5gDmAPcAAP////8sRf8oQZ3j+P8eOQCpugB93YPd9tLy+5ZmdLoSH6wAAlvO8nnb9WfW9QCN4v8LJgCC3lvU9Mbu+35ZZgCK4e0jOf+xuDCpub/t+uytsVPG3On4/QCt6gC+7QC87QCr6QDF8AC81QDo/bTq+QC17K3X3P8UMOT2/AC3yACV40zS81jK8cJpfvn9/sYTIQClttJZawDC7wCS4gC17ACl5/8wRwDL8TbP8gC67LY3RwCTpwTc85Th9wCH4ADJ8QDm/P9jdOmNkv8EHwCj5+lTaQCZ5P8BGADY7ZuZq4WMnP8VMI2puwCe5gDH8P9XagCh5qTl+I7f9gC97Z9zhv/m58zw+6IAAKnn+eH1/P8VL/97iQCs6QCt6gCx6+35/QDD0wCF3//X2/83UKpETwC0xMAAAf8GHwDv/ACn6CHM8vkzSYXV5PT8/kfF3K8OGZTc6VPK3iHt/HC3yPL7/sEqMsx5jQC17ACe5f+apfhEWgCg5v/y8yDF77v4/rzm79nz/Oaco/8wSz7L8XvU9L4BBQC+7cAECgCo6DfD2v8LKVSZqKJTYP7//wD2/wC0xP8EHrkOHcnr89hDVACx6/8fOf8tRifB2tlpfNz1/HHQ81vD2fXIygDB7v++xgDV6sgAAv8NKlPV4wCe5UbC2AC+0vr//7WVqccABa4iLbQEDgC46//N0wDg9XLY9B6hsf8+VAC27ACxwtjx/Nzy9+H4/W/Q4qbf67oHFfr9/gCp6P8tRu78/q3o+cPr8iq+14PY9D7P5P/9/f/u8LHl+ACgsgCg5gCx6lzL4P83Ttv0+/P6+/+PnP7+/v8sRdbw9vjf4f79/v8pQwDR49Dw+/3+//8ABuDv8/7//qcIFMvn64zJ0//+/5r///EXK/8zTq7v9f///q+JnuXJzHDBze/3+ACx62l1hACV407I3QDQ5fzv8b///2TM1QC47ADCzgDB2gCc5f/Izf/3+LERHZ7h94X0+qzi7d71/Ov3+gCx6vX8/gCftEy1xgDL5eXy9CH/C1hNUCBEYXRhWE1QPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS41LWMwMTQgNzkuMTUxNDgxLCAyMDEzLzAzLzEzLTEyOjA5OjE1ICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgKFdpbmRvd3MpIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOjZEMEU1NEI0RkFGQzExRTNCQzcwQ0Q0MUM3QTg4ODE3IiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOjZEMEU1NEI1RkFGQzExRTNCQzcwQ0Q0MUM3QTg4ODE3Ij4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6NkQwRTU0QjJGQUZDMTFFM0JDNzBDRDQxQzdBODg4MTciIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6NkQwRTU0QjNGQUZDMTFFM0JDNzBDRDQxQzdBODg4MTciLz4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz4B//79/Pv6+fj39vX08/Lx8O/u7ezr6uno5+bl5OPi4eDf3t3c29rZ2NfW1dTT0tHQz87NzMvKycjHxsXEw8LBwL++vby7urm4t7a1tLOysbCvrq2sq6qpqKempaSjoqGgn56dnJuamZiXlpWUk5KRkI+OjYyLiomIh4aFhIOCgYB/fn18e3p5eHd2dXRzcnFwb25tbGtqaWhnZmVkY2JhYF9eXVxbWllYV1ZVVFNSUVBPTk1MS0pJSEdGRURDQkFAPz49PDs6OTg3NjU0MzIxMC8uLSwrKikoJyYlJCMiISAfHh0cGxoZGBcWFRQTEhEQDw4NDAsKCQgHBgUEAwIBAAAh+QQAAAAAACwAAAAA5gDmAAAI/wABCBxIsKDBgwgTKlzIsKHDhxAjSpxIsaLFixgzatzIsaPHjyBDihxJsqTJkyhTqlzJsqXLlzBjypxJs6bNmzhz6tzJs6fPn0CDCh1KtKjRo0iTKl3KtKnTp1CjSp1KtarVq1izat3KtavXr2DDih1LtqzZs2jTql3Ltq3bt3Djyp1Lt67du3jz6t3Lt6/fv4ADCx5MuLDhw4gTK17MuLHjx5AjS55MubLly5gza97MubPnz6BDix5NurTp06hTq17NurXr17Bjy55Nu7bt27hz697Nu7fv38CDCx9OvLjx48iTK1/O/OWwLZ6aV8zj7IiiLVWkQ/QE68gJGwKOEP9gpp2hmCBDFNnY5cyZDQJHYF0of5DPlhNDBNhoz3+XDUVDPMEKfQNRJ95+/CXonjPpbTFMeReMMcR37Clo4XtHCJBHcyg0QAUkZwhQoYUW+ndCfPMhl8sticDTygaYLAGBMyOSmKB/AAYhhnG+xCFCInFsgMQITBThjAA2vgcBASOCN+EW8wjnAhsiXBJHOlhukI4jjhSxRIkCQCCAHcmE2CQBkFjASUQNNBDRMvVIoMYPKwBDjUJZEOIKBwuRoEkPCw3gAEMIaOIAHRERI8EPMjjBQD0uQDQBIWrIEMIgwExgED5q/MmQAwxIUM2biSSCZTobCElkEQIg2Z8zEED/UMQcI2wS44zsfSOIBVcEApEyFVSAj0O19EHEAxEYoKwPRtxRD0JRhOEDCQt1YkANCrlghAHUKnSAAQ8g8BAhXMwQwbkGRPBAGoOYwpAUXaATRrrnMqsPA8oM9IU+BlRwgEIfKLtCI2/GYSqqbrRiq4w0trfLLiecoUcSrSCxyZBFQlDJGBa8kM0VGkAUwgMPONGQFMaEEUYTdxjSSQ4gIPvAFO4W1MsMRmSw0A8RmKOQBCTnsFAPDzQBSEOZ3FFBBOh0kUMnH5hjRAQ+INLtQfu4g+wMIDxtyB26mBtBDSgQpA/TOh+Egw8+rDDRMgbH4QY86thxhpn8vQeJM+J8/zJCOpukukErrZyyxgtvvBHJAiE7xEET6KDTxBcLAR2GEYPMQlAuPSgdhj6REkQCOjnv3LNCYRuBjhUKEW00oaOE8UAsURQ0gRPyolO7QXRwEUYFzuZCEB31yDCDD0cPxAsRERhTi0ENPBCGDBTtg0wiv4gABwKGQ7DEw+B5t8U63QQjAimCb7BJMI4kYIYCCizeeENrQwFF260/4EMamiLUh/SrKMjoSqcQnvkMIa67Xyfy97pspcEHM5BAQqIQDx+g404FuYPsBqGQCRiCdQSxAjoi0AUBmusOFcmFG0phC0kAQBit+IQ4bBCiHO1IIC64BSlE4Ib0AcF98JOfQ/+aUYMINMABEdAFwQ7yOB8Q4XkKUYP+JDiQAaYtIQZMiDkMoAYpMItPCCxa8hLSiTDMwBULyYARwnDAgazABw/AQUOEV5AoSO8DA6mFMSJABERR5AvIuMdAULAJdYwgDi04QRCiY5B8sCERPgRi/BjnEFcwSyBG8IGbDvKDMKDjigrRIBT2UUXSgZKTpztILx4wg3zt8QYJcd0YDzIBdFRggQxxBcmkMJA2NMEHbZyIBCrggx8IpAtMA2H1SDlIN7iBFP5wRCBShJBb/EJwP3zfJOe3EBAYAJcBAwHWahAGQziEBDN4wL8EYkXTBZMgqzAACgGghuYx0yCyLKAP4gH/RoaAIAwBFMgBWDmAi4QAjg1wguwKypF8uKFKcGiDGI7whBsaRBIiwKYkhciQHlRgdQKZwAwqwFCC9AIdDwCUQ0AQAeqx05TupGU6Gfq4MFARn2IMZQSE5pAb+AAKlAOADMKgRIwoTXUVuOlG8iECW9BCIKw40Qm2wAeD/CGjqQICFbTJ0YVskacCuYM8oZdTh3QiAvooJQGxmMqCGMIA4hxICJLYjIPkEyF0qIEPYOkQKTzgkwJZxU4zsg8uoGMGIfjIM/5AkKg6Az4C4CYArppVIDCiEEGkZJ9Y2T92svKUEvBBDULXkBu0tZ0FbOsgM7lOgXAgk7zEaQMPgo/7/7ntnJHDgkDOhkuMSKECTSCtRlwAB1sUJKoioqEO3sFYgVyVB0Bggg4OAb9tMiQHEZgnQe4wWII4QLR+bIgT2nqztSIkiwXhGQhGRRBDqHYgdz0ICu4nR4dEYQbo6EVYI2BO+d5BH3cIcBdUihC/ApUjf4hDCpBx3BO4SgsxKMAOyHENAPihVowwgzYzK1mDUIN0ugCBiEXcBV2oTlwD8asROnvd7gJgdIBVyHjfSQfI1aALIx6xER6g24LE1yCN+KdLG+KAChgBxe5950AQ4AMDsM1cSjXIQKFQNowIgx1yqFIijEsQMTi4PRBOAQx2UAx7gIMKuDADLqoLP1xoNv8hMniAEdJJsjrj7AFDBgA1jFCBQTWkDSmrLwAmMOfdJcS92hXICuSM0jqT7M4BJciPDeLeuDYkB2EAATYUzawsHKQNPZBCDw5gjAdsEiFTrvJFqoAJDIwACb/gskAykAQCPDgGKcBAKVJwjlSAgrpsjoQZCpEAbeBpxz/ohbKXrWwnAFfVADDHexOyAiMrM69hEDRCWGpMgui1E8xm9gpmMINTTrogB6jAA2K7EARkkq8AQAA69sqQGlTg1AdJdUaGAYFQ2CEYIxCFQMpBDlmcoxK3BgMYFqEDUGCWzQoohBnIQCs/pBZbCGlGPCKgbY8+4LYKyUQ8AFqQD0TA0gf/wUI6DQ2AA1jQ09s2QH/hW1aEVEMXPjAGLxhyh04TBNNGyFdC8npvbz2AyhnhQzJCcYZkJEEOvDDBK3bwCCUgHMwtSAEjDoGKSEA84qlQAhCA8AsXIiQXRYT3QcZbAzqG1YzsPkgtHjgDZQrEjnFMCCKIWpAuGACsB3HA5WAukHPX8QEV4MLO4UxMkAskE2tMAxQRYm98S/no0K6I0pkkoycwQRaywEAKrO4qaUzC12v+eiHIgAQ5BGMTZU+IBAZ/bB/42bUpQwcDEFIPIgTr9j834+4LkgWlPaCkABjAZ7NVRJPRvAn0IyYinmWQCcSCmDMnyADMRYS4EyQLxih6/0L0jZHNN6zfMcCAwknfnjF44+FfVwAozjGNfiADGbFHiC4i0FsyJrEgVhA7FdAFK0ACWYACE9AAdzADsqNtw5MGsnMHDoAFJNADN2AMbKMGBbFFiYYQOBABkwNfM9AEDTAAJniCA1APoIQDDDgDdyABA0ACWOAKhrBGFTAFCTEAU/MA+oADPUACJBAFriADRDA1UYZumJd079EfYSIAVLBwV+cMu/IG1RUJqQc/qJAAKfAKGEAKl+ALCLECBjADGKQQVjADBhBltRAL5mJGUFADTYAsFYAIBMZEd4AsEJRO52IEjgcAPUA1LIcQX7AtiSVQHxUsiIiIBvBOPYAIS/8jO+TmA1QzCsB3EFbAhufCSunUZMwSCyxmEK5gAOhAeBYxDzaQIQhCI5WgBUXQAgkyhfCjCgsAcVlYChgwdfxgdgVRDTmADoXIEDKADh+wRAQRBYaACHxGOuxCfR3lDmnQBEZgDFzQB3YnECGADoCnEDiADubgR1GACF0QjuIojqPgfATRCAdwjFBgBE2QBrFACEHFEMTQB/oAh01gDF3wAQ7wiXY1CuaQeRVxHunxMA7jDFpQCam4K/SAC1egChoQCLOIhQlQCsWwAxhgAm53jm0gEXRAjAYxC05AMmngfQBZENGQBbOQDwmxkRGxD8JFEdyAArOQBdFAEcsACID/EI8tcQHdQSE28g28sgAxAA0AoAFXUF1ZKAvFsA0vWRJSgAiSWAMy4AAKqHOTkQfhQQCp+IreMAlrIhCBcJTwswAUIAr/0BKm4ABcUAHp0mQ4kJGQ8RwAsiAJsgSTYHEDEZYKsABXUAfjIBPEcAN3MApqRxms8ATpsR78AWGyQA5nCQBheZRCcBPLsBk8eSBgFgOPQGbbYApCcAWYsA4EMhDhwAyQZQNhhgEV+Qga8JWjSRBVEAQAEmb8sAP9YAI185oGIQ9PYA2TUAAXaREocDUCQQf3FG8TkAWzlBMuoDNZoF93kQcx0A6VaREccAcsZg74ZggD4AqVaBJ00JQK/8EBhuACE9CHdJGbFzEnAyFCgqYMeIQDlmcSDsgQXxACw1IZgJADzCQDrqAGIIQDsCQBB3AALEB4GcACaAQAyrAPX8ACtfMFDMAAOjlozEQHfvQFVuACPcAAtWMFLHAHdiIQrsAC/XM0Hapq98kBdMABKIBiAJAFmjIBCjoQNHoALBkYneAmyoBCasBXH6AzEtAFEsACq8A6A5ADhHADJoMFOXAAfaAGHqQJmmAIMAoAIeBnH+BSOCABCHADwPCkVjAIq6AJVpALP/ADhJADgHIDH+AKU9Ba9/liaoACMsCSThAFJKCk7NkLIaAJP8CPfSEFC6QGiWUFQjMAeAQAP//gfDcgR+YgAbWAAMbQAxwAAjD3AR9QC7VwB4CXAdTzBeaARy7QCZkwEAxAPaaggQDQAF2AALWAA9gSAv1FWvfZCBlgTD8wKFZAPfqwArUACEQwAFKQfYPxAYAQAmljCBmAAwu6Aip1AA5gCjkADCsgAQxgBSTAqgDQCSwgASvAAHUIAE6AAlJwRBOABd0Gru4gRwjgBARzA+4AroZCTz1GELeaARroQfTUAHRQrdfKAjrzA3fQWoLhAEQgaAMAAiEQOvJJoqLSfy0Hbx+UgziAAxxAAjegBjpjqF8wAHJkBd2mBlH2A+MKAPnKqk7QADjQBuR5EHvqfX+xDzOAb03/8ItOQEUrYEw4gJ2zsAKAEAW9JQXmEAWA4AAnCwLzpAvzlANSQAcfcAcokAWrkAEIAAgSqAz1MCgyMJ8cMIx+KhAf5mdq4LMrQA2AACkhgJ5/IQWkGAWdJQU9FgWxhQNTYAg3wAHUgG/FagghQJwC0QDr1ADUB6orgAOdoDmuoA9uQg2GYAgy8C8HALgAQAeu0AgI0Fo/cDV2i7d6KwOGsALiKRmNoJ4GcZwOgboFoboUkZGjq5uwG7uyO7u0W7u2e7u4m7u6u7u827u++7vAG7zCO7zEW7zGe7zIm7zKu7zM27zO+7zQG73SO73UW73We73Ym73au73c273e+73gMhu+4ju+5Fu+5nu+6Ju+6ru+7Nu+7vu+8Bu/8ju/9Fu/9nu/+Ju/+ru//Nu//vu/LhEQADs=",
"type": "image/png",
"filename": "avatarLeandro.png",
"content_id": "avatarLeandro"
}
],
"dedicatedData": [
{
"key": "name",
"value": "Kevin"
},
{
"key": "surname",
"value": "Stone"
},
{
"key": "city",
"value": "Barcelona"
}
],
"dedicatedSlots": [
{
"key": "header",
"value": "Se va a sustituir el hueco marcado como header"
}
]
},
{
"to": [
"rok.torutev1@gmail.com"
],
"dedicatedAttachments": [
{
"content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBwgHBgkIBwgKCgkLDRYPDQwMDRsUFRAWIB0iIiAdHx8kKDQsJCYxJx8fLT0tMTU3Ojo6Iys/RD84QzQ5OjcBCgoKDQwNGg8PGjclHyU3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N//AABEIAJcAlwMBEQACEQEDEQH/xAAcAAEAAQUBAQAAAAAAAAAAAAAABQIDBAYHAQj/xABLEAABAwMABgYFBwkDDQAAAAABAAIDBAURBgcSITFBEyJRYXGBFEKRodEVFzJSk8HhCCNUVWKxwtLwcpKyJCczNDU3Q0VzdZSVov/EABoBAQADAQEBAAAAAAAAAAAAAAABAgMFBAb/xAA0EQACAQMDAQYEBgICAwAAAAAAAQIDBBEFEiExEzJBUWGxFCKR4XGBocHR8CMzQlIVJCX/2gAMAwEAAhEDEQA/AO4oAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCAIAgCA8ygPUyDzKA9QBAEAQBAEAQBAEAQFL3tY0ue4NaOJJwFWU1FZk8Aj5b3Qxkjpdo/sNJ96509Xs4PG/P4FdyPIr5RSPa0SFpJwNppCinq9pUkkpfVDciSG9dQsCgI+43WGiy0/nJfqN5ePYube6lSteHzLyKuWCBnu1dVPxE4tzwbEN/wAV87V1S8uJYhx6Ipub6FHoV0l63RVBz2vx+8rP4TUJ87ZfX7k4keH5Uo97jUsA5kkj4J/9C25e5Ij5kZ1FpBI0htW0Pb9dvEeXNdC112ae2uuPNEqfmbDBMyeMSRODmHgQvo6VaFWKlB5RoXFqAgCAIAgCAIDCuVfHQw7bus925jRzK8V9ewtae6XXwRDeDXGtr7zMSSdgHnuY1fMKN5qU8+H6Iz5kZfyXbabq1dZl44tDgPdxXsWm2ND/AH1efp9y22KLtNb7TPM0QTue4HOxt8fLC2oWOnVZrsp5a9QkifG4L6FcFyLvVyFFEGREGd/D9kdq5Wp6graG2Pef6FZPBC2u2y3GQyyuc2LPWfzcewLg2GnzvZdpUfy+L8X+BRLd1JSWvoLWOhpog544hnb3ldape2dguzpRy/T9y25IwHaRVRPVihaOwgn71z5a/Xb+WKRG8vQaRPziopwRzMZwfYVtS155/wAsPoO0L9RQUd0hM9E5rJO7cCewhemtY2t9DtLd4f8AeqJaUkRdDWTWqqdHK07G1h7PvC49pd1bCtsmuPFfuiq+V4NuikbIxr2EOa4ZBHML7WE1OKlHozUrVgEAQBAEBS4gDJOAFWTSWWDUnbd5uuMkMJ3bvotH9e9fGy36ne4XT2X3M+8zJulf6OBQW/qBnVcWcSewL16he9ji1tuMdcewk8cIogsbjH0tdOIQeR4+ZKzpaNJx33M9vuSo+Zn2u1U0NQ2phqTLs5AxjGfJdKx02hTq9tCpu+hKikZ9xrGUNOZX7ydzW83Fe+8u4WtJzl+RLeDWaOnnu1a57ydnOZH93YF8pbW9XULhyl08X+yM8bmSF3uDKSIUNFhpAw4t9Udg711NSv428Ph6HD8fT7lpSxwjGtVo9Jb09SSyE8ADgu7/AAXj0/Su3Xa1uI+/2IUM9TNNXZaY9G2Jj8HBLY9r3ldB3WmUHsST/LJbMUemitlzY40hbHIPqbseLVLtLC+jmjw/T+CMRkRDHVFprsEYc09YDg9q4kZV9NuOfz9f7+hTusk77Tx1dEyvg4gAk44t/BdbVqEK9BXNPw/VfY0msrJXozVF8D6Zx3xnLfA/171poVxupui+sfYiD4J1d8uEAQBAEBh3iQx2yocOOxj27vvXi1Go4Ws5LyIfQhtHsRUtZU8S1uB5DK4ejJU6NWt5L9slY8LJa0dhbNWSTyb+iG1v+sef71jotJVa8qs/+PP1Ihy8lk9Perg5ofhu8gHgxoKyarancuKfHsv5I5kyaoKJloimmmm2gRk5GAMfeu7aWkdPhOc5cfToaJbUQs8k95uADGnZ4NHJje0rg1Z1dSucR6eyM+8yQrqmK00opKP/AEx4uPEZ5nvXTu7mGn0VQod7+8/iWb2rCMWzWw1J9Jqs9CDnB9fx7l49M0915dvW7vv6v0IjHPLPbzdOmzTUmBCNznN9buHcp1PU+1fYUe6uPxJlLwRXQ2B00PSVL3Rk/RYBw8Ve00N1IbqrxnwX7kKBgzxTWmv3OBczDmuHrBc6tTqadc8Pp+qIfysldIo2zUMFU0b8geRC7OtQVS2hXXVfuWmsoqsZ9ItE0L+ALmjwIz8VfSX2tlKnLwyTF8Efo28i5NB9ZhBXL0OW26x5plYdTbV9maBAEAQBAYV4YZLbUNHHYz7N68Oowc7WpFeRD6EPo/iWkrKXPWc3cPEYXF0ZqpQq0vF/wVjyi1o7MIquWnl3GVuzv7Ry/esNGqqnXnRl/wAuPoRDh4LAdPZbg47AI3gZ4Pbn8FinV0y5bxx7ojmLKq24VF1kjhjjw3O6NpztHtKm6vq1/JUoLC8iXLcZ7nRWOjDG4fVy8Tj+twXSlKnpVDbHmo/79ET3EYdqt76+Z1RUuPQg7yeLz8F4NPsZXc3Wrd318WRFZ5Zcu90Eo9Eot0Q6rnN3bXcO5balqO//AAUOnTjx9BKXgjMs1o6HFRVDMvFrDwb+K9mmaUqWKlZfN5eX3JjHHUu1F+p6ed8RjkdsnGRjGVtX1qjRqOnhvBLkiCqpZbrXjYZ1ndVrewd6+euKtTULn5V14Xp+Jm3l8ErpFI2CggpWnrbseAHFdjWpxp0IUfH+C8umCqxg09ommfwJc7yAwraR/isZVJeOWId0jtG2l1ya76rCSuZocXK6z5IrDqbcvszUIAgCAICl7Q5pBGQeKq4prDBqX5yz3Q5BMYPP1mH+vcvjcz0y89PdGfdkZN1oDK4V9vO2x/WcGcQe0L16hZOo/irblPnj3El4oogvYdEIq6ATAc92T4gqlLWU4KFzDd7hT8ys3uCFhFDSNjcRxIAx7FeWsUaMcW9LH99A5lmhoJ7lN6TVucIjvc87trw7lha2Na9qdtX7vv8AYhLLyy5dLkJQKKgGIh1eoPpdw7lpf6hv/wDXtu7048SZS8EZ1mtApgJ6gZmI3N5M/FdDTNMVBdpV73sWjHBMHcN67ZYiJ6G11UrpTO0OcetsyAZXFrWOn3E3NtZ/Eq0mUek2y1Md0GHyH6p2ifEqvxFjp8cUuZenLHyxIgekXev3/Sdx7GBcJKtqVz/eEU7zJS+TMpKGOgg4uABHMN/FdjVq8Le3VtT8fYtJ4WCrRimLYZKpw3yHDfAK+hWzjTdWXj7CCwidXfLhAEAQBAEBg3O3x10Wy47MjfoO7PwXhvrKF1Tw+GujKyWTXo5a6zTFjh1Cd7XfRd3hfMwq3emzcX0/R/wU5iZZuVrqt9XSEPPEgZ943r2O/wBPrrdWp4ZbdFngq7NAdqGlc943jLfikbvS6XNOnl/h/IzFGNU3Grub+ghYWsPqM5+JXkr6hc3z7KnHC8l+7Ibb6ExaLS2kxLNh058w3wXb07S42y3z5l7FoxwSuF1yxRUR9LBJHtFu00jI5KlWn2kHHzGMmsP0eqw47LoXDt2iPuXyb0G4j3WjPYy9Bo7ISPSJ2tHMRjJ9q3o6BN81Zcen8hQ8zJmrKK0QmGka18nMDf5uK9da8tdPpunR5l/erLNqPQiaOlnutY58hOM5kf3dgXGtrarf13KfTxf8FEtxt8LGxxtYwYa0YAX2lOEYRUY9EalauAgCAIAgCAICiSJkrS2RjXNPEOGVSVOM1iSygR8ljoXk4jczP1XLm1NGs587cfgyu1FLLBQtIJY9/wDaeqw0S0i8tN/mNiM+Cmhp2bMMbWN7GhdGlQp0liCwWLy2AQEdezVCjzR7W1tDa2eOFzNUdwqH+DqQ8+BrwuVziGyZpR/aYM+8L5v/AMhfw43P6fYz3SPDJc6zquNRIDyAICjtNQuVj5n+WBmTM2h0flcQ6rcI2D1GnJPnyXutNDqSalWeF5LqSoeZsMEDIGBkTA1o5BfSUqMKMNlNYRp0Lq2AQBAEAQBAUyPbG0ue4NaOJJwAgMX5Vt3OvpPtm/FThgfKtuPCvpSf+s34phgyJZo4YzJK9rGDi5xwB5qAUU9ZT1JIp6iKXHHo3h2PYjWAXygMRtxo3S9E2rpzLnZ2BK3az2YypwwZQOQoBYq6unpI+kq54oI8425Xho9pTGQWaO6W6vcW0NdTVDhxEUzXEexGhkzQNyjALM9VTUuz6RURQ7X0ekeG58MqcAtfKtu/T6T7ZvxU4YLkFbS1DtmnqYZXDeRHIHEexRhgyEAQBAEAQHz3rmvlwvGmR0cilLKOB8UTIS7ZbJI8A7TvNwAzwxleuhGKhvZSTecF0aibweN1twPZsP8AgnxMf+o2+pfo9Rt3p6uCc3S3uEUjXkBj9+CDjgolcJrGCdvqdK1qj/N3ewf0f+ILCl30S+hoX5OIAF9wAN8P8S3ueqKw6Ha15S58zaNgfPWzcP8AbM/+J690l/hM13jtesnTCPQ+xGpY1sldO7o6WJx3F3Nx7gN/sHNeSnT3vBdvBxjR/RHSfWZVy3W4VxbT7RaaypG0CebY2DG4d2AvVKcKXEepVJvqSOkGpu9WOlNws1wZcJIBtlkURhlGObesc48Qf3KsbhS4mhtfgbVqc1h1F7mNhvs/S1rWl9LUO+lM0by12OYG/PMeGTSvSUfmj0Ji/MntaehFZprT26Kiqqen9Fe9zjMCc7QA3Y8FnSqKDeUS1k578xN4/W1u/uPW/wATHyK7PU13S/QS66AihuL6+BzpJS2KWlJY+N4Gc7+7O/4q8KkKjw0Q00d71d3ufSLQ623Kr/1iRjmSuxjacxxaT5luV45x2yaLo2VVJCAIAgOV609WVRpLXC72WWFlcWBk8ExIbMANxDuRA3d+7hhb0q2zh9Cslk59FpBrB0BeyGuNXFTtOBFWs6aJ3cH78eTlttpVOhXLRvWjmu+3VT2RaQUL6FxOPSIXdJH4kYyPespW0l0LKSNp1mzx1WrW71ED2yRSUocx7DkOaSCCCsqX+xEvoaP+Tl/z3xh/iW911RWHQ7UvKXPmfRv/AH1M/wC8z/4nr3S/0ma7xM/lCzyu0nt0DiejjoS5vYC55yf/AJHsVLXGGxMxbHpvp7abRSUNssf+RwRBkJFsldlvbkHfnjnmplSpt5bJyzO+cjWV+oz/AOqm+KjsaX/YZfka/onR6QHWDbrrNZqynMlcJJS2jkjjbtE7XEbhvPPmrzcOzwmFnOTuWmGnVl0QYxtyke+pkaXR00Ddp7h2nkB4leSFOU+hZvBya+6579dH+jWGkjt+2cNIHTzO8ARjPkV6I28VzJldz8DDt+r3TfTCsbV3uSanjdxqa9+XBp+rHnPl1QrOrTgvlISb6nfrDaKaxWektlED0FNGGNJ4ntJ7ycleOT3PJoSCgBAEAQGn3rWRovY7nPbblWSx1UBAka2ne4DIB4gY4EK8aU5LKRGUiPl1taESxujlr5HscMOa6jkII8NlX7Cp5Ebkcr1l12gtwggn0RgMVwdN+f2IXxRmPBzuO7azjgO3K9FGNSL+YrLBv+gtprb1qUmtku0JKmKdtJt9m0SzyyPYsKjUauUWXQ59qt0uj0JvtZT3mKVlNOBFUbLcuhkYTvI/vA+S3rU+0SaKxeHg6vddbeiVHRPnpLga2fZzHBFE8Fx5AkgABeZUZt8l3JHLdUluq9IdYYuz2fm6aSSrqHt+iHuzhvmXe5eis1GG0pHl5N/156Jz3i1U93t8bpamgDhJGwZc+I7yR2lpGfAlY289rwy0lkg9V+tO32+0QWXSOR0LaVuxT1YaXNLOTXAbxjhnsVqtB53RIUjbdINbmjFto3vt9X8pVRH5uGBrsE97iMAe0rONCTfJZySL+rLTqbTOhn9KoHwVNLgSyxAmF5P1Sd4P7KirS2PGQnk45rH2RrTr/l0TGl9JjL9gdYwbLcbPl9/Neql/r+XqUfU6TYdOdWOj0Qjs49G3b3to5C8+LiCT7VhKlVl1LJpEv872hf6xn/8AEk+Cr2FTyJ3I2uwXqh0gtkVytcrpaSUuDHOYWk7JLTuO/iFm008MkklACAIAgNB0h1UWPSC9VV1rKmuZPUuBe2ORoaMADd1e5bRrSisIhxTI75j9Gv0y5fat/lVviZkbEX6LUtotTVLJZnV1U1pz0Usw2XeOACQquvNrA2o6HBBFTwMggY2OKNoaxjRgNA4ABYljVtLNXOj2lMxqa2CSGsIwaindsOcP2uTvMZWkKsodCGkzWabUbYY5g+ouVynYPU2mNz5huVp8TPBGxHQ7HY7bYKFlDaKVlNTs9VvFx7SeJPeVg5OTyy2DPc3KgGi6Sap9Gb7UPqWwy0FS/e59I4Na49paQRnwwtYVpxKuKZGW/Uho5Tyh9ZV19Ywf8N72sB8dkA+9WdxNjajotut1HbKOOjt9PHT00YwyOJuAFg3nlliF0u0HselrIzdYHieMYjqIXbL2jszzHcVeFSUOhDSZqh1H6NZz6ZcvtW/yrX4mZGxD5j9Gv0y5fat/lT4mY2I3jRbR+l0YssFpoZJZKeEvLTKQXdZxceAHMrCT3PLLEuoAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQBAEAQH//Z",
"type": "image/jpg",
"filename": "suez.jpg",
"content_id": "suez"
}
],
"dedicatedData": [
{
"key": "name",
"value": "Luis"
},
{
"key": "surname",
"value": "Rodriguez"
},
{
"key": "city",
"value": "Santo Domingo"
}
]
}
]
}
Attachment_with_content:
{
"sharedAttachments": [
{
"content": "iVBORw0KGgoAAAANSUhEUgAAAFQAAABUCAIAAACTCYeWAAAR1ElEQVR42uWcCXwU1R3HlyQzs3NsOIWAWCJnjERbRRCsiBYVUJBaqwX8WFRUDrlErkC0RYjcRkRQqdAWbbmFingrBARa5AxXKKccQu7d2d3Za3b6e/MmsyQGE7KzC3zK5zGf9zZvju/7/9///d//vRmbFsd/odBBf/ATxb/Ao2R5lEluZajs/aPHh/x4xf+WP7A8GPpPOOyO2/PYYkx7wOub6nTfV+S0FZbZivSEfLGREoqdiTRfRFN5nTL5ZrcyMhD86tqDDwQ3yd7HL0JNKnYKxU6pxOUoT5I3yPtCfJlbRLFSQs1iJ1ustwWazOnu4vMvvtrhw2GnR8nUBUilWhnMJA9rYk5O28zMm34411j28VVXizQEQ1vB5fldMLTjqoNX1R+d7vsLCTOS8DMwSN4Av2BhiyP5L2varJdGPnDidGOnxzilulZIQCuUuJr6gxuuBnhIO+zyPKRjJ1LFrjb5VO6VyV01bZqmZWna9EEDO2ua6PbxPhUqINagFTjaBMHQ7isJD2OmYyfUDFvy+AUlJGha0tiX7wJ8Xt4gTZu8OXfgosXtNuamTRjXwR9u4lJoL6i+CfSO0P0KwKvh4hJXI0iAYteEXNWEpR9k5MxsvWZNmzmz0zTt9YKC0bt2Pq1p2Tlze4wa2kjz2ka/eMP+Q+18IXvN+NER6uAZ/IHV8YP3+d/TBc7VDJukgMbNnXXLuWO2XdtsE8emLVvevLBw/KaNAzbnPnXu3MjVKx97ddKv+vdL37YxIWss++XX6W4f4a9ZE4jgR9eLB7zL07vmAqcJ9izvYPra5bYFc5Nz3uygavXyj96wZmX//PzBqpp57sfRYfXV99+/TtMSZk6/GY805OkUv5pK+3/NklTkhBVIDoeDMYQvkVvgNjXHLrdwwiuT03GvOTNvQoeHVmuaNGPa7zVt6oULo9DtNW3GsBduy5l3a9bYZFRbOKdOQUnLUrnm8FQFWEglpB6NCbzuqCRcLjmSEhJnZjfFvcYMb6aEMmbPaTclK6Nn95Y+/xRN+zMsX+7GJ9+cY3MV4mFIGjuidUATIE+ce5n8PPpjILjVYnh9JGNwg1rBC1OnEMmrim3mawlnjxmQK5ba9u4bvDn3yX9v0n8JkuOLz9Tfd7CVyyvU7l4wATr/ZsvgS1xNAI9L1y7Bh/tkw627txnMmt8W9NhCXpL//F+2RW+x9Ee/y/bcH1PPXmjp9hvWLhr+YCjPAvgyOb24xv380v5s8rDn0hQnATaSShShrKBOybk6INfCtuEvwCI0KDO9vaj4BfT/cDgQFbzs7a+7U46okxjSGk99rf2saS3mZDefNLbtF+vr4O4/HEnwy6QtZk9r4gk2LZUtIDftH1Sg9vA+/4eFJrkV/EqIV0LJ3hBMer3MMam4+9H9iejqYcU2PTvDpxrabh0/ZoR31wYeQYVCczy3Mkmywm/K7fj5OiLwwtNE/nOz6xaWptKxzdoEtVX8Cy8bvsSVAs2xnNwbgG/PT89ujFu7CkhvLzhtW7L4Fsx2LCenLnAh6fzyZcB7fbMs6uqV3fv33m2fldnykd63nThCJF963pbR9salH94Y1BqiQmz4mVK53WXA6w6sxUqoauz7i26WCwxrv3NrIo5hr678ZzClyYDzZzm5qfwIENYI3uXpg9mSVTcuc5OEoXvt2l+npqQMHyJNHCeNHCq2SOG7dLI/3IN9tHfisGf5bnf+YsHbjwY0ovxOLxLOslD4Arzy6uFVtchCOweAsxekM+clZNDV/WHxXCFm9Y5il+T2k796g46Q5iiRJadXOF/EnjgtubwOHI//IBWVSZpmGT/gvb6Z1cC7PD2pM2dJCmuO3r3ZDh3gwyV/vEGw2RL27hd7PsTZbIk2WxJS/ye5xX8TzKLkSHK6HbSI412/Zim/VW7Pz8GrYSfEDrFYCD/gSa7vb7ljpySQb94qohV69OJeGMJpWl3kkeYvFOo3SDKLJ36QgK3nSSusXCN4A5YJX/HnXBLe7X2eerIWwg98mmvfnoUk138qggepT1+uRSozfKT9qYH25auEJX8X8NdRL9mfGWTPnGwvLHVcDP/PFYI3aJXweaQK8DE18oB/5lmuQQMGGNt3iGo5fKvWzPiJ9sFD7WvWCYt1+MzJ/LDh9ilT7QUlhDm5Ljkl/WaovcVmPxD8rgp4f2Ct5WM7Vfsn/mD/xzLS4fMOSVTtBz3PIWOqfb36ldX+wGHp6ElUtnzMT3B5flsFvNN9L5ZWLIfv25ft1IkF1Utj7KCC5dcNXtIvf8W2as1mvcr/ZQkxeLfdzqbdxN7TDbMRB5oJ9WVfTBw+CLgK+Fh48rLi2PYfceNmERmIcfVaAT1/x25xxSph2Urhg38KW7aLsIXL9eI/lguogKHur0txtBS7suZ/YcCbq2umzlvOj0TzsNtuHykqQSMh7/REinABSmVkYkWOBP/N7R1UAd6tDLfWzptOjl9F3NpRSYd9IUCadVBEpkIRR6PoMYuW2fwSZ7IJb4ZrWGvJIUA8d848flIWvycP41zEELwxj5cV8OsuYIE05w3eGzDI4d7hlAvFEvJQivNFEirDTbSOn8zzDPgYdXgo8O59IvXVMKrDhvUfwKkaaZG1HxML91o2H9KI2u85IFELR8/66ltyVo+eHHUK7r6HQxGXkhVru/03BrwaPmd5h8dzA7vfAGNI+267iCEdbMg3acJc15jBX1EHJmD/YQl4JvymLSL1bWEIYRpp8+07CHjr/XybPsKvtxYetvrwUYpkdFdAAswTIGwUFUjz5sPfqgyPoQHFIcPs8AsbNWImv8KjaC08RnvZ08+AV/xvFllq7dBXfywkykx7Pvp2SCMJqK3bsHd2ZiFV+LbgB/P+fAMeTeZXDXgUcaQVYgDPON0dDXi313pTD85Wrdi6dZnzhRLyw0fYn+jHnTpLOG9KZxtdx7Rpy4Jt5Wrh+Gniz/pUMvmFncv9zoAfNdq+aLEQG3gY/AYGPLZ7QBOsH+TCjrQ04qJTGWJK17KlMb1Fc+AI3cbvYEaF8pSw7hOB2j+3j2gNMiju3GMlPF3YNeF70zm85fyAREwC/R8ZqDQEq2BIlyNjYWGphGpQeKAiIQNIGvwxL1Iqm0WLRzvy3+nuStfhYpEom5k3yc1f6JEms/iTOjGDx6a36jwc6x1eFwnUUesIPNMLjlO6WO37QO3jRo7Rbscu8fs94qEjEgY/zF7hxsEifL1RrH4+Y73ae3rFDR4O74zZPOzcuvVi06YMpvFt2jAL3xX6PMLNmsN7g3GHxyyHxqrjk2DAW7dmcMQcHoENNASmtAjaPNybC2nxeAB9l4XdgPf6suDkxBHe0bAh8V70Y10MhwveEUaMsn/xNXbjxQeeK5VbGvBKYEk84UG47mMhqBnHDZ8JR09I4H/jTd7jjw98ktPT3YAPhnZR3z6O/BcfzXgGivGBt3mUMRWmtHSd8P8hQc19gaUReHQDmIEoe3IgbOT9KorUw4skiDesVQjaqCiqFS4SNCojQ5UCeSPmEzKujyJ+jMop0HesHTfgo/dw8WSIvb4+gwce8gve5TGMgTM1lUm9kbnhF4woMliN6Psoh2ks5Qf5E3/gMOyZ/ECakMmjJhIysIhffisi5o9rovKLI+yICOHiGA4R1d+2A95+VI59BB6vfkRj8xCE+vQLETMQiBdsmKJgHYYuucCqITiDhToUW7QgaxVUqiimpzNACpUXO3Yk8zyYPSRk7uzC0ikdQrp0/u9wMMjQtT1Ni2Y+26UCvBouirLb42nuf4Drchd7d1e2wx3kud0Kma6dOiNBUeHDoQIC9ZOyIvC3/pLFKhXgod7w+VCZRripVqN48ozU7V4OIS2E2FCkzB07sQ89zCFT+xU732wT3tyH0gBDf5RzOLrYigwcVcAjTxOdsbdtWzU8lGX+Qp5lyeBvOkIskwT1QfALp89fwHfqzKalsfgFl1r/KVYva+/bqeGSyvAeZUI0mk95Hn+cw6oztXZU8nTqjkTDG69N45EHMI6AHz+Rp3869F9SmV5Elyop7j0gmQ264B0+ewZP81HoPKSbUsWKjaoWRK/5UNGH+xjwsg6/9EOyDoNjWCOSv/12dtwEO8IYX34jdu7MZmSAnxQ//8pYt0frICFz730sbQh0JRQLSqT8Y+SCvR7C9aMKXVa9SouNO9HMbTEUjR1vnzDJjgz6udMjwWNHHBJxq5QUpqjUMeh5O5boIHC0Qs5bwsvjyovtWCxOQwWmTecR223chJn2OjTCMKWrPhKg87Qh0FiffSl6/LXfmXXJJWp/YFV0rh74zdEe/JXHeTVSJL5AKFKkZ+FoFisMJaaokaHktYJPdHl6/dy2FH3XJh9/r6tUjrFLq5u6kHri5+AV/6KfCt/lrSBDVasgtLBWQdRK0Dyrggy9QRSpP19BjLJPz+jilSv+lcY26PhHfrmk4uCylSvISuXJTJm7U/Vb0VCPCt9kyDtILE2dOkm8QFZaXhhsz5xkN4exrl058FNyFNFFwY+zDuRLKOa8RdwyxC3Xfyai+M0m0XxQFOEaYeMVHQtxRNyaPrSqO0iH/yvhUjv3GsHsWzJYc+CEI4TNHLRYrx6Td0ikjpBZYcs2XMokp2I/WT28P/DRxcIHFVYgsJYOc2XnkrDShh1V2GnTrRsHYSLwjL/CtoMQ7i3uiqUoPIesUHi68GCgoghvD9I24XO3iPd04+69j4OC/GkKD/nTO9KI9fFTEqrtO2TAN2xADCFsB3Y4wFkY+Iy9cxdy4iN9OUFgqDv4750iIsKnf5R+siGjR013YJbKbc14rqnP77wn1E1OosPyU09xd9zBIg4H93vXXmPvAXVOKSEe7qAOf/31DAIVM2fzdjvRmkrwG3NFeLj0d9pkF8EnLl8l5m4V//aBQOFTmrC4FLx6hD0QEccGJoyOCIdgzVMUDfhlKwScghEBQ2OpXMGZryk8XpOstG6LPjZvvuCQkmgnf3YQCT9hxlK/PoOHwI+IRuhCrottRtc3J48CeLreiCMS2uinkl/3sYjMiJF2qiOQmMsbgW/WjGnenMEcicKnprKiRH6RJGblR8JLL/PmighQ6SlNmzHNrmc4jtmfj3CoufF6Xs3h6d7jGTitSnhzd53puuGYlEQ6GwZw3BsPgb1Hx04ai3B3dGTbtWPRLpeCp9fBxObBHrhmBL6whGROnDGu06ghA/fWvCnU/v4HOXodzCPpKXDSaAW3z7Bz0OJavGxAdywkmvDYQpCYYMD368fBb0G8FauoK1YLHy4jmrn9e3HD5yK22WApEo5NQbGxtejgEQkmk3ZjKOTF8F9/K/7uMY7lyD48FEcTVz/S5xHbxn2xUE2vU78e0/1+7vWZxNTt2idiqbPTnUQAEzLt6FMUHteZms3Dazx6EpaIKHztXzPR337naVwBlnnIUHtQH8zeX8I//gT36GNc7z7c7Lk8NlXNe5unQxcsEKw0nhJ7LB7oweHpoX5IMOBQlj15UOzIfP773SRo//Sz9ts7sGPGovtEItyYI2JGiPseOS4hD7ZxE4yb9uzFYY4MWwBvH9cB52+6c8g89nuOVoBG7D8slsq2YHBL7eFD6im984uUH+TmMltYMxLwAHxRTAao+J0eK+06x48VirIS8fwqxa3Dxto+DQHROE/kpmhlJYhbm7eDvph/pefCjZ8S7dtV+HYDNX7XVpTO6XnQmvfq4PaB/xoiL5NvsfKNSq9vOpX/tUCeYf27tD7/X8z+f1UmsrXU6e4Wq7eo6UbNGK1nR/8KqVsZFdv35/GOeomrIRkCXdJVQ87QrXVx+mwEvmykdwH+SmMTVS+VW+C12bh+MCQY3E6a3HnFrCC8TwjA68u+Yp+K8SjjiArEtwlgdHBTvCdrCjz+8KYVCOFl6/ImEGOq5NC1QqLnacHQvqvo81BoArf3ufKPYbGWKgJ9N8gGbISigqG9V++HweAOYhZZGPkkmBiFnDn6eTBkPMpE82txVy28qQhexf82dvhV/Awco8tQQqoKVdBVJqFIB9bVuw2YQ2r+tfg9PHNqeAzeods7GMujJa7GAKsyYS2pTG4vewd4fbODoa3X+McAq//GlFNVz165+wP+//jf/wDBiz9SculpBQAAAABJRU5ErkJggg==",
"type": "image/png",
"filename": "yellow_mini_shared.png",
"content_id": "aquacislogoShared"
}
]
}
Attachments_with_document_link:
{
"sharedAttachments": [
{
"document_link": "https://upload.wikimedia.org/wikipedia/commons/2/2d/Snake_River_%285mb%29.jpg",
"type": "image/png",
"filename": "yellow_mini_shared.png",
"content_id": "aquacislogoShared",
"disposition": "attachment"
}
]
}
scheduledDelivery_with_planning:
{
"scheduledDelivery": {
"planningId": "5f71abd9273bae2e98f6049b",
"timeZone": "Europe/Madrid"
}
}
scheduledDelivery_without_planning:
{
"scheduledDelivery": {
"sendDate": "2020-10-08T08:19:50.204Z"
}
}
HTTP status code 201
Se devuelve el id de la notificación.
Body
Media type: application/json
Type: any
Example:
{
"id": "cc2ab1b7-0d56-4d6e-a493-bd8e22ddc09a"
}
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_PARAM_EXCEPTION",
"message": "Hubo un error en los parámetros de la llamada al servicio.",
"criticity": 5,
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Operaciones de la API de emails
Obtener la previsualización del correo electronico ataraves de una plantilla
post /notifications/{serviceInstanceId}/email/template/{templateId}/preview
Obtener la previsualización del correo electronico ataraves de una plantilla
URI Parameters
- serviceInstanceId: required(string)
- templateId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: Can not resolve ../../../../src/routes/notifications/schemas/preview.schema.json
Example:
{
"data": [
{
"key": "es",
"value": " es una variable global!!! "
}
],
"slots": [
{
"key": "body",
"value": "<h1 style=\"color: #5e9ca0;\">Este texto es un sharedSlot, el banner es un <span style=\"color: #2b2301;\"> dedicatedSlot</span> text!</h1>\n\t\t\t\t<h2 style=\"color: #2e6c80;\">Con el cambio de slot se puede poner el contenido dinamico que se necesite:</h2>\n\t\t\t\t<ol style=\"list-style: none; font-size: 14px; line-height: 32px; font-weight: bold;\">\n\t\t\t\t<li style=\"clear: both;\"><img style=\"float: left;\" src=\"https://html-online.com/img/01-interactive-connection.png\" alt=\"interactive connection\" width=\"45\" /> Interactive source editor</li>\n\t\t\t\t<li style=\"clear: both;\"><img style=\"float: left;\" src=\"https://html-online.com/img/02-html-clean.png\" alt=\"html cleaner\" width=\"45\" /> HTML Cleaning</li>\n\t\t\t\t<li style=\"clear: both;\"><img style=\"float: left;\" src=\"https://html-online.com/img/03-docs-to-html.png\" alt=\"Word to html\" width=\"45\" /> Word to HTML conversion</li>\n\t\t\t\t<li style=\"clear: both;\"><img style=\"float: left;\" src=\"https://html-online.com/img/04-replace.png\" alt=\"replace text\" width=\"45\" /> Find and Replace</li>\n\t\t\t\t<li style=\"clear: both;\"><img style=\"float: left;\" src=\"https://html-online.com/img/05-gibberish.png\" alt=\"gibberish\" width=\"45\" /> Lorem-Ipsum generator</li>\n\t\t\t\t<li style=\"clear: both;\"><img style=\"float: left;\" src=\"https://html-online.com/img/6-table-div-html.png\" alt=\"html table div\" width=\"45\" /> Table to DIV conversion</li>\n\t\t\t\t</ol>"
}
],
"language": "es_ES"
}
HTTP status code 200
El html generado
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_PARAM_EXCEPTION",
"message": "Hubo un error en los parámetros de la llamada al servicio.",
"criticity": 5,
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Operaciones de la API de emails
Obtener el texto generado de un hueco de la plantilla.
post /notifications/{serviceInstanceId}/email/template/{templateId}/preview/{slotId}
Obtener el texto generado de un hueco de la plantilla.
URI Parameters
- serviceInstanceId: required(string)
- templateId: required(string)
- slotId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: Can not resolve ../../../../../src/routes/notifications/schemas/previewSlot.schema.json
Example:
{
"data": [
{
"key": "name",
"value": "Pedro"
}
],
"textSlot": "Hola {{name}}",
"language": "es_ES"
}
HTTP status code 200
El texto generado
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_PARAM_EXCEPTION",
"message": "Hubo un error en los parámetros de la llamada al servicio.",
"criticity": 5,
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Operaciones de la API de emails
Envía SMS ataraves de una plantilla. (El usuario que hace la petición necesita tener acceso a la funcionalidad "SEND_TEMPLATED_SMS")
post /notifications/{serviceInstanceId}/sms/template/{templateId}
Envía SMS ataraves de una plantilla. (El usuario que hace la petición necesita tener acceso a la funcionalidad "SEND_TEMPLATED_SMS")
URI Parameters
- serviceInstanceId: required(string)
- templateId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- from: required(string)
Número o nombre que envía el mensaje.
- application: (string)
Aplicación desde la que se envía la notificación.
- uniqueMessageId: (string)
Control para mensaje único, si se informa no se aceptará otro mensaje con el mismo id.
- language: (string)
Idioma de la plantilla.
- metadata: (object)
Objeto en formato json, que permite añadir información propia, que servirá para poder buscar las notificaciones.
- scheduledDelivery: (object)
Entrega programada de la notificación.
- planningId: (string)
Identificación de la planificación.
- timeZone: required(string)
Zona horaria (TZ database name), lista de zonas disponibles - https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- sendDate: (string)
Fecha con hora en formato ISO 8601 para enviar la notificación. (Limite de 40 dias en futuro). Se puede usar solo sino se ha indicado "planningId".
- repeat: (object)
- cron: (string)
Expresión cron, formatos suportados - https://github.com/harrisiirak/cron-parser#readme.
- endDate: (string)
Fecha limite para la repetición de la notificación (formato ISO 8601).
- every: (integer)
Repetición, cada milisegundos (la configuración de cron no se puede usar junto con esta configuración).
- limit: (integer)
Número máximo de veces que se puede repetir la notificaión (Máximo 52) .
- cron: (string)
- planningId: (string)
- sharedData: (array of object)
Información de las variables de la plantilla para todos los destinatarios.
Items: Data
- key: required(string)
Nombre de la variable en la plantilla.
- value: required(string)
Valor de la variable.
- key: required(string)
- sharedSmsText: (string)
Texto del mensaje que sustituiria el texto que se encuentra en la plantilla para todos los destinatarios.
- recipients: required(array of object)
Destinatarios de las notificaciones.
Items: RecipientSMS
- to: required(array of string)
Numero de teléfono al que se enviará el SMS.
- dedicatedData: (array of Data)
Información de las variables de la plantilla solo a los destinatarios de este recipiente.
Items: Data
- key: required(string)
Nombre de la variable en la plantilla.
- value: required(string)
Valor de la variable.
- key: required(string)
- smsText: (string)
Texto del mensaje que sustituiria el texto que se encuentra en la plantilla y el sharedSmsText.
- to: required(array of string)
Example:
{
"from": "625875698",
"sharedData": [
{
"key": "company",
"value": "Aqualogy BS"
}
],
"earliesDeliveryTime": "2018-10-25T08:22:02.000",
"expiryDate": "2018-10-26T07:33:00.000",
"application": "Facturador Agua",
"user": "Eduardo Morales",
"language": "es_ES",
"recipients": [
{
"to": [
"622576252",
"0034622577313",
"+34698784159"
],
"dedicatedData": [
{
"key": "name",
"value": "Kevin"
},
{
"key": "surname",
"value": "Stone"
},
{
"key": "city",
"value": "Barcelona"
}
]
},
{
"to": [
"669887110"
],
"smsText": "Este mensaje no tendrá en cuenta el texto por defecto de la plantilla"
}
]
}
HTTP status code 201
Se devuelve el id de la notificación.
Body
Media type: application/json
Type: any
Example:
{
"id": "cc2ab1b7-0d56-4d6e-a493-bd8e22ddc09a"
}
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_PARAM_EXCEPTION",
"message": "Hubo un error en los parámetros de la llamada al servicio.",
"criticity": 5,
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Cancelación de una notificacion programada.
post /notifications/{serviceInstanceId}/cancel/notification/{notificationId}
Cancelación de una notificacion programada.
URI Parameters
- serviceInstanceId: required(string)
- notificationId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 201
Se devuelve el identificador de la notificación cancelada
Body
Media type: application/json
Type: any
Example:
{
"cancelledNotification": "8b1f74c0-0a2e-11eb-9f3b-bdaa7d8fe48d"
}
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_PARAM_EXCEPTION",
"message": "Hubo un error en los parámetros de la llamada al servicio.",
"criticity": 5,
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Cancelación de las notificaciones programadas de una planificación.
post /notifications/{serviceInstanceId}/cancel/planning/{planningId}
Cancelación de las notificaciones programadas de una planificación.
URI Parameters
- serviceInstanceId: required(string)
- planningId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 201
Se devuelve una array con los ids de las notificaciones canceladas
Body
Media type: application/json
Type: any
Example:
{
"cancelledNotifications": [
"cc2ab1b7-0d56-4d6e-a493-bd8e22ddc09a",
"aa2ab1b7-0d56-4d6e-a493-bd8e22ddc09a",
"bb2ab1b7-0d56-4d6e-a493-bd8e22ddc09a"
]
}
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_PARAM_EXCEPTION",
"message": "Hubo un error en los parámetros de la llamada al servicio.",
"criticity": 5,
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Editar una notificación planificada o de repeteción.
put /notifications/{serviceInstanceId}/planned/notification/{notificationId}
Editar una notificación planificada o de repeteción.
URI Parameters
- serviceInstanceId: required(string)
- notificationId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- sharedData: (array of object)
Información de las variables de la plantilla para todos los destinatarios.
Items: Data
- key: required(string)
Nombre de la variable en la plantilla.
- value: required(string)
Valor de la variable.
- key: required(string)
- sharedSlots: (array of object)
Información de los huecos para todos los destinatarios.
Items: Slot
- key: required(string)
Nombre del hueco en el modelo.
- value: required(string)
Valor del hueco.
- key: required(string)
- recipients: required(array of object)
Destinatarios de las notificaciones.
Items: items
- to: required(string)
Correos electrónicos a los que se enviara la notificación.
- dedicatedData: (array of object)
Información de las variables de la plantilla solo a los destinatarios de este recipiente.
Items: Data
- key: required(string)
Nombre de la variable en la plantilla.
- value: required(string)
Valor de la variable.
- key: required(string)
- dedicatedSlots: (array of object)
Información de los huecos solo a los destinatarios de este recipiente.
Items: Slot
- key: required(string)
Nombre del hueco en el modelo.
- value: required(string)
Valor del hueco.
- key: required(string)
- to: required(string)
Example:
{
"sharedData": [
{
"key": "company",
"value": "Aqualogy BS"
}
],
"sharedSlots": [
{
"key": "body",
"value": "Aqui se va a sustituiar la etiqueta con el nombre body de la plantilla"
}
],
"recipients": [
{
"to": [
"example@gmail.com"
],
"dedicatedData": [
{
"key": "name",
"value": "Kevin"
},
{
"key": "surname",
"value": "Stone"
},
{
"key": "city",
"value": "Barcelona"
}
],
"dedicatedSlots": [
{
"key": "header",
"value": "Se va a sustituir el hueco marcado como header"
}
]
}
]
}
HTTP status code 200
Se devuelve el identificador de la notificación cancelada
Body
Media type: application/json
Type: any
Example:
{
"notificationId": "8b1f74c0-0a2e-11eb-9f3b-bdaa7d8fe48d"
}
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_PARAM_EXCEPTION",
"message": "Hubo un error en los parámetros de la llamada al servicio.",
"criticity": 5,
"errors": []
}
}
HTTP status code 404
Notificación no encontrada
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "NOTIFICATION_NOT_FOUND",
"message": "Notification id not found"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Planning service
Operaciones disponibles para la planificación de notificaciones
Permite buscar una planificación, se puede poner uno o varios paramteros en la busqueda.
get /planning/{instanceId}
Permite buscar una planificación, se puede poner uno o varios paramteros en la busqueda.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- name: (string)
buscar por nombre de la planificación
Example:
/planning/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?name=Mi planificación
- description: (string)
buscar por descripción de la planificación
Example:
/planning/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?description=Planificación dias laborales
- tags: (string)
Etuiquetas de las planificaciones
Example:
/planning/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?tags=Factura
HTTP status code 200
Devuelve el/los modelo/s que cumplen con la condición
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "5f71abd9273bae2e98f6049b",
"timeIntervals": {
"monday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "12:30",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"friday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "02:30",
"end_time": "14:00",
"order": 1
},
{
"start_time": "20:30",
"end_time": "23:00",
"order": 2
}
]
},
"sunday": {
"all_day": true,
"dayIntervals": []
}
},
"serviceInstanceId": "e79d8ffa-7b20-4487-ac67-7bd9d7267774",
"name": "Primera planificación 2",
"description": "Esta es la primera planificación creada en Nautilus",
"creationDate": "2020-09-28T09:24:41.565Z"
},
{
"_id": "5f71b3056ed739073c067117",
"timeIntervals": {
"monday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"wednesday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"friday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "00:48",
"end_time": "01:00",
"order": 1
},
{
"start_time": "20:30",
"end_time": "23:00",
"order": 2
}
]
},
"sunday": {
"all_day": true,
"dayIntervals": []
}
},
"serviceInstanceId": "e79d8ffa-7b20-4487-ac67-7bd9d7267774",
"name": "Primera planificación 3",
"description": "Esta es la primera planificación creada en Nautilus",
"creationDate": "2020-09-28T09:55:17.666Z",
"modificationDate": "2020-09-28T10:03:00.509Z"
},
{
"_id": "5f7c34d031ce9a2e205672df",
"timeIntervals": {
"monday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"friday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "02:30",
"end_time": "14:00",
"order": 1
},
{
"start_time": "20:30",
"end_time": "23:00",
"order": 2
}
]
},
"sunday": {
"all_day": true,
"dayIntervals": []
}
},
"serviceInstanceId": "e79d8ffa-7b20-4487-ac67-7bd9d7267774",
"name": "Primera planificación 5",
"description": "Esta es la primera planificación creada en Nautilus",
"tags": [
"Nautilus",
"WorkDay",
"Barcelona"
],
"creationDate": "2020-10-06T09:11:44.277Z"
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Permite obtener una planificación mediante su id
get /planning/{instanceId}/{planningId}
Permite obtener una planificación mediante su id
URI Parameters
- instanceId: required(string)
- planningId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la planificación
Body
Media type: application/json
Type: any
Example:
{
"_id": "5f71b3056ed739073c067117",
"timeIntervals": {
"monday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"wednesday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"friday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "00:48",
"end_time": "01:00",
"order": 1
},
{
"start_time": "20:30",
"end_time": "23:00",
"order": 2
}
]
},
"sunday": {
"all_day": true,
"dayIntervals": []
}
},
"serviceInstanceId": "e79d8ffa-7b20-4487-ac67-7bd9d7267774",
"name": "Primera planificación 3",
"description": "Esta es la primera planificación creada en Nautilus",
"creationDate": "2020-09-28T09:55:17.666Z",
"modificationDate": "2020-09-28T10:03:00.509Z"
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Permite obtener la hora de envio segun una planificación y zona horaria
get /planning/{instanceId}/{planningId}/time
Permite obtener la hora de envio segun una planificación y zona horaria
URI Parameters
- instanceId: required(string)
- planningId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- timeZone: required(string)
Zona horaria (TZ database name), lista de zonas disponibles - https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Example:
/planning/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?timeZone=Europe/Moscow
HTTP status code 200
Devuelve la fecha en formato ISO 8601
Body
Media type: application/json
Type: any
Example:
{
"send_date": "2020-10-08T23:30:00.000Z"
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Filtrar planifiaciones por nombre y descripción
get /planning/{instanceId}/filter
Filtrar planifiaciones por nombre y descripción
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: (string)
buscar por nombre y descripción de la planificación
Example:
/planning/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc/filter?filter=Mi modelo
HTTP status code 200
Devuelve las planificaciones
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "5f71abd9273bae2e98f6049b",
"timeIntervals": {
"monday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "12:30",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"friday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "02:30",
"end_time": "14:00",
"order": 1
},
{
"start_time": "20:30",
"end_time": "23:00",
"order": 2
}
]
},
"sunday": {
"all_day": true,
"dayIntervals": []
}
},
"serviceInstanceId": "e79d8ffa-7b20-4487-ac67-7bd9d7267774",
"name": "Primera planificación 2",
"description": "Esta es la primera planificación creada en Nautilus",
"creationDate": "2020-09-28T09:24:41.565Z"
},
{
"_id": "5f71b3056ed739073c067117",
"timeIntervals": {
"monday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"wednesday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"friday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "00:48",
"end_time": "01:00",
"order": 1
},
{
"start_time": "20:30",
"end_time": "23:00",
"order": 2
}
]
},
"sunday": {
"all_day": true,
"dayIntervals": []
}
},
"serviceInstanceId": "e79d8ffa-7b20-4487-ac67-7bd9d7267774",
"name": "Primera planificación 3",
"description": "Esta es la primera planificación creada en Nautilus",
"creationDate": "2020-09-28T09:55:17.666Z",
"modificationDate": "2020-09-28T10:03:00.509Z"
},
{
"_id": "5f7c34d031ce9a2e205672df",
"timeIntervals": {
"monday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "10:20",
"end_time": "14:00",
"order": 1
},
{
"start_time": "15:30",
"end_time": "18:00",
"order": 2
}
]
},
"friday": {
"all_day": false,
"dayIntervals": [
{
"start_time": "02:30",
"end_time": "14:00",
"order": 1
},
{
"start_time": "20:30",
"end_time": "23:00",
"order": 2
}
]
},
"sunday": {
"all_day": true,
"dayIntervals": []
}
},
"serviceInstanceId": "e79d8ffa-7b20-4487-ac67-7bd9d7267774",
"name": "Primera planificación 5",
"description": "Esta es la primera planificación creada en Nautilus",
"tags": [
"Nautilus",
"WorkDay",
"Barcelona"
],
"creationDate": "2020-10-06T09:11:44.277Z"
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Profiles
En el siguiente listado se muestran todas las operaciones disponibles para el manejo de perfiles dentro de la plataforma.
Permite obtener todos los perfiles o los perfiles filtrados
Añade un perfil nuevo a la aplicación
get /profiles
Permite obtener todos los perfiles o los perfiles filtrados
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- productInstanceId: required(string)
Filtra por aplicación
Example:
01eacbee-a952-455b-869f-c24ba85382e06
- accountId: required(string)
Filtra por cuenta
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
HTTP status code 200
Petición recibida
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 2,
"items": [
{
"id": "4b1ccdce-0ea2-4b16-83fa-d7e449de1255",
"productInstanceId": "301146f5-15b6-4346-be60-03893ab06446",
"accountId": "9d44c506-965b-41d1-9f4b-58614be40219",
"userGroupId": null,
"active": true
},
{
"id": "1f706004-989a-4659-a8af-7834d847da3e",
"productInstanceId": "90a0f0a4-a822-490d-a523-de0328831934",
"accountId": "4e50178b-060e-45b7-a812-50206fbb0da6",
"userGroupId": null,
"active": true
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /profiles
Añade un perfil nuevo a la aplicación
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Examples:
Account:
{
"productInstanceId": "301146f5-15b6-4346-be60-03893ab06446",
"accountId": "24d5f72c-2ad4-4493-99ff-f1c6fd150a81"
}
Group:
{
"productInstanceId": "301146f5-15b6-4346-be60-03893ab06446",
"userGroupId": "e60ac104-6a01-4928-89a5-f5bbd751ff4c"
}
HTTP status code 201
Perfil creado
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "b37e768e-5fda-4cb1-980f-ba3b4c09911e"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtiene información sobre el perfil
Permite eliminar un perfil de usuario
get /profiles/{profileId}
Obtiene información sobre el perfil
URI Parameters
- profileId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- profileId: required(string)
Identificador del perfil.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
HTTP status code 200
Petición recibida
Body
Media type: application/json
Type: any
Example:
{
"id": "4b1ccdce-0ea2-4b16-83fa-d7e449de1255",
"productInstanceId": "301146f5-15b6-4346-be60-03893ab06446",
"accountId": "9d44c506-965b-41d1-9f4b-58614be40219",
"userGroupId": null,
"applicationRoles": [
{
"id": "2e189be7-dd45-4b26-bd17-bd12be58cb09",
"name": "Administrador"
}
]
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
delete /profiles/{profileId}
Permite eliminar un perfil de usuario
URI Parameters
- profileId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
Eliminación realizada con éxito
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite obtener los roles de un perfil
Permite asignar un rol id a un perfil de usuario
get /profiles/{profileId}/roles
Permite obtener los roles de un perfil
URI Parameters
- profileId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve los roles del perfil
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 2,
"items": [
{
"id": "4b1ccdce-0ea2-4b16-83fa-d7e449de1255",
"name": "CONSULTA"
},
{
"id": "173a7c3f-bb9b-4619-803e-72dea3eab0a3",
"name": "EDICIÓN"
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /profiles/{profileId}/roles
Permite asignar un rol id a un perfil de usuario
URI Parameters
- profileId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"id": "e8f3a7a2-25e2-431b-b954-65b4d6540f8e"
}
HTTP status code 201
Asignación realizada con éxito
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite eliminar un rol id de un perfil de usuario
Permite eliminar un rol de un perfil
delete /profiles/{profileId}/roles/{roleId}
Permite eliminar un rol de un perfil
URI Parameters
- profileId: required(string)
- roleId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
Eliminación realizada con éxito
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Products
En el siguiente listado se muestran todas las operaciones disponibles para el manejo de productos dentro de la plataforma.
Obtiene los datos de un producto
Actualizar un producto existente
get /products/{productId}
Obtiene los datos de un producto
URI Parameters
- productId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 201
Devuelve el prodcuto incluida su configuración
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"data": {
"self": {
"name": "SewerAdvanced",
"description": "Aquadvanced Urban Drainage",
"url": "http://seweradvanced.com",
"imageUrl": "http://imagen.url.com",
"isPublic": false,
"clientId": "6a075ae3-abe2-491d-8087-13a52e175669",
"ispublic": false,
"activated": true,
"configuration": {
"myId": "anotherId23123",
"other": "bla",
"test": true,
"asd": {
"nastedObj": true,
"dasd": "gdfgdf",
"updateProp": 2311
}
}
}
}
}
HTTP status code 403
Error de autentificación. No tiene permisos para crear una nueva funcionalidad en el producto indicado (productId).
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "XXXXXXXXXXX",
"errors": []
}
}
HTTP status code 460
El valor despription o tag está duplicado para el producto indicado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_FUNCTIONALITY_TAG",
"message": "XXXXXXXX",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
put /products/{productId}
Actualizar un producto existente
URI Parameters
- productId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "SewerAdvanced",
"description": "Aquadvanced Urban Drainage",
"url": "http://seweradvanced.com",
"imageUrl": "http://imagen.url.com",
"public": "false",
"clientId": "d8ed0705-4e09-484f-b7fc-fecb18302955",
"configuration": {
"myId": "anotherId23123",
"other": "bla",
"test": true,
"asd": {
"nastedObj": true,
"dasd": "gdfgdf",
"updateProp": 2311
}
}
}
HTTP status code 201
Devuelve el prodcuto actualizado
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"data": {
"self": {
"name": "SewerAdvanced",
"description": "Aquadvanced Urban Drainage",
"url": "http://seweradvanced.com",
"imageUrl": "http://imagen.url.com",
"isPublic": false,
"clientId": "6a075ae3-abe2-491d-8087-13a52e175669",
"ispublic": false,
"activated": true,
"configuration": {
"myId": "anotherId23123",
"other": "bla",
"test": true,
"asd": {
"nastedObj": true,
"dasd": "gdfgdf",
"updateProp": 2311
}
}
}
}
}
HTTP status code 403
Error de autentificación. No tiene permisos para crear una nueva funcionalidad en el producto indicado (productId).
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "XXXXXXXXXXX",
"errors": []
}
}
HTTP status code 460
El valor despription o tag está duplicado para el producto indicado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_FUNCTIONALITY_TAG",
"message": "XXXXXXXX",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
Permite la obtener las aplicaciones de un (productId).
Obtener las aplicaciones de un producto
get /products/{productId}/applications
Obtener las aplicaciones de un producto
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- activated: (string)
Aplicaciones activadas/desactivadas
Example:
/functionalities?activated=true
HTTP status code 200
Lista de aplicaciones de un producto
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 3,
"items": [
{
"id": "61b4b608-3bc9-43c9-906d-6fb9897e45d0",
"name": "APP 110",
"description": "app 110",
"url": "http://app.com",
"activated": true
},
{
"id": "8f733b85-b566-4077-b6c2-ab063a554814",
"name": "Prueba Raul",
"description": null,
"url": "http://google.es",
"activated": true
},
{
"id": "db0ba5bc-ce3f-4f90-aa07-3bd4e80d7e47",
"name": "APP 112",
"description": "APP 112",
"url": "http://app112.net",
"activated": true
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite la alta/Consulta de funcionalidades sobre un producto (productId).
Permite dar de alta nuevas funcionalidades para ser asignadas a un rol
Permite obtener un listado con todas las funcionalidades de un producto.
post /products/{productId}/functionalities
Permite dar de alta nuevas funcionalidades para ser asignadas a un rol
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"description": "Gestión de órdenes de trabajo",
"tag": "aq_gestion_trabajo"
}
HTTP status code 201
Devuelve el identificador de la nueva funcionalidad creada. El campo id, es el identificador de la nueva funcionalidad (functionalitydId)
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "dd4f060f-e8b0-47f6-9916-337cb7656ef8"
}
}
}
HTTP status code 403
Error de autentificación. No tiene permisos para crear una nueva funcionalidad en el producto indicado (productId).
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "XXXXXXXXXXX",
"errors": []
}
}
HTTP status code 460
El valor despription o tag está duplicado para el producto indicado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_FUNCTIONALITY_TAG",
"message": "XXXXXXXX",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
get /products/{productId}/functionalities
Permite obtener un listado con todas las funcionalidades de un producto.
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Muestra un listado de funcionalidades que tiene el producto seleccionado (productId).
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 2,
"items": [
{
"id": "dad8c2c1-3e63-4c88-a062-58f4651c98ef",
"tag": "aq-manage-meter",
"description": "Gestión de contadores",
"name": "Gestión de contadores"
},
{
"id": "82defc91-5a1c-4b4f-85bd-0c504139a6ac",
"tag": "aq-task",
"description": "Gestión de tareas",
"name": "Gestión de tareas"
}
]
}
}
HTTP status code 400
Indica que el valor del campo productId no tiene formato UID. body
HTTP status code 401
Indica que el campo Authorization no se ha indicado o tiene el token caducado.
HTTP status code 404
Indica que no existe un producto (productId) con ese valor.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "PRODUCT_NOT_EXIST",
"message": "This products doesn't exist.",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
Permite la Modificación/Eliminación de funcionalidades sobre un producto (productId).
Permite elminar una funcionalidad que no esté siendo utilizada por ningún rol.
Permite modificar una funcionalidad.
delete /products/{productId}/functionalities/{functionalityId}
Permite elminar una funcionalidad que no esté siendo utilizada por ningún rol.
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
- functionalityId: required(string)
Identificador de la funcionalidad.
Example:
6491117e-18fe-4d25-85ac-873fc2fca3bb
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
Indica que se pudo borrar la funcionalidad indicada.
HTTP status code 400
Indica que el valor del campo productId o el de functionalityId no tiene el formato indicado o no se ha informado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.productId should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Indica que el campo Authorization no se ha indicado o tiene el token caducado.
HTTP status code 403
Indica que bien o el valor de la variable productId o Authorization no existen.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"errors": []
}
}
HTTP status code 404
Indica que no existe una funcionalidad (functionalityId) con ese valor.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "FUNCTIONALITY_NOT_EXIST",
"message": "Esta funcionalidad no existe.",
"errors": []
}
}
HTTP status code 409
Indica que la funcionalidad functionalityId no existe.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "FUNCTIONALITY_USED",
"message": "Esta funcionalidad no se puede eliminar porque está siendo usada por un rol.",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
put /products/{productId}/functionalities/{functionalityId}
Permite modificar una funcionalidad.
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
- functionalityId: required(string)
Identificador de la funcionalidad.
Example:
6491117e-18fe-4d25-85ac-873fc2fca3bb
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Indica que se pudo modificar la funcionalidad.
HTTP status code 400
Indica que el valor del campo productId o el de functionalityId no tiene el formato indicado o no se ha informado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.productId should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 401
Indica que el campo Authorization no se ha indicado o tiene el token caducado.
HTTP status code 403
Indica que bien o el valor de la variable productId o Authorization no existen.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"errors": []
}
}
HTTP status code 404
Indica que no existe la funcionalidad (functionalityId) con ese valor a la que se quiere modificar.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "FUNCTIONALITY_NOT_EXIST",
"message": "Esta funcionalidad no existe.",
"errors": []
}
}
HTTP status code 460
Indica que ya existe otra funcionalidad con el mismo tag para el producto seleccionado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_FUNCTIONALITY_TAG",
"message": "Existe otra funcionalidad para el mismo producto que tiene el mismo tag.",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
Permite la Añadir o obtener los roles de un producto (productId).
Obtener los roles asignados a un producto
Añadir un nuevo rol a un producto
get /products/{productId}/roles
Obtener los roles asignados a un producto
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Roles del producto
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 2,
"items": [
{
"id": "558b70fa-b470-46c3-bf09-d96b3f20881b",
"name": "Administrador",
"description": "admin"
},
{
"id": "2d1a4f41-ecd3-45cd-80c6-ef90393505d9",
"name": "Rol prueba",
"description": "actualizacion"
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /products/{productId}/roles
Añadir un nuevo rol a un producto
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "Administrador",
"description": "Quien administra "
}
HTTP status code 201
Id del nuevo rol creado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "d8ed0705-4e09-484f-b7fc-fecb18302955"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite gestionar la configuración del producto (productId).
Permite obtener el modelo actual de configuración del producto (productId).
get /products/{productId}/models/configuration
Permite obtener el modelo actual de configuración del producto (productId).
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
0f2e66ac-075e-4bb3-8239-1a0096603f4f
HTTP status code 200
Devuelve la información del modelo de configuración del producto.
Body
Media type: application/json
Type: any
Example:
{
"id": "5a0c2e3330c445519866b57a",
"model": {
"id": "/schemas/client/client.json#",
"title": "Nuevo modelo",
"type": "object",
"properties": {
"id": {
"description": "The id is autogenerated for new clients, for update/delete operation must be required",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"name": {
"title": "The client name",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"title": "The client description",
"type": "string"
},
"owner": {
"description": "Account id that represent the owner of the client",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Permite gestionar la parametrización del producto (productId).
Permite obtener el modelo actual de parametrización del producto (productId).
get /products/{productId}/models/settings
Permite obtener el modelo actual de parametrización del producto (productId).
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
0f2e66ac-075e-4bb3-8239-1a0096603f4f
HTTP status code 200
Devuelve la información del modelo de parametrización del producto.
Body
Media type: application/json
Type: any
Example:
{
"id": "5a0c2e3330c445519866b57a",
"model": {
"id": "/schemas/client/client.json#",
"title": "Nuevo modelo",
"type": "object",
"properties": {
"id": {
"description": "The id is autogenerated for new clients, for update/delete operation must be required",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"name": {
"title": "The client name",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"title": "The client description",
"type": "string"
},
"owner": {
"description": "Account id that represent the owner of the client",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}
}
HTTP status code 400
HTTP status code 404
HTTP status code 500
Permite añadir un fav icon a un producto (este fav icon se usa para la personalización del login)
post /products/{productId}/favIcon
Permite añadir un fav icon a un producto (este fav icon se usa para la personalización del login)
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: multipart/form-data
Type: object
Properties- file: required(file)
Imagen para alojar. Debe ser jpg, png o ico. Se recomienda un tamaño de 16x16 px
HTTP status code 201
Devuelve el prodcuto con favIconUrl informado
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"data": {
"self": {
"id": "dc431a33-2ca8-4064-99ce-2f72cf0c7bb8",
"name": "Documents",
"description": "Servicio para la gestión de archivos",
"url": "https://documents.dev.nautilus.app/files/",
"isPublic": false,
"imageUrl": "https://abswenautilusstimgdev.blob.core.windows.net/zgm0mzfhmzmtmmnhoc00mdy0ltk5y2utmmy3mmnmmgm3ymi4-logocontent/sxw1bKFhBYDlMIk8kzb4DKUh8Hex9xtt42vIHmT4nxCY2KWSJZaDv2icHo773BjI_medium.png",
"clientId": "cbb0bf01-33c1-49df-ae82-4e6822c95533",
"logoUrl": "https://abswenautilusstimgdev.blob.core.windows.net/ztkwogq4mzctowjhoc00n2jhltkwmdctywm2ytblzmqxntzk-logocontent/G0hF2bjaeF90h7wbAwrIXwpkAUy9p4fSPwKGS9GtHRjKROQGOflgtHATOvK0UA45_login.jpg",
"favIconUrl": "https://abswenautilusstimgdev.blob.core.windows.net/yzgxymzlyzmtyjzhys00zta4lthmodktotnizdbiywu3yzez-faviconcontent/fUODEOUWS84eHOoySOswvnHZ9tamEh9OMODpEVEGFyPOoUbSsIMOOe76CBvdOFjc_standard.ico",
"ispublic": false,
"clientid": "cbb0bf01-33c1-49df-ae82-4e6822c95533",
"activated": true
},
"id": "c81bfec3-b6aa-4e08-8f89-93bd0bae7c13"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos para crear una nueva funcionalidad en el producto indicado (productId).
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "XXXXXXXXXXX",
"errors": []
}
}
HTTP status code 460
El valor despription o tag está duplicado para el producto indicado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_FUNCTIONALITY_TAG",
"message": "XXXXXXXX",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
Permite añadir un logo a un producto (este logo se usa para la personalización del login)
post /products/{productId}/logoLogin
Permite añadir un logo a un producto (este logo se usa para la personalización del login)
URI Parameters
- productId: required(string)
Identificador del producto.
Example:
01eacbee-a952-455b-869f-c24ba85382e06
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: multipart/form-data
Type: object
Properties- file: required(file)
Imagen para alojar. Se recomienda un tamaño de 160x25 px
HTTP status code 201
Devuelve el prodcuto con favIconUrl informado
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"data": {
"self": {
"id": "dc431a33-2ca8-4064-99ce-2f72cf0c7bb8",
"name": "Documents",
"description": "Servicio para la gestión de archivos",
"url": "https://documents.dev.nautilus.app/files/",
"isPublic": false,
"imageUrl": "https://abswenautilusstimgdev.blob.core.windows.net/zgm0mzfhmzmtmmnhoc00mdy0ltk5y2utmmy3mmnmmgm3ymi4-logocontent/sxw1bKFhBYDlMIk8kzb4DKUh8Hex9xtt42vIHmT4nxCY2KWSJZaDv2icHo773BjI_medium.png",
"clientId": "cbb0bf01-33c1-49df-ae82-4e6822c95533",
"logoUrl": "https://abswenautilusstimgdev.blob.core.windows.net/ztkwogq4mzctowjhoc00n2jhltkwmdctywm2ytblzmqxntzk-logocontent/G0hF2bjaeF90h7wbAwrIXwpkAUy9p4fSPwKGS9GtHRjKROQGOflgtHATOvK0UA45_login.jpg",
"favIconUrl": "https://abswenautilusstimgdev.blob.core.windows.net/yzgxymzlyzmtyjzhys00zta4lthmodktotnizdbiywu3yzez-faviconcontent/fUODEOUWS84eHOoySOswvnHZ9tamEh9OMODpEVEGFyPOoUbSsIMOOe76CBvdOFjc_standard.ico",
"ispublic": false,
"clientid": "cbb0bf01-33c1-49df-ae82-4e6822c95533",
"activated": true
},
"id": "c81bfec3-b6aa-4e08-8f89-93bd0bae7c13"
}
}
HTTP status code 403
Error de autentificación. No tiene permisos para crear una nueva funcionalidad en el producto indicado (productId).
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "XXXXXXXXXXX",
"errors": []
}
}
HTTP status code 460
El valor despription o tag está duplicado para el producto indicado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_FUNCTIONALITY_TAG",
"message": "XXXXXXXX",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unkow Error",
"errors": []
}
}
Roles
Operaciones sobre un rol
Obtiene los datos de un rol
Modificar un rol
Eliminar un rol
get /roles/{roleId}
Obtiene los datos de un rol
URI Parameters
- roleId: required(string)
Example:
2312fbad-9e31-4ead-8d95-94149234a60f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Los datos del rol.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "c49f4ef0-3d90-4299-8738-f1724b2aa67b",
"productId": "f2dcf24d-5b34-4506-bcfa-0ebd67596a78",
"productInstanceId": null,
"name": "Ejemplo 2",
"description": "test "
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
put /roles/{roleId}
Modificar un rol
URI Parameters
- roleId: required(string)
Example:
2312fbad-9e31-4ead-8d95-94149234a60f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "Ejemplo 2",
"description": "test "
}
HTTP status code 200
Los datos del rol modificado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "c49f4ef0-3d90-4299-8738-f1724b2aa67b",
"productId": "f2dcf24d-5b34-4506-bcfa-0ebd67596a78",
"productInstanceId": null,
"name": "Ejemplo 2",
"description": "test "
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
delete /roles/{roleId}
Eliminar un rol
URI Parameters
- roleId: required(string)
Example:
2312fbad-9e31-4ead-8d95-94149234a60f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
Se ha borrado correctamente el rol.
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 409
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "CANT_PERFORM_ACTION",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Operaciones sobre un rol de un producto
Obtiene las funcionalidades de un rol
Asociar una funcionalidad a un rol
get /roles/{roleId}/functionalities
Obtiene las funcionalidades de un rol
URI Parameters
- roleId: required(string)
Example:
2312fbad-9e31-4ead-8d95-94149234a60f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
La lista de funcionalidades.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"itemsCount": 2,
"items": [
{
"id": "dfa82ad6-cade-4860-8abd-887ecfee7810",
"name": "Funcionalidad2"
},
{
"id": "607c2919-32ce-44db-bbe9-9bac825e2072",
"name": "adsdsa"
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /roles/{roleId}/functionalities
Asociar una funcionalidad a un rol
URI Parameters
- roleId: required(string)
Example:
2312fbad-9e31-4ead-8d95-94149234a60f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"id": "0eb9fd54-7feb-412b-bbd0-810ab361ca17"
}
HTTP status code 201
Se ha asociado correctamente.
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Operaciones sobre una funcionalidad asociada a un
Desasociar una funcionalidad de un rol
delete /roles/{roleId}/functionalities/{functionalityId}
Desasociar una funcionalidad de un rol
URI Parameters
- roleId: required(string)
Example:
2312fbad-9e31-4ead-8d95-94149234a60f
- functionalityId: required(string)
Example:
2312fbad-9e31-4ead-8d95-94149234a60f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
Se ha desasociado la funcionalidad al rol correctamente.
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Strucs
Operaciones de la API de estructuras
Endpoint para obtener relaciones
Endpoint para crear relaciones
get /strucs/instances/{instanceId}/edges
Endpoint para obtener relaciones
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
[
{
"type":"AccessTo",
"properties":{
"_id":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a-AccessTo-c8e85af8-2da8-449a-86ab-f46da082e9a8"
},
"from":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a",
"to":"c8e85af8-2da8-449a-86ab-f46da082e9a8"
}
]
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
post /strucs/instances/{instanceId}/edges
Endpoint para crear relaciones
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"key":"AccessTo",
"sourceId":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a",
"targetId":"8e1e4d39-2da9-4ac8-8c46-a52b7a739aba"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052ce",
"key":"AccessTo",
"displayName":"Accede a",
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052ca",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052ce",
"id":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba",
"key":"AccessTo",
"attributes":{
},
"displayName":"Accede a",
"color":"#a5a9ac",
"shapeId":"5c1bb88d45d459573e0052ca",
"sourceId":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a",
"targetId":"8e1e4d39-2da9-4ac8-8c46-a52b7a739aba"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener relaciones
Endpoint para modificar atributos de las relaciones
Endpoint para modificar relaciones (origen, destino, tipo y/o atributos)
Endpoint para borrar relaciones
get /strucs/instances/{instanceId}/edges/{edgeid}
Endpoint para obtener relaciones
URI Parameters
- instanceId: required(string)
- edgeid: required(string)
Example:
b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"type":"AccessTo",
"properties":{
"_id":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba"
},
"from":{
"labels":[
"bitcoin",
"_unique_id"
],
"properties":{
"_id":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a"
}
},
"to":{
"labels":[
"bitcoin",
"_unique_id"
],
"properties":{
"_id":"8e1e4d39-2da9-4ac8-8c46-a52b7a739aba"
}
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
put /strucs/instances/{instanceId}/edges/{edgeid}
Endpoint para modificar atributos de las relaciones
URI Parameters
- instanceId: required(string)
- edgeid: required(string)
Example:
b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"attributes":{
"prueba1":"prueba2"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052ce",
"key":"AccessTo",
"displayName":"Accede a",
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052ca",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052ce",
"id":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba",
"key":"AccessTo",
"attributes":{
"prueba1":"prueba2"
},
"displayName":"Accede a",
"color":"#a5a9ac",
"shapeId":"5c1bb88d45d459573e0052ca",
"sourceId":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a",
"targetId":"8e1e4d39-2da9-4ac8-8c46-a52b7a739aba"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
post /strucs/instances/{instanceId}/edges/{edgeid}
Endpoint para modificar relaciones (origen, destino, tipo y/o atributos)
URI Parameters
- instanceId: required(string)
- edgeid: required(string)
Example:
b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"key":"AccessTo",
"sourceId":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a",
"targetId":"8e1e4d39-2da9-4ac8-8c46-a52b7a739aba"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052ce",
"key":"AccessTo",
"displayName":"Accede a",
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052ca",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052ce",
"id":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba",
"key":"AccessTo",
"attributes":{
},
"displayName":"Accede a",
"color":"#a5a9ac",
"shapeId":"5c1bb88d45d459573e0052ca",
"sourceId":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a",
"targetId":"8e1e4d39-2da9-4ac8-8c46-a52b7a739aba"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
delete /strucs/instances/{instanceId}/edges/{edgeid}
Endpoint para borrar relaciones
URI Parameters
- instanceId: required(string)
- edgeid: required(string)
Example:
b7de19dc-e4d4-4195-b00b-35fa9e6fce8a-AccessTo-8e1e4d39-2da9-4ac8-8c46-a52b7a739aba
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"id":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a-AccessTo-2bba32d8-e861-4b1a-9c62-1a41cb851a01",
"deleted":true
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener nodos
Endpoint para añadir nodos
get /strucs/instances/{instanceId}/nodes
Endpoint para obtener nodos
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"properties": {
"_id": "199351dc-92e7-433d-9fcd-1a00c7308ad8"
},
"labels": [
"_unique_id",
"Site"
]
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
post /strucs/instances/{instanceId}/nodes
Endpoint para añadir nodos
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"key":"bitcoin"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"nodeType":{
"_id":"5c1bb8ddedf74e000e820072",
"key":"bitcoin",
"displayName":"Bitcoin",
"owner":"SELF",
"color":"green",
"tags":[
"moneda"
],
"shapeId":"5c1bb8d7edf74e000e820071",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
},
"name":{
"displayName":"name",
"visible":true,
"type":"number",
"locked":false,
"minimum":10,
"maximum":100
}
},
"id":"23243580-046e-11e9-a18d-49896a310d04",
"type":"object"
}
},
"nodeTypeId":"5c1bb8ddedf74e000e820072",
"id":"b7de19dc-e4d4-4195-b00b-35fa9e6fce8a",
"key":"bitcoin",
"attributes":{
},
"displayName":"Bitcoin",
"color":"green",
"shapeId":"5c1bb8d7edf74e000e820071"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener nodos
get /strucs/instances/{instanceId}/nodes/find
Endpoint para obtener nodos
URI Parameters
- instanceId: required(string)
Headers
- x-clientid: required(string)
Example:
f3a9622b-1b0f-4a50-8847-a30232f23e3f
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- query: (string)
Example:
Contraparada
- label: (string)
Example:
Site
- startDate: (string)
Fecha con hora en formato ISO 8601.
Example:
2023-07-21T08:47:02.392Z
- endDate: (string)
Fecha con hora en formato ISO 8601.
Example:
2023-07-21T08:47:02.392Z
- owner: (string)
Examples:
example:
SELF
example1:
PLATFORM
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"data":{
"total":1,
"nodes":[
{
"id":"b70992a0-474a-425f-a8cf-a8bfdec62ecc",
"owner":"PLATFORM",
"label":"User",
"properties":{
"surname":null,
"isDigitalEntity":false,
"name":"asd2",
"fullName":"asd2",
"id":"b70992a0-474a-425f-a8cf-a8bfdec62ecc",
"avatar":null,
"registerat":null,
"preregisterat":1534931728215,
"email":"asd2@gmail.com"
}
}
]
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para buscar nodos en base a sus atributos
Endpoint para buscar nodos en base a sus atributos
get /strucs/instances/{instanceId}/nodes/byAttributes
Endpoint para buscar nodos en base a sus atributos
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
: (string) Example:
<value>
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"properties":{
"prueba3":"prueba4",
"_id":"199351dc-92e7-433d-9fcd-1a00c7308ad8"
},
"labels":[
"_unique_id",
"Site"
]
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
post /strucs/instances/{instanceId}/nodes/byAttributes
Endpoint para buscar nodos en base a sus atributos
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
" prueba3": "prueba4"
}
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"properties":{
"prueba3":"prueba4",
"_id":"199351dc-92e7-433d-9fcd-1a00c7308ad8"
},
"labels":[
"_unique_id",
"Site"
]
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para buscar nodos en base a su key (Tipos)
get /strucs/instances/{instanceId}/nodes/byKey/{key}
Endpoint para buscar nodos en base a su key (Tipos)
URI Parameters
- instanceId: required(string)
- key: required(string)
Example:
Site
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"properties":{
"_id":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a"
},
"labels":[
"_unique_id",
"Site"
]
},
{
"properties":{
"_id":"c8e85af8-2da8-449a-86ab-f46da082e9a8"
},
"labels":[
"_unique_id",
"Site"
]
},
{
"properties":{
"prueba3":"prueba4",
"_id":"199351dc-92e7-433d-9fcd-1a00c7308ad8"
},
"labels":[
"_unique_id",
"Site"
]
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para buscar nodos en base a su key (Tipos) y sus propiedades
Endpoint para buscar nodos en base a su key (Tipos) y sus propiedades
get /strucs/instances/{instanceId}/nodes/byKey/{key}/byAttributes
Endpoint para buscar nodos en base a su key (Tipos) y sus propiedades
URI Parameters
- instanceId: required(string)
- key: required(string)
Example:
Site
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
: (string) Example:
<value>
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"properties": {
"_id": "2bbd14fe-d481-4640-9045-fadb7a9b4c3a"
},
"labels": [
"_unique_id",
"Site"
]
},
{
"properties": {
"_id": "c8e85af8-2da8-449a-86ab-f46da082e9a8"
},
"labels": [
"_unique_id",
"Site"
]
},
{
"properties": {
"prueba3": "prueba4",
"_id": "199351dc-92e7-433d-9fcd-1a00c7308ad8"
},
"labels": [
"_unique_id",
"Site"
]
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
post /strucs/instances/{instanceId}/nodes/byKey/{key}/byAttributes
Endpoint para buscar nodos en base a su key (Tipos) y sus propiedades
URI Parameters
- instanceId: required(string)
- key: required(string)
Example:
Site
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"prueba3": "prueba4"
}
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"properties": {
"_id": "2bbd14fe-d481-4640-9045-fadb7a9b4c3a"
},
"labels": [
"_unique_id",
"Site"
]
},
{
"properties": {
"_id": "c8e85af8-2da8-449a-86ab-f46da082e9a8"
},
"labels": [
"_unique_id",
"Site"
]
},
{
"properties": {
"prueba3": "prueba4",
"_id": "199351dc-92e7-433d-9fcd-1a00c7308ad8"
},
"labels": [
"_unique_id",
"Site"
]
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener un nodo en base al identificador del nodo
Endpoint para editar un nodo en base al identificador del nodo
Endpoint para borrar un nodo en base al identificador del nodo
get /strucs/instances/{instanceId}/nodes/{id}
Endpoint para obtener un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
b06ee7d9-0269-45ee-9519-af978e9f1152
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"properties":{
"_id":"b06ee7d9-0269-45ee-9519-af978e9f1152"
},
"labels":[
"_unique_id",
"Site"
]
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
put /strucs/instances/{instanceId}/nodes/{id}
Endpoint para editar un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
b06ee7d9-0269-45ee-9519-af978e9f1152
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"attributes":{
"name":11,
"other":111
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"nodeType":{
"_id":"5c1bb8ddedf74e000e820072",
"key":"bitcoin",
"displayName":"Bitcoin",
"owner":"SELF",
"color":"green",
"tags":[
"moneda"
],
"shapeId":"5c1bb8d7edf74e000e820071",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
},
"name":{
"displayName":"name",
"visible":true,
"type":"number",
"locked":false,
"minimum":10,
"maximum":100
}
},
"id":"23243580-046e-11e9-a18d-49896a310d04",
"type":"object"
}
},
"nodeTypeId":"5c1bb8ddedf74e000e820072",
"id":"8e1e4d39-2da9-4ac8-8c46-a52b7a739aba",
"key":"bitcoin",
"attributes":{
"name":11,
"other":111
},
"displayName":"Bitcoin",
"color":"green",
"shapeId":"5c1bb8d7edf74e000e820071"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
delete /strucs/instances/{instanceId}/nodes/{id}
Endpoint para borrar un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
b06ee7d9-0269-45ee-9519-af978e9f1152
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"id":"b06ee7d9-0269-45ee-9519-af978e9f1152",
"deleted":true,
"edgesDeleted":0
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Obtener sumario asociado a un nodo en base al identificador del nodo
get /strucs/instances/{instanceId}/nodes/{id}/summary
Obtener sumario asociado a un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
b06ee7d9-0269-45ee-9519-af978e9f1152
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve un sumario formado por nodos, tipos de nodo, relaciones y tipos de relaciones. El sumario obtiene todos los nodos asociados y las relaciones entre ellos así como las relaciones con el nodo origen y relaciones a terceros.
Body
Media type: application/json
Type: object
Example:
{
"nodes":[
{
"labels":[
"User"
],
"properties":{
"name":"Leandro",
"avatar":"{\n \"original\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/yzc5nwy1odgtzthkmc00n2rmlthkotityzg1zjnlogqym2mx-avatarcontent/q2LaL8bMdG676R5Ai1YKRshEpAhVOB4RoDh4CiwrNzHlL7ecTUkMGAHV6yPqJiyF_original.png\"\n },\n \"small\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/yzc5nwy1odgtzthkmc00n2rmlthkotityzg1zjnlogqym2mx-avatarcontent/q2LaL8bMdG676R5Ai1YKRshEpAhVOB4RoDh4CiwrNzHlL7ecTUkMGAHV6yPqJiyF_small.png\"\n },\n \"medium\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/yzc5nwy1odgtzthkmc00n2rmlthkotityzg1zjnlogqym2mx-avatarcontent/q2LaL8bMdG676R5Ai1YKRshEpAhVOB4RoDh4CiwrNzHlL7ecTUkMGAHV6yPqJiyF_medium.png\"\n },\n \"large\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/yzc5nwy1odgtzthkmc00n2rmlthkotityzg1zjnlogqym2mx-avatarcontent/q2LaL8bMdG676R5Ai1YKRshEpAhVOB4RoDh4CiwrNzHlL7ecTUkMGAHV6yPqJiyF_large.png\"\n }\n}",
"email":"lmramello@externalpartner.com",
"_id":"c795f588-e8d0-47df-8d92-c85f3e8d23c1",
"fullName":"Leandro Ramello Marchioni",
"surname":"Ramello Marchioni",
"id":"c795f588-e8d0-47df-8d92-c85f3e8d23c1",
"isDigitalEntity":false,
"registerat":1483228800000
}
},
{
"labels":[
"Office"
],
"properties":{
"name":"Hospitalet",
"_id":"ad329561-9777-42f5-8336-1448e853733b"
}
},
{
"labels":[
"Office"
],
"properties":{
"name":"Sabadell",
"_id":"4663cd82-5496-41b7-8b7e-3e26ca10a8d1"
}
},
{
"labels":[
"Office"
],
"properties":{
"name":"Barberá",
"_id":"64ba2bb4-9335-4ad2-9e9a-16750c8ecab0"
}
},
{
"labels":[
"SiteGroup"
],
"properties":{
"name":"Mediterraneo",
"_id":"35dc6549-5bed-4486-a580-e4c1dead0e42"
}
},
{
"labels":[
"SiteGroup"
],
"properties":{
"name":"ESPAÑA",
"_id":"14a357bc-1a0f-406d-a415-1dd9cb3143e4"
}
}
],
"nodesLabels":[
"User",
"Office",
"SiteGroup"
],
"relationships":[
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-ad329561-9777-42f5-8336-1448e853733b"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"ad329561-9777-42f5-8336-1448e853733b"
},
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-4663cd82-5496-41b7-8b7e-3e26ca10a8d1"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"4663cd82-5496-41b7-8b7e-3e26ca10a8d1"
},
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-64ba2bb4-9335-4ad2-9e9a-16750c8ecab0"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"64ba2bb4-9335-4ad2-9e9a-16750c8ecab0"
},
{
"type":"Contains",
"properties":{
"_id":"35dc6549-5bed-4486-a580-e4c1dead0e42-Contains-274579e4-ae2e-4e72-b790-a76f91ebf047"
},
"from":"35dc6549-5bed-4486-a580-e4c1dead0e42",
"to":"274579e4-ae2e-4e72-b790-a76f91ebf047"
},
{
"type":"Contains",
"properties":{
"_id":"14a357bc-1a0f-406d-a415-1dd9cb3143e4-Contains-274579e4-ae2e-4e72-b790-a76f91ebf047"
},
"from":"14a357bc-1a0f-406d-a415-1dd9cb3143e4",
"to":"274579e4-ae2e-4e72-b790-a76f91ebf047"
},
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
{
"type":"AccessTo",
"properties":{
"_id":"4663cd82-5496-41b7-8b7e-3e26ca10a8d1-AccessTo-c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"from":"4663cd82-5496-41b7-8b7e-3e26ca10a8d1",
"to":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
{
"type":"Contains",
"properties":{
"_id":"c795f588-e8d0-47df-8d92-c85f3e8d23c1-Contains-10153b08-bf01-4d3e-bdd1-8616e2fa6239"
},
"from":"c795f588-e8d0-47df-8d92-c85f3e8d23c1",
"to":"10153b08-bf01-4d3e-bdd1-8616e2fa6239"
},
{
"type":"AccessTo",
"properties":{
"_id":"e681d61d-13fe-4c3e-bce2-4ef21da57885-AccessTo-c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"from":"e681d61d-13fe-4c3e-bce2-4ef21da57885",
"to":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
{
"type":"AccessTo",
"properties":{
"_id":"f3fbbc86-cb7f-4efb-8e9d-ee835f5d5f55-AccessTo-c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"from":"f3fbbc86-cb7f-4efb-8e9d-ee835f5d5f55",
"to":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
{
"type":"AccessTo",
"properties":{
"_id":"f46896b7-dd87-4598-a0bb-079f56afa3f3-AccessTo-ad329561-9777-42f5-8336-1448e853733b"
},
"from":"f46896b7-dd87-4598-a0bb-079f56afa3f3",
"to":"ad329561-9777-42f5-8336-1448e853733b"
},
{
"type":"AccessTo",
"properties":{
"_id":"ad329561-9777-42f5-8336-1448e853733b-AccessTo-f46896b7-dd87-4598-a0bb-079f56afa3f3"
},
"from":"ad329561-9777-42f5-8336-1448e853733b",
"to":"f46896b7-dd87-4598-a0bb-079f56afa3f3"
},
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-ad329561-9777-42f5-8336-1448e853733b"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"ad329561-9777-42f5-8336-1448e853733b"
},
{
"type":"AccessTo",
"properties":{
"_id":"64ba2bb4-9335-4ad2-9e9a-16750c8ecab0-AccessTo-4663cd82-5496-41b7-8b7e-3e26ca10a8d1"
},
"from":"64ba2bb4-9335-4ad2-9e9a-16750c8ecab0",
"to":"4663cd82-5496-41b7-8b7e-3e26ca10a8d1"
},
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-4663cd82-5496-41b7-8b7e-3e26ca10a8d1"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"4663cd82-5496-41b7-8b7e-3e26ca10a8d1"
},
{
"type":"Contains",
"properties":{
"_id":"274579e4-ae2e-4e72-b790-a76f91ebf047-Contains-64ba2bb4-9335-4ad2-9e9a-16750c8ecab0"
},
"from":"274579e4-ae2e-4e72-b790-a76f91ebf047",
"to":"64ba2bb4-9335-4ad2-9e9a-16750c8ecab0"
},
{
"type":"Contains",
"properties":{
"_id":"35dc6549-5bed-4486-a580-e4c1dead0e42-Contains-274579e4-ae2e-4e72-b790-a76f91ebf047"
},
"from":"35dc6549-5bed-4486-a580-e4c1dead0e42",
"to":"274579e4-ae2e-4e72-b790-a76f91ebf047"
},
{
"type":"Contains",
"properties":{
"_id":"35dc6549-5bed-4486-a580-e4c1dead0e42-Contains-2cef5920-770c-4456-9c3d-67329281e33c"
},
"from":"35dc6549-5bed-4486-a580-e4c1dead0e42",
"to":"2cef5920-770c-4456-9c3d-67329281e33c"
},
{
"type":"Contains",
"properties":{
"_id":"35dc6549-5bed-4486-a580-e4c1dead0e42-Contains-91a4136f-5a9c-40e9-8da9-d8fa8c1aa4ba"
},
"from":"35dc6549-5bed-4486-a580-e4c1dead0e42",
"to":"91a4136f-5a9c-40e9-8da9-d8fa8c1aa4ba"
},
{
"type":"Contains",
"properties":{
"_id":"14a357bc-1a0f-406d-a415-1dd9cb3143e4-Contains-274579e4-ae2e-4e72-b790-a76f91ebf047"
},
"from":"14a357bc-1a0f-406d-a415-1dd9cb3143e4",
"to":"274579e4-ae2e-4e72-b790-a76f91ebf047"
},
{
"type":"Contains",
"properties":{
"_id":"14a357bc-1a0f-406d-a415-1dd9cb3143e4-Contains-2cef5920-770c-4456-9c3d-67329281e33c"
},
"from":"14a357bc-1a0f-406d-a415-1dd9cb3143e4",
"to":"2cef5920-770c-4456-9c3d-67329281e33c"
},
{
"type":"Contains",
"properties":{
"_id":"14a357bc-1a0f-406d-a415-1dd9cb3143e4-Contains-f00823eb-8e20-4cc5-99f1-123e96590c30"
},
"from":"14a357bc-1a0f-406d-a415-1dd9cb3143e4",
"to":"f00823eb-8e20-4cc5-99f1-123e96590c30"
}
],
"relationshipsLabels":[
"Contains",
"AccessTo"
]
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener relaciones en base al identificador del nodo
get /strucs/instances/{instanceId}/nodes/{id}/edges
Endpoint para obtener relaciones en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
b06ee7d9-0269-45ee-9519-af978e9f1152
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"type":"AccessTo",
"properties":{
"_id":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a-AccessTo-c8e85af8-2da8-449a-86ab-f46da082e9a8"
},
"from":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a",
"to":"c8e85af8-2da8-449a-86ab-f46da082e9a8"
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener todas las relaciones salientes de un nodo en base al identificador del nodo
get /strucs/instances/{instanceId}/nodes/{id}/edges/outgoing
Endpoint para obtener todas las relaciones salientes de un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
b06ee7d9-0269-45ee-9519-af978e9f1152
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener todas las relaciones salientes de un nodo en base al identificador del nodo
get /strucs/instances/{instanceId}/nodes/{id}/edges/incoming
Endpoint para obtener todas las relaciones salientes de un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
b06ee7d9-0269-45ee-9519-af978e9f1152
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"type":"AccessTo",
"properties":{
"_id":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a-AccessTo-c8e85af8-2da8-449a-86ab-f46da082e9a8"
},
"from":"2bbd14fe-d481-4640-9045-fadb7a9b4c3a",
"to":"c8e85af8-2da8-449a-86ab-f46da082e9a8"
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Búsqueda de entidades customizable. Pueden realizarse varias consultas a la vez. Cuando una consulta devuelve varios nodos de una misma relación, el orden está garantizado
post /strucs/instances/{instanceId}/search
Búsqueda de entidades customizable. Pueden realizarse varias consultas a la vez. Cuando una consulta devuelve varios nodos de una misma relación, el orden está garantizado
URI Parameters
- instanceId: required(uuid)
Example:
8a23d7dc-51f2-4fc9-b174-9145699094e0
Query Parameters
- mergeResults: (boolean - default: false)
Si se necesita devolver los resultados sin duplicados. Con sólo escribir el parámetro es suficiente ("?mergeResults")
Body
Media type: application/json
Type: object
Properties- type: (string)
El tipo de nodo a buscar. Si el nodo es intermedio en la relación no debe ser especificado
- returnAs: (string)
El nombre con el que se devolverá los resultados del nodo. Si el nodo es intermedio en la relación no debe ser especificado
- queryBy: (object)
Objeto con parámetros de búsqueda para el nodo. Si el nodo es intermedio en la relación no debe ser especificado
- isIntermediate: (boolean)
Indica si el nodo es intermedio en la relación. Usar cuando se busquen relaciones con varios nodos de profundidad.
- edge: (object)
Relación del nodo a buscar con otros nodos. Si el nodo es intermedio debe ser especificado
- type: (string)
El tipo de la relación
- queryBy: (object)
Objeto con parámetros de búsqueda para la relación
- node: required(object)
Misma parametrización que objeto base
- type: (string)
Examples:
Consulta normal:
[
{
"type": "User",
"queryBy": {
"_id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595"
},
"edge": {
"type": "friendWith",
"node": {
"type": "User",
"returnAs": "friends"
}
}
}
]
Multiples consultas:
[
{
"type": "User",
"queryBy": {
"_id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595"
},
"edge": {
"type": "friendWith",
"node": {
"type": "User",
"returnAs": "friends"
}
}
},
{
"type": "User",
"queryBy": {
"_id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595"
},
"edge": {
"type": "friendWith",
"node": {
"type": "User",
"returnAs": "friends",
"queryBy": {
"name": "Pedro"
}
}
}
}
]
Con nodo intermedio:
[
{
"type": "User",
"queryBy": {
"_id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595"
},
"edge": {
"type": "AccessTo",
"node": {
"isIntermediate": true,
"edge": {
"type": "Contains",
"node": {
"type": "Site",
"returnAs": "site"
}
}
}
}
}
]
HTTP status code 200
Búsqueda correcta
Body
Media type: application/json
Type: array | object
Examples:
Consulta normal:
[
{
"friends": [
{
"labels": [
"User"
],
"properties": {
"_id": "fd13fb25-f00b-4c8b-a9ae-4b8a8a778425",
"name": "Pedro",
"age": 25
}
},
{
"labels": [
"User"
],
"properties": {
"_id": "e564824a-14ec-4087-8e0b-e74ade6e21cf",
"name": "Maria",
"age": 30
}
}
]
}
]
Multiples consultas:
[
{
"friends": [
{
"labels": [
"User"
],
"properties": {
"_id": "fd13fb25-f00b-4c8b-a9ae-4b8a8a778425",
"name": "Pedro",
"age": 25
}
},
{
"labels": [
"User"
],
"properties": {
"_id": "e564824a-14ec-4087-8e0b-e74ade6e21cf",
"name": "Maria",
"age": 30
}
}
]
},
{
"friends": [
{
"labels": [
"User"
],
"properties": {
"_id": "fd13fb25-f00b-4c8b-a9ae-4b8a8a778425",
"name": "Pedro",
"age": 25
}
}
]
}
]
Multiples consultas con "mergeResult":
{
"friends": [
{
"labels": [
"User"
],
"properties": {
"_id": "fd13fb25-f00b-4c8b-a9ae-4b8a8a778425",
"name": "Pedro",
"age": 25
}
},
{
"labels": [
"User"
],
"properties": {
"_id": "e564824a-14ec-4087-8e0b-e74ade6e21cf",
"name": "Maria",
"age": 30
}
}
]
}
HTTP status code 400
Búsqueda con parámetros incorrectos
Body
Media type: application/json
Type: object
Example:
{
"error": "Validation Failed",
"details": [
{
"type": "\"[0].type\" must be a string"
}
]
}
HTTP status code 500
Error interno
Body
Media type: application/json
Type: object
Example:
{
"error": "Some error ocurred."
}
Endpoint para obtener las explotaciones asociadas a un usuario
Endpoint para obtener las explotaciones asociadas a un usuario
get /strucs/instances/{instanceId}/queries/userSites/{accountId}
Endpoint para obtener las explotaciones asociadas a un usuario
URI Parameters
- instanceId: required(string)
- accountId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"user_id":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"sites":[
{
"labels":[
"Site"
],
"properties":{
"_id":"cbd4d275-1918-4c44-af4c-bcb8d4171aaa"
}
},
{
"labels":[
"Site"
],
"properties":{
"_id":"66f3f894-e298-4c9b-9af5-a4889636d44a"
}
},
{
"labels":[
"Site"
],
"properties":{
"city":"Benidorm",
"_id":"fdf786c1-2f7c-4c49-a492-af14ae90970e"
}
},
{
"labels":[
"Site"
],
"properties":{
"_id":"6633ffe8-8486-4431-b9f2-48266bfe4e0c"
}
},
{
"labels":[
"Site"
],
"properties":{
"_id":"ff807965-76cc-4193-90ad-a49215ac826a"
}
}
]
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener datos de una pizarra
get /strucs/instances/{instanceId}/boards
Endpoint para obtener datos de una pizarra
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"nodes":[
{
"nodeType":{
"_id":"5c1bb8ddedf74e000e820072",
"key":"bitcoin",
"displayName":"Bitcoin",
"owner":"SELF",
"color":"green",
"tags":[
"moneda"
],
"shapeId":"5c1bb8d7edf74e000e820071",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
},
"name":{
"displayName":"name",
"visible":true,
"type":"number",
"locked":false,
"minimum":10,
"maximum":100
}
},
"id":"23243580-046e-11e9-a18d-49896a310d04",
"type":"object"
}
},
"nodeTypeId":"5c1bb8ddedf74e000e820072",
"id":"192e24dd-565d-4dbd-a002-71ea334dafb2",
"key":"bitcoin",
"attributes":{
"name":11,
"other":111
},
"displayName":"Bitcoin",
"color":"green",
"shapeId":"5c1bb8d7edf74e000e820071"
},
{
"nodeType":{
"_id":"5c1bb8ddedf74e000e820072",
"key":"bitcoin",
"displayName":"Bitcoin",
"owner":"SELF",
"color":"green",
"tags":[
"moneda"
],
"shapeId":"5c1bb8d7edf74e000e820071",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
},
"name":{
"displayName":"name",
"visible":true,
"type":"number",
"locked":false,
"minimum":10,
"maximum":100
}
},
"id":"23243580-046e-11e9-a18d-49896a310d04",
"type":"object"
}
},
"nodeTypeId":"5c1bb8ddedf74e000e820072",
"id":"3a2ff3fb-d2b4-4881-9057-4f360560041b",
"key":"bitcoin",
"attributes":{
},
"displayName":"Bitcoin",
"color":"green",
"shapeId":"5c1bb8d7edf74e000e820071"
}
],
"edges":[
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052ce",
"key":"AccessTo",
"displayName":"Accede a",
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052ca",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052ce",
"id":"192e24dd-565d-4dbd-a002-71ea334dafb2-AccessTo-3a2ff3fb-d2b4-4881-9057-4f360560041b",
"key":"AccessTo",
"attributes":{
},
"displayName":"Accede a",
"color":"#a5a9ac",
"shapeId":"5c1bb88d45d459573e0052ca",
"sourceId":"192e24dd-565d-4dbd-a002-71ea334dafb2",
"targetId":"3a2ff3fb-d2b4-4881-9057-4f360560041b"
}
]
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Obtener la información completa asociad a un nodo en base al identificador del nodo
get /strucs/instances/{instanceId}/boards/nodes/{id}
Obtener la información completa asociad a un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de un nodo con su información del catálogo asociada.
Body
Media type: application/json
Type: object
Example:
{
"nodeType":{
"_id":"5c1bb88d45d459573e0052c8",
"key":"UserGroup",
"displayName":"Grupo de usuarios",
"owner":"PLATFORM",
"color":"#ff9800",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052bd",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"UserGroup#",
"title":"UserGroup",
"type":"object",
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":false
},
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"description":{
"displayName":"Descripción",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
}
}
},
"defaultLabelTemplate":"{{{name}}}"
},
"nodeTypeId":"5c1bb88d45d459573e0052c8",
"id":"192e24dd-565d-4dbd-a002-71ea334dafb2",
"key":"UserGroup",
"attributes":{
"name":"Otro grupo",
"clientId":"f3a9622b-1b0f-4a50-8847-a30232f23e3f",
"description":"",
"id":"192e24dd-565d-4dbd-a002-71ea334dafb2"
},
"displayName":"Grupo de usuarios",
"color":"#ff9800",
"shapeId":"5c1bb88d45d459573e0052bd",
"defaultLabel":"Otro grupo"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Obtener sumario asociado a un nodo en base al identificador del nodo
get /strucs/instances/{instanceId}/boards/nodes/{id}/summary
Obtener sumario asociado a un nodo en base al identificador del nodo
URI Parameters
- instanceId: required(string)
- id: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve un sumario formado por nodos, tipos de nodo, relaciones y tipos de relaciones. El sumario obtiene todos los nodos asociados y las relaciones entre ellos así como las relaciones con el nodo origen y relaciones a terceros completado con la información asociada al catálogo.
Body
Media type: application/json
Type: object
Example:
{
"nodes":[
{
"nodeType":{
"_id":"5c1bb88d45d459573e0052c9",
"key":"User",
"displayName":"Usuario",
"owner":"PLATFORM",
"color":"#ff9800",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052bc",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"User#",
"title":"User",
"type":"object",
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
},
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":true
},
"surname":{
"displayName":"Apellidos",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":true
},
"email":{
"displayName":"Email",
"type":"string",
"pattern":"(?=^(([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$)(?=^(.){1,64}@(.){1,254}$)",
"visible":true,
"locked":true
},
"roles":{
"displayName":"Roles",
"type":"array",
"items":{
"type":"string"
},
"visible":true,
"locked":true
}
}
},
"defaultLabelTemplate":"{{{name}}} {{{surname}}}"
},
"nodeTypeId":"5c1bb88d45d459573e0052c9",
"id":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"key":"User",
"attributes":{
"name":"Juan Carlos",
"avatar":"{\n \"original\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_original.jpg\"\n },\n \"small\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_small.jpg\"\n },\n \"medium\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_medium.jpg\"\n },\n \"large\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_large.jpg\"\n }\n}",
"email":"juancarlos.lloret@aqualogybs.net",
"fullName":"Juan Carlos Lloret Hernández",
"surname":"Lloret Hernández",
"id":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"isDigitalEntity":false,
"registerat":1483228800000
},
"displayName":"Usuario",
"color":"#ff9800",
"shapeId":"5c1bb88d45d459573e0052bc",
"defaultLabel":"Juan Carlos Lloret Hernández"
}
],
"edges":[
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052ce",
"key":"AccessTo",
"displayName":"Accede a",
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052ca",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052ce",
"id":"16c83d75-2697-47f0-ad6d-e42cc03faad8-AccessTo-192e24dd-565d-4dbd-a002-71ea334dafb2",
"key":"AccessTo",
"attributes":{
},
"displayName":"Accede a",
"color":"#a5a9ac",
"shapeId":"5c1bb88d45d459573e0052ca",
"sourceId":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"targetId":"192e24dd-565d-4dbd-a002-71ea334dafb2"
},
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052c7",
"key":"asignedTo",
"displayName":"Asignado a",
"owner":"PLATFORM",
"color":"#ff9800",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052c5",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"asignedTo#",
"title":"asignedTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052c7",
"id":"16c83d75-2697-47f0-ad6d-e42cc03faad8-asignedTo-ebb565e9-f590-4b8e-a989-a4351b0d8492",
"key":"asignedTo",
"attributes":{
},
"displayName":"Asignado a",
"color":"#ff9800",
"shapeId":"5c1bb88d45d459573e0052c5",
"sourceId":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"targetId":"ebb565e9-f590-4b8e-a989-a4351b0d8492"
},
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052ce",
"key":"AccessTo",
"displayName":"Accede a",
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052ca",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052ce",
"id":"16c83d75-2697-47f0-ad6d-e42cc03faad8-AccessTo-4b716c0d-cde9-42f9-bcd1-ad70518da66b",
"key":"AccessTo",
"attributes":{
},
"displayName":"Accede a",
"color":"#a5a9ac",
"shapeId":"5c1bb88d45d459573e0052ca",
"sourceId":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"targetId":"4b716c0d-cde9-42f9-bcd1-ad70518da66b"
}
]
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Obtener la información completa asociad a una relación en base al identificador de la relación
get /strucs/instances/{instanceId}/boards/edges/{id}
Obtener la información completa asociad a una relación en base al identificador de la relación
URI Parameters
- instanceId: required(string)
- id: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de una relación con su información del catálogo asociada.
Body
Media type: application/json
Type: object
Example:
{
"edgeType":{
"_id":"5c1bb88d45d459573e0052ce",
"key":"AccessTo",
"displayName":"Accede a",
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"shapeId":"5c1bb88d45d459573e0052ca",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
}
},
"edgeTypeId":"5c1bb88d45d459573e0052ce",
"id":"16c83d75-2697-47f0-ad6d-e42cc03faad8-AccessTo-192e24dd-565d-4dbd-a002-71ea334dafb2",
"key":"AccessTo",
"attributes":{
},
"displayName":"Accede a",
"color":"#a5a9ac",
"shapeId":"5c1bb88d45d459573e0052ca",
"sourceId":{
"labels":[
"User",
"_unique_id"
],
"properties":{
"surname":"Lloret Hernández",
"isDigitalEntity":false,
"name":"Juan Carlos",
"fullName":"Juan Carlos Lloret Hernández",
"id":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"avatar":"{\n \"original\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_original.jpg\"\n },\n \"small\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_small.jpg\"\n },\n \"medium\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_medium.jpg\"\n },\n \"large\" : {\n \"url\" : \"https://absneargodevimages1002.blob.core.windows.net/mtzjodnknzutmjy5ny00n2ywlwfknmqtztqyy2mwm2zhywq4-avatarcontent/3Ah6PcPBRPvCi6htziF1GYAzHSoaSvhQ228T6KMipQFOqatOO0J3ImInaGCAIxJU_large.jpg\"\n }\n}",
"_id":"16c83d75-2697-47f0-ad6d-e42cc03faad8",
"registerat":1483228800000,
"email":"juancarlos.lloret@aqualogybs.net"
}
},
"targetId":{
"labels":[
"UserGroup",
"_unique_id"
],
"properties":{
"clientId":"f3a9622b-1b0f-4a50-8847-a30232f23e3f",
"name":"Otro grupo",
"description":"",
"id":"192e24dd-565d-4dbd-a002-71ea334dafb2",
"_id":"192e24dd-565d-4dbd-a002-71ea334dafb2"
}
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener todos los catálogos de una instancia
get /strucs/instances/{instanceId}/catalogs
Endpoint para obtener todos los catálogos de una instancia
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- first: (number)
- offset: (number)
- term: (string)
- all: (string)
HTTP status code 200
Devuelve la lista de catálogos visibles por una instancia
Body
Media type: application/json
Type: object
Example:
{
"items":[
{
"_id":"5c1b887cc10602383cc008b1",
"version":1,
"displayName":"Plataforma",
"name":"platform_catalog",
"author":{
"type":"SYSTEM"
},
"edgeTypes":[
{
"owner":"PLATFORM",
"color":"#ff9800",
"tags":[
],
"_id":"5c1b887cc10602383cc008b2",
"key":"asignedTo",
"displayName":"Asignado a",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"asignedTo#",
"title":"asignedTo",
"type":"object",
"properties":{
}
},
"shapeId":"5c1b887cc10602383cc008b0"
}
],
"nodeTypes":[
{
"owner":"PLATFORM",
"color":"#ff9800",
"tags":[
],
"_id":"5c1b887cc10602383cc008b4",
"key":"User",
"displayName":"Usuario",
"defaultLabelTemplate":"{{{name}}} {{{surname}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"User#",
"title":"User",
"type":"object",
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
},
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":true
},
"surname":{
"displayName":"Apellidos",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":true
},
"email":{
"displayName":"Email",
"type":"string",
"pattern":"(?=^(([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$)(?=^(.){1,64}@(.){1,254}$)",
"visible":true,
"locked":true
},
"roles":{
"displayName":"Roles",
"type":"array",
"items":{
"type":"string"
},
"visible":true,
"locked":true
}
}
},
"shapeId":"5c1b887cc10602383cc008a7"
},
{
"owner":"PLATFORM",
"color":"#ff9800",
"tags":[
],
"_id":"5c1b887cc10602383cc008b3",
"key":"UserGroup",
"displayName":"Grupo de usuarios",
"defaultLabelTemplate":"{{{name}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"UserGroup#",
"title":"UserGroup",
"type":"object",
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":false
},
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"description":{
"displayName":"Descripción",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008a8"
}
],
"createdAt":"2018-12-20T12:18:04.165Z",
"updatedAt":"2018-12-20T12:18:04.167Z"
},
{
"_id":"5c1b887cc10602383cc008b7",
"version":1,
"displayName":"Catálogo Básico",
"name":"basic_catalog",
"author":{
"type":"SYSTEM"
},
"edgeTypes":[
{
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"_id":"5c1b887cc10602383cc008b9",
"key":"AccessTo",
"displayName":"Accede a",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AccessTo#",
"title":"AccessTo",
"type":"object",
"properties":{
}
},
"shapeId":"5c1b887cc10602383cc008b5"
},
{
"owner":"SELF",
"color":"#a5a9ac",
"tags":[
],
"_id":"5c1b887cc10602383cc008b8",
"key":"Contains",
"displayName":"Contiene",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"Contains#",
"title":"Contains",
"type":"object",
"properties":{
}
},
"shapeId":"5c1b887cc10602383cc008b6"
}
],
"nodeTypes":[
{
"owner":"SELF",
"color":"#46a3cb",
"tags":[
],
"_id":"5c1b887cc10602383cc008c0",
"key":"Site",
"displayName":"Explotación",
"defaultLabelTemplate":"{{{name}}} {{{city}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"Site#",
"title":"Site",
"type":"object",
"properties":{
"country":{
"displayName":"País",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"city":{
"displayName":"Ciudad",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"desc":{
"displayName":"Descripción",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008a9"
},
{
"owner":"SELF",
"color":"#cc5980",
"tags":[
],
"_id":"5c1b887cc10602383cc008bf",
"key":"SiteGroup",
"displayName":"Grupo de explotaciones",
"defaultLabelTemplate":"{{{name}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"SiteGroup#",
"title":"SiteGroup",
"type":"object",
"properties":{
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"desc":{
"displayName":"Descripción",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"trace":{
"displayName":"Traza",
"type":"number",
"visible":true,
"locked":false
},
"ids":{
"displayName":"Traza",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$"
},
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008aa"
},
{
"owner":"SELF",
"color":"#43474f",
"tags":[
],
"_id":"5c1b887cc10602383cc008be",
"key":"AreaManager",
"displayName":"Area Manager",
"defaultLabelTemplate":"{{{name}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"AreaManager#",
"title":"AreaManager",
"type":"object",
"properties":{
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008ab"
},
{
"owner":"SELF",
"color":"#6b7d81",
"tags":[
],
"_id":"5c1b887cc10602383cc008bd",
"key":"ConcessionManagement",
"displayName":"Dirección Concesional",
"defaultLabelTemplate":"{{{name}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"ConcessionManagement#",
"title":"ConcessionManagement",
"type":"object",
"properties":{
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008ac"
},
{
"owner":"SELF",
"color":"#2fc4a6 ",
"tags":[
],
"_id":"5c1b887cc10602383cc008bc",
"key":"ZoneManagement",
"displayName":"Dirección de Zona",
"defaultLabelTemplate":"{{{name}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"ZoneManagement#",
"title":"ZoneManagement",
"type":"object",
"properties":{
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008ad"
},
{
"owner":"SELF",
"color":"#6b69a9",
"tags":[
],
"_id":"5c1b887cc10602383cc008bb",
"key":"Company",
"displayName":"Sociedad",
"defaultLabelTemplate":"{{{name}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"Company#",
"title":"Company",
"type":"object",
"properties":{
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"desc":{
"displayName":"Descripción",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
},
"id":{
"displayName":"Id",
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008ae"
},
{
"owner":"SELF",
"color":"#71BC78",
"tags":[
],
"_id":"5c1b887cc10602383cc008ba",
"key":"Office",
"displayName":"Oficina",
"defaultLabelTemplate":"{{{name}}}",
"validationSchema":{
"additionalProperties":true,
"required":[
],
"id":"Office#",
"title":"Office",
"type":"object",
"properties":{
"name":{
"displayName":"Nombre",
"type":"string",
"minLength":3,
"maxLength":200,
"visible":true,
"locked":false
}
}
},
"shapeId":"5c1b887cc10602383cc008af"
}
],
"createdAt":"2018-12-20T12:18:04.187Z",
"updatedAt":"2018-12-20T12:18:04.190Z"
},
{
"_id":"5c1b88a33cad843859c7739b",
"version":1,
"displayName":"Catálogo Básico2",
"name":"basic_catalog2",
"author":{
"type":"USER",
"instanceId":"ed51cc4d-56b9-45ca-8076-315087150ec0",
"accountId":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"nodeTypes":[
{
"owner":"PLATFORM",
"color":"red",
"tags":[
"moneda"
],
"_id":"5c1b89373cad843859c7739c",
"key":"bitcoin29",
"displayName":"Bitcoin",
"shapeId":"5c1b889c3cad843859c7739a",
"validationSchema":{
"additionalProperties":true,
"required":[
"id"
],
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b88a33cad843859c7739b_bitcoin29",
"title":"Bitcoin",
"type":"object"
}
}
],
"edgeTypes":[
],
"createdAt":"2018-12-20T12:18:44.000Z",
"updatedAt":"2018-12-20T12:18:44.001Z"
}
],
"totalCount":3,
"pageInfo":{
"hasNextPage":false
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener un catálogo
get /strucs/instances/{instanceId}/catalogs/{id}
Endpoint para obtener un catálogo
URI Parameters
- instanceId: required(string)
- id: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información del catálogo.
Body
Media type: application/json
Type: object
Example:
{
"version":1,
"_id":"5c1b7b313af0b82c09195ffc",
"displayName":"Catálogo Básico2",
"name":"basic_catalog2",
"author":{
"type":"USER",
"instanceId":"ed51cc4d-56b9-45ca-8076-315087150ec0",
"accountId":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"nodeTypes":[
{
"owner":"PLATFORM",
"color":"red",
"tags":[
"moneda"
],
"_id":"5c1b7b3f3af0b82c09195ffd",
"key":"bitcoin27",
"displayName":"Bitcoin",
"shapeId":"5c1b68e37e59da26c87e0496"
},
{
"owner":"PLATFORM",
"color":"red",
"tags":[
"moneda"
],
"_id":"5c1b7be93af0b82c09196001",
"key":"bitcoin28",
"displayName":"Bitcoin",
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_bitcoin28",
"title":"Bitcoin",
"type":"object"
}
}
],
"edgeTypes":[
{
"owner":"PLATFORM",
"color":"green",
"tags":[
"joy"
],
"_id":"5c1b7b833af0b82c09195ffe",
"key":"gather_in",
"displayName":"Reunidos",
"shapeId":"5c1b68e37e59da26c87e0496"
},
{
"owner":"PLATFORM",
"color":"green",
"tags":[
"joy"
],
"_id":"5c1b7baf3af0b82c09195fff",
"key":"gather_in2",
"displayName":"Reunidos",
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_gather_in2",
"title":"Reunidos",
"type":"object"
}
}
],
"createdAt":"2018-12-20T11:21:21.838Z",
"updatedAt":"2018-12-20T11:21:21.846Z"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener tipos de nodos en base a su identificador
get /strucs/instances/{instanceId}/nodeTypes/{id}
Endpoint para obtener tipos de nodos en base a su identificador
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
5c1285590922ac7401efef00
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de un tipo de nodo.
Body
Media type: application/json
Type: object
Example:
{
"_id":"5c1b7be93af0b82c09196001",
"key":"bitcoin28",
"displayName":"Bitcoin",
"owner":"PLATFORM",
"color":"blue",
"tags":[
"moneda"
],
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_bitcoin28",
"title":"Bitcoin",
"type":"object"
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener tipos de nodos en base a su tipo
get /strucs/instances/{instanceId}/nodeTypes/byKey/{key}
Endpoint para obtener tipos de nodos en base a su tipo
URI Parameters
- instanceId: required(string)
- key: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de un tipo de nodo.
Body
Media type: application/json
Type: object
Example:
{
"_id":"5c1b7be93af0b82c09196001",
"key":"bitcoin28",
"displayName":"Bitcoin",
"owner":"PLATFORM",
"color":"blue",
"tags":[
"moneda"
],
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_bitcoin28",
"title":"Bitcoin",
"type":"object"
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener tipos de nodos en base a varios tipos
get /strucs/instances/{instanceId}/nodeTypes/byMultipleKeys
Endpoint para obtener tipos de nodos en base a varios tipos
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de un tipo de nodo.
Body
Media type: application/json
Type: array
Example:
[
{
"_id":"5c1b7b3f3af0b82c09195ffd",
"key":"bitcoin27",
"displayName":"Bitcoin",
"owner":"PLATFORM",
"color":"red",
"tags":[
"moneda"
],
"shapeId":"5c1b68e37e59da26c87e0496"
},
{
"_id":"5c1b7be93af0b82c09196001",
"key":"bitcoin28",
"displayName":"Bitcoin",
"owner":"PLATFORM",
"color":"blue",
"tags":[
"moneda"
],
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_bitcoin28",
"title":"Bitcoin",
"type":"object"
}
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener tipos de relaciones en base a su identificador
get /strucs/instances/{instanceId}/edgeTypes/{id}
Endpoint para obtener tipos de relaciones en base a su identificador
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
5c12862e0922ac7401efef01
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de un tipo de relación.
Body
Media type: application/json
Type: object
Example:
{
"_id":"5c1b7bd43af0b82c09196000",
"key":"gather_in3",
"displayName":"Reunidos",
"owner":"PLATFORM",
"color":"red",
"tags":[
"joy"
],
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_gather_in3",
"title":"Reunidos",
"type":"object"
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener tipos de relaciones en base a su tipo
get /strucs/instances/{instanceId}/edgeTypes/byKey/{key}
Endpoint para obtener tipos de relaciones en base a su tipo
URI Parameters
- instanceId: required(string)
- key: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la información de un tipo de relación.
Body
Media type: application/json
Type: object
Example:
{
"_id":"5c1b7bd43af0b82c09196000",
"key":"gather_in3",
"displayName":"Reunidos",
"owner":"PLATFORM",
"color":"red",
"tags":[
"joy"
],
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_gather_in3",
"title":"Reunidos",
"type":"object"
}
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener tipos de relaciones en base a varios tipos
get /strucs/instances/{instanceId}/edgeTypes/byMultipleKeys
Endpoint para obtener tipos de relaciones en base a varios tipos
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve los tipos de relaciones.
Body
Media type: application/json
Type: array
Example:
[
{
"_id":"5c1b7baf3af0b82c09195fff",
"key":"gather_in2",
"displayName":"Reunidos",
"owner":"PLATFORM",
"color":"green",
"tags":[
"joy"
],
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_gather_in2",
"title":"Reunidos",
"type":"object"
}
},
{
"_id":"5c1b7bd43af0b82c09196000",
"key":"gather_in3",
"displayName":"Reunidos",
"owner":"PLATFORM",
"color":"red",
"tags":[
"joy"
],
"shapeId":"5c1b68e37e59da26c87e0496",
"validationSchema":{
"additionalProperties":true,
"properties":{
"id":{
"displayName":"id",
"visible":false,
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f\u200c]{4}-[0-9a-f]{12}$",
"locked":true
}
},
"id":"5c1b7b313af0b82c09195ffc_gather_in3",
"title":"Reunidos",
"type":"object"
}
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener figuras
Endpoint para insertar figuras
get /strucs/instances/{instanceId}/shapes
Endpoint para obtener figuras
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: array
Example:
[
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.204Z",
"_id":"5c126215aef4205b08877fdb",
"content":"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M12 12c2.21 0 4-1.79 4-4s-1.79-4-4-4-4 1.79-4 4 1.79 4 4 4zm0 2c-2.67 0-8 1.34-8 4v2h16v-2c0-2.66-5.33-4-8-4z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.209Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.316Z",
"_id":"5c126215aef4205b08877fdf",
"content":"<svg viewBox=\"0 0 24 24\"> <path d=\"M3.1,21.7v-0.3H0.8v1.4c0,0.4,0.3,0.7,0.7,0.7h4.9c0.4,0,0.7-0.3,0.7-0.7v-1.4H4.5v0.3H3.1z M6.6,18.6H5.2v-0.7 l-0.7-0.6H3.1l-0.6,0.6v0.7H1.1c-0.4,0-0.7,0.3-0.7,0.7v1.1c0,0.4,0.3,0.7,0.7,0.7h2.1v-0.7h1.4v0.7h2.1c0.4,0,0.7-0.3,0.7-0.7v-1.1 C7.2,18.9,6.9,18.6,6.6,18.6z M4.5,18.6H3.1v-0.7h1.4C4.5,17.9,4.5,18.6,4.5,18.6z M19.5,21.7v-0.3H17v1.4c0,0.4,0.3,0.7,0.7,0.7 h4.7c0.4,0,0.7-0.3,0.7-0.7v-1.4h-2.4v0.3H19.5z M22.8,18.6h-1.4v-0.7l-0.6-0.6h-1.4L18.7,18v0.7h-1.4c-0.4,0-0.7,0.3-0.7,0.7v1.1 c0,0.4,0.3,0.7,0.7,0.7h2.1v-0.7h1.4v0.7h2.1c0.4,0,0.7-0.3,0.7-0.7v-1.1C23.6,18.9,23.3,18.6,22.8,18.6z M20.8,18.6h-1.4v-0.7h1.4 V18.6z M3.1,4.9V4.6H0.8V6c0,0.4,0.3,0.7,0.7,0.7h4.9c0.4,0,0.7-0.3,0.7-0.7V4.6H4.5v0.3H3.1z M6.6,1.8H5.2V1.1L4.5,0.5H3.1L2.5,1.1 v0.7H1.1c-0.4,0-0.7,0.3-0.7,0.6v1.1c0,0.4,0.3,0.7,0.7,0.7h2.1V3.5h1.4v0.7h2.1c0.4,0,0.7-0.3,0.7-0.7V2.5C7.2,2.2,6.9,1.8,6.6,1.8 z M4.5,1.8H3.1V1.1h1.4C4.5,1.1,4.5,1.8,4.5,1.8z M19.5,4.9V4.6H17V6c0,0.4,0.3,0.7,0.7,0.7h4.7c0.4,0,0.7-0.3,0.7-0.7V4.6h-2.4v0.3 H19.5z M22.8,1.8h-1.4V1.1l-0.7-0.7h-1.4l-0.7,0.7v0.7h-1.4c-0.4,0-0.7,0.3-0.7,0.7v1.1c0,0.4,0.3,0.7,0.7,0.7h2.1V3.5h1.4v0.7h2.1 c0.4,0,0.7-0.3,0.7-0.7V2.5C23.6,2.2,23.3,1.8,22.8,1.8z M20.8,1.8h-1.4V1.1h1.4V1.8z M9.1,13.4H7l-0.4,1.2H5l2.3-6.4h1.4l2.3,6.4 H9.5L9.1,13.4z M7.4,12.2h1.4L8.1,10L7.4,12.2z M13.6,8.2l1.4,4.4l1.4-4.4h2v6.4h-1.5v-1.5l0.1-3l-1.5,4.5h-1L13,10.1l0.1,3v1.5 h-1.5V8.2H13.6z M15.6,1.7V0.5C14.4,0.2,13.2,0,12,0c-1.4,0-2.6,0.2-3.8,0.6v1.3c1.2-0.4,2.4-0.7,3.8-0.7 C13.2,1.1,14.5,1.3,15.6,1.7z M1,8.1C0.3,9.5,0,11.2,0,13c0,1.1,0.1,2,0.4,3c0,0.1,0,0.1,0,0.2h1.3c0-0.1,0-0.1,0-0.2 c-0.3-0.9-0.5-1.9-0.5-3c0-1.8,0.4-3.5,1.3-5H1z M22.3,16.2h1.3c0-0.1,0-0.1,0-0.2c0.2-0.9,0.4-2,0.4-3c0-1.8-0.4-3.5-1.1-5h-1.4 c0.7,1.5,1.3,3.2,1.3,5c0,1.1-0.1,2-0.4,3C22.4,16.1,22.3,16.2,22.3,16.2z M8.2,22.1v1.3C9.3,23.8,10.6,24,12,24 c1.3,0,2.4-0.2,3.6-0.5v-1.3c-1.2,0.4-2.3,0.6-3.6,0.6C10.6,22.8,9.3,22.5,8.2,22.1z\"/> </svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.317Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.316Z",
"_id":"5c126215aef4205b08877fde",
"content":"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zM8 17.5c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5zM9.5 8c0-1.38 1.12-2.5 2.5-2.5s2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5S9.5 9.38 9.5 8zm6.5 9.5c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.317Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.205Z",
"_id":"5c126215aef4205b08877fdc",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M16 11c1.66 0 2.99-1.34 2.99-3S17.66 5 16 5c-1.66 0-3 1.34-3 3s1.34 3 3 3zm-8 0c1.66 0 2.99-1.34 2.99-3S9.66 5 8 5C6.34 5 5 6.34 5 8s1.34 3 3 3zm0 2c-2.33 0-7 1.17-7 3.5V19h14v-2.5c0-2.33-4.67-3.5-7-3.5zm8 0c-.29 0-.62.02-.97.05 1.16.84 1.97 1.97 1.97 3.45V19h6v-2.5c0-2.33-4.67-3.5-7-3.5z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.209Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.315Z",
"_id":"5c126215aef4205b08877fdd",
"content":"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M12 2C8.13 2 5 5.13 5 9c0 5.25 7 13 7 13s7-7.75 7-13c0-3.87-3.13-7-7-7zm0 9.5c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.317Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.316Z",
"_id":"5c126215aef4205b08877fe0",
"content":"<svg viewBox=\"0 0 24 24\"> <path d=\"M6.7,14.6V8.3h2c0.6,0,1.1,0.1,1.5,0.4c0.4,0.3,0.8,0.6,1,1.1c0.3,0.5,0.4,1,0.4,1.6v0.3c0,0.6-0.1,1.1-0.4,1.6 c-0.2,0.5-0.6,0.8-1,1.1c-0.4,0.3-0.9,0.4-1.5,0.4H6.7z M8.2,9.4v4h0.5c0.4,0,0.8-0.2,1-0.5c0.2-0.3,0.4-0.8,0.4-1.4v-0.3 c0-0.6-0.1-1.1-0.4-1.4c-0.2-0.3-0.6-0.5-1-0.5H8.2z M17.6,12.5c0,0.4-0.1,0.8-0.4,1.2c-0.2,0.3-0.5,0.6-0.9,0.8s-0.8,0.3-1.3,0.3 c-0.8,0-1.5-0.3-2-0.8c-0.5-0.5-0.7-1.3-0.7-2.3v-0.3c0-0.6,0.1-1.2,0.3-1.6c0.2-0.5,0.5-0.8,0.9-1.1s0.9-0.4,1.4-0.4 c0.8,0,1.4,0.2,1.9,0.6c0.5,0.4,0.7,1,0.8,1.7h-1.5c0-0.4-0.1-0.7-0.3-0.8s-0.5-0.3-0.8-0.3c-0.4,0-0.7,0.1-0.8,0.4 s-0.3,0.7-0.3,1.4v0.4c0,0.7,0.1,1.2,0.3,1.4s0.5,0.4,0.9,0.4c0.4,0,0.6-0.1,0.8-0.2c0.2-0.2,0.3-0.4,0.3-0.8H17.6z M15.6,1.8V0.5 C14.4,0.2,13.3,0,12,0c-1.4,0-2.6,0.2-3.8,0.6v1.3c1.2-0.4,2.4-0.7,3.8-0.7C13.3,1.2,14.5,1.4,15.6,1.8z M1.1,8.1 C0.3,9.6,0,11.3,0,13.1c0,1.1,0.1,2,0.4,2.9c0,0.1,0,0.1,0,0.2h1.3c0-0.1,0-0.1,0-0.2c-0.3-0.9-0.5-1.9-0.5-2.9 c0-1.8,0.4-3.5,1.3-4.9H1.1z M22.3,16.2h1.3c0-0.1,0-0.1,0-0.2c0.2-0.9,0.4-2,0.4-2.9c0-1.8-0.4-3.5-1.1-4.9h-1.4 c0.7,1.5,1.3,3.2,1.3,4.9c0,1.1-0.1,2-0.4,2.9C22.4,16.1,22.3,16.2,22.3,16.2z M8.2,22.1v1.3C9.4,23.8,10.6,24,12,24 c1.3,0,2.4-0.2,3.6-0.5v-1.3c-1.2,0.4-2.3,0.6-3.6,0.6C10.6,22.8,9.4,22.5,8.2,22.1z M4.5,20.2v-1.9l-0.9-0.9l-0.9,0.9v0.6h-2v4.5 h5.8v-3.3C6.4,20.2,4.5,20.2,4.5,20.2z M1.9,22.8H1.3v-0.6h0.6V22.8z M1.9,21.6H1.3v-0.6h0.6V21.6z M1.9,20.2H1.3v-0.6h0.6V20.2z M3.9,22.8H3.3v-0.6h0.6V22.8z M3.9,21.6H3.3v-0.6h0.6V21.6z M3.9,20.2H3.3v-0.6h0.6V20.2z M3.9,18.9H3.3v-0.6h0.6V18.9z M5.8,22.8 H5.2v-0.6h0.6V22.8z M5.8,21.6H5.2v-0.6h0.6V21.6z M21.2,20.2v-1.9l-0.9-0.9l-0.9,0.9v0.6h-1.9v4.5h5.8v-3.3 C23.2,20.2,21.2,20.2,21.2,20.2z M18.6,22.8H18v-0.6h0.6V22.8z M18.6,21.6H18v-0.6h0.6V21.6z M18.6,20.2H18v-0.6h0.6V20.2z M20.5,22.8h-0.6v-0.6h0.6V22.8z M20.5,21.6h-0.6v-0.6h0.6V21.6z M20.5,20.2h-0.6v-0.6h0.6V20.2z M20.5,18.9h-0.6v-0.6h0.6V18.9z M22.5,22.8h-0.6v-0.6h0.6V22.8z M22.5,21.6h-0.6v-0.6h0.6V21.6z M4.5,3.4V1.5L3.6,0.5L2.6,1.5v0.6h-2v4.5h5.8V3.4H4.5z M1.9,6H1.3 V5.4h0.6V6z M1.9,4.7H1.3V4.1h0.6V4.7z M1.9,3.4H1.3V2.7h0.6V3.4z M3.9,6H3.3V5.4h0.6V6z M3.9,4.7H3.3V4.1h0.6V4.7z M3.9,3.4H3.3 V2.7h0.6V3.4z M3.9,2.1H3.3V1.5h0.6V2.1z M5.8,6H5.2V5.4h0.6V6z M5.8,4.7H5.2V4.1h0.6V4.7z M21.2,3.4V1.5l-0.9-0.9l-0.9,0.9v0.6 h-1.9v4.5h5.8V3.4H21.2z M18.6,6H18V5.4h0.6V6z M18.6,4.7H18V4.1h0.6V4.7z M18.6,3.4H18V2.7h0.6V3.4z M20.5,6h-0.6V5.4h0.6V6z M20.5,4.7h-0.6V4.1h0.6V4.7z M20.5,3.4h-0.6V2.7h0.6V3.4z M20.5,2.1h-0.6V1.5h0.6V2.1z M22.5,6h-0.6V5.4h0.6V6z M22.5,4.7h-0.6V4.1 h0.6V4.7z\"/> </svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.317Z"
},
{
"type":"EDGE",
"createdAt":"2018-12-13T13:43:49.859Z",
"_id":"5c126215aef4205b08877fe4",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M18 8h-1V6c0-2.76-2.24-5-5-5S7 3.24 7 6v2H6c-1.1 0-2 .9-2 2v10c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V10c0-1.1-.9-2-2-2zm-6 9c-1.1 0-2-.9-2-2s.9-2 2-2 2 .9 2 2-.9 2-2 2zm3.1-9H8.9V6c0-1.71 1.39-3.1 3.1-3.1 1.71 0 3.1 1.39 3.1 3.1v2z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.860Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.316Z",
"_id":"5c126215aef4205b08877fe1",
"content":"<svg viewBox=\"0 0 24 24\"> <path d=\"M21.4,4.3h-0.6V3.7h0.6V4.3z M21.4,5h-0.6v0.6h0.6V5z M19.4,6.9h-3.1V4.3V3.2V1.1h3.2v1.3h3.2v4.5h-2.1H19.4z M19.6,6.2h0.6 h1.9h0.1V3h-2.6v0.7h0.6v0.6h-0.6V5h0.6v0.6h-0.5h-0.1V6.2z M17.6,5.6H17v0.6h0.6V5.6z M17.6,4.3H17v0.4V5h0.4h0.2V4.3z M17.6,3H17 v0.5v0.1h0.3h0.3V3z M17.6,1.8H17v0.6h0.6V1.8z M18.9,5.6h-0.6v0.6h0.6V5.6z M18.9,4.3h-0.6V5h0.6V4.8V4.3z M18.9,3h-0.6v0.6h0.6V3z M18.9,1.8h-0.6v0.6h0.6V1.8z M21.4,19.7h-0.6v0.6h0.6V19.7z M21.4,21h-0.6v0.6h0.6V21z M20.9,18.3h1.9v4.5h-6.4v-0.4v-1.1v-4.2h3.2 v1.3h0.1v-0.1H20.9z M17.6,21.7L17,21.6v0.5v0.1h0.6V21.7z M17.6,20.4H17V21h0.6v-0.4V20.4z M17.6,19H17v0.6h0.6V19z M17.6,17.8H17 v0.6h0.6V17.8z M18.9,21.6h-0.6v0.6h0.6V21.6z M18.9,20.4h-0.6V21h0.4l0.2-0.1V20.4z M18.9,19h-0.6h-0.1v0.6h0.4h0.3v-0.3V19z M18.9,17.8h-0.6v0.6h0.6V17.8z M22.1,19h-1.6h-0.9v0.8H20h0.1v0.6h-0.6V21h0.6v0.6h-0.6v0.6h2.6V19z M6.4,21.4V21H5.8H5.7v0.6h0.7 V21.4z M6.4,20.1v-0.4H5.9H5.7v0.6h0.7V20.1z M4.8,18.4h2.9v2.7v1.1v0.7H1.3v-5.8H3h1.1h0.4v0.7v0.6H4.8z M2.5,21.6H1.9v0.6h0.6 V21.6z M2.5,20.4H1.9V21h0.6V20.4z M2.5,19H1.9v0.7h0.6V19z M2.5,17.8H1.9v0.6h0.6V17.8z M3.8,21.6H3.2v0.6h0.6V21.6z M3.8,20.4H3.2 V21h0.6V20.4z M3.8,19H3.2v0.7h0.6V19z M3.8,17.8H3.3H3.2v0.6h0.4h0.2V17.8z M5.3,19H4.5v0.7v0.1h0.6v0.6H4.5V21h0.6v0.6H4.5v0.6H7 v-0.4v-1.2V19H5.3z M11.5,9.7c0.3,0.5,0.4,1,0.4,1.5v0.3c0,0.6-0.1,1.1-0.3,1.5c-0.2,0.4-0.6,0.8-1,1c-0.4,0.3-0.9,0.4-1.4,0.4h-2 v-6h2c0.5,0,1,0.2,1.4,0.4C11,9.1,11.3,9.4,11.5,9.7z M10.4,11.3c0-0.6-0.1-1-0.3-1.3c-0.2-0.3-0.6-0.4-1-0.4H8.6v3.7h0.5 c0.5,0,0.8-0.1,1-0.4c0.2-0.3,0.3-0.7,0.3-1.3V11.3z M12.4,14.5h4.7v-1.1h-2.9L17,9.2V8.5h-4.6v1.1h2.9l-2.9,4.1V14.5z M6.4,5.6V5.5 V5H5.7v0.6h0.5H6.4z M6.4,4.3L6.4,4.3V3.7H5.7v0.6h0.5H6.4z M4.5,2.4h3.2v1v1.2v2.3H5.1H3.9H1.3V1.1h3.2V2.4z M2.5,5.6H1.9v0.6h0.6 V5.6z M2.5,4.3H1.9V5h0.6V4.3z M2.5,3H1.9v0.7h0.6V3z M2.5,1.8H1.9v0.6h0.6V1.8z M3.8,5.6H3.2v0.6h0.6V5.6z M3.8,4.3H3.2V5h0.6V4.3z M3.8,3H3.2v0.7h0.6V3z M3.8,1.8H3.2v0.6h0.6V1.8z M4.5,3v0.7h0.6v0.6H4.5V5h0.7v0.3v0.3H4.9H4.5V6v0.3h1.1H7V5V3.7V3H4.5z M12,0.6 c-1.3,0-2.5,0.2-3.6,0.6v1.2C9.5,2,10.7,1.7,12,1.7c1.2,0,2.4,0.2,3.4,0.6V1.1C14.3,0.8,13.2,0.6,12,0.6z M2.2,16c0-0.1,0-0.1,0-0.2 C1.9,14.9,1.7,14,1.7,13c0-1.7,0.4-3.3,1.2-4.7H1.6c-0.7,1.4-1,3-1,4.7c0,1,0.1,1.9,0.4,2.8c0,0.1,0,0.1,0,0.2H2.2z M22.4,8.3h-1.3 c0.7,1.4,1.2,3,1.2,4.7c0,1-0.1,1.9-0.4,2.8c0,0.1-0.1,0.2-0.1,0.2H23c0-0.1,0-0.1,0-0.2c0.2-0.9,0.4-1.9,0.4-2.8 C23.4,11.3,23,9.7,22.4,8.3z M8.4,21.6v1.2c1.1,0.4,2.3,0.6,3.6,0.6c1.2,0,2.3-0.2,3.4-0.5v-1.2c-1.1,0.4-2.2,0.6-3.4,0.6 C10.7,22.3,9.5,22,8.4,21.6z\"/> </svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.317Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.317Z",
"_id":"5c126215aef4205b08877fe3",
"content":"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M12 7V3H2v18h20V7H12zM6 19H4v-2h2v2zm0-4H4v-2h2v2zm0-4H4V9h2v2zm0-4H4V5h2v2zm4 12H8v-2h2v2zm0-4H8v-2h2v2zm0-4H8V9h2v2zm0-4H8V5h2v2zm10 12h-8v-2h2v-2h-2v-2h2v-2h-2V9h8v10zm-2-8h-2v2h2v-2zm0 4h-2v2h2v-2z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.317Z"
},
{
"type":"NODE",
"createdAt":"2018-12-13T13:43:49.316Z",
"_id":"5c126215aef4205b08877fe2",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M15 11V5l-3-3-3 3v2H3v14h18V11h-6zm-8 8H5v-2h2v2zm0-4H5v-2h2v2zm0-4H5V9h2v2zm6 8h-2v-2h2v2zm0-4h-2v-2h2v2zm0-4h-2V9h2v2zm0-4h-2V5h2v2zm6 12h-2v-2h2v2zm0-4h-2v-2h2v2z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:49.317Z"
},
{
"type":"EDGE",
"createdAt":"2018-12-13T13:43:50.360Z",
"_id":"5c126216aef4205b08877fea",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z\"/> </svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:50.360Z"
},
{
"type":"EDGE",
"createdAt":"2018-12-13T13:43:50.360Z",
"_id":"5c126216aef4205b08877fe9",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M22 12l-4-4v3H3v2h15v3z\"/></svg>",
"author":{
"type":"SYSTEM"
},
"updatedAt":"2018-12-13T13:43:50.360Z"
}
]
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
post /strucs/instances/{instanceId}/shapes
Endpoint para insertar figuras
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"name":"Prueba",
"type":"NODE",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M12 2C8.13 2 5 5.13 5 9c0 5.25 7 13 7 13s7-7.75 7-13c0-3.87-3.13-7-7-7zm0 9.5c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5z\"/> </svg>"
}
HTTP status code 200
Devuelve la información de la figura insertada
Body
Media type: application/json
Type: object
Example:
{
"type":"NODE",
"_id":"5c12652461494d5b1ee0345f",
"name":"Prueba",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M12 2C8.13 2 5 5.13 5 9c0 5.25 7 13 7 13s7-7.75 7-13c0-3.87-3.13-7-7-7zm0 9.5c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5z\"/> </svg>",
"author":{
"type":"USER",
"instanceId":"ed51cc4d-56b9-45ca-8076-315087150ec0",
"accountId":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"createdAt":"2018-12-13T13:56:52.581Z",
"updatedAt":"2018-12-13T13:56:52.583Z"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Endpoint para obtener una figura
Endpoint para editar una figura
Endpoint para borrar una figura
get /strucs/instances/{instanceId}/shapes/{id}
Endpoint para obtener una figura
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
5c12652461494d5b1ee0345f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"type":"NODE",
"createdAt":"2018-12-13T13:56:52.581Z",
"_id":"5c12652461494d5b1ee0345f",
"name":"Prueba",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M12 2C8.13 2 5 5.13 5 9c0 5.25 7 13 7 13s7-7.75 7-13c0-3.87-3.13-7-7-7zm0 9.5c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5z\"/> </svg>",
"author":{
"type":"USER",
"instanceId":"ed51cc4d-56b9-45ca-8076-315087150ec0",
"accountId":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"updatedAt":"2018-12-13T13:56:52.583Z"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
put /strucs/instances/{instanceId}/shapes/{id}
Endpoint para editar una figura
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
5c12652461494d5b1ee0345f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Example:
{
"name":"Batman"
}
HTTP status code 200
Devuelve la información de la figura editar
Body
Media type: application/json
Type: object
Example:
{
"type":"NODE",
"_id":"5c12652461494d5b1ee0345f",
"name":"Prueba",
"content":"<svg viewBox=\"0 0 24 24\"><path d=\"M12 2C8.13 2 5 5.13 5 9c0 5.25 7 13 7 13s7-7.75 7-13c0-3.87-3.13-7-7-7zm0 9.5c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5z\"/> </svg>",
"author":{
"type":"USER",
"instanceId":"ed51cc4d-56b9-45ca-8076-315087150ec0",
"accountId":"c795f588-e8d0-47df-8d92-c85f3e8d23c1"
},
"createdAt":"2018-12-13T13:56:52.581Z",
"updatedAt":"2018-12-13T13:56:52.583Z"
}
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
delete /strucs/instances/{instanceId}/shapes/{id}
Endpoint para borrar una figura
URI Parameters
- instanceId: required(string)
- id: required(string)
Example:
5c12652461494d5b1ee0345f
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
Devuelve el resultado del borrado
HTTP status code 400
Solicitud incorrecta.
Body
Media type: application/json
Type: object
Example:
SchemaValidationBadRequestError:
{
"status":400,
"statusText":"PlatformError - Bad Request",
"errors":[
{
"type":"SchemaValidationBadRequestError",
"data":"(Objeto de estructura desconocida)",
"description":"(Objeto de estructura desconocida)"
}
]
}
HTTP status code 403
Acción no permitida.
Body
Media type: application/json
Type: object
Examples:
NodeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"NodeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to modify specified nodes: ??????????."
}
]
}
EdgeTypeForbiddenError:
{
"status":403,
"statusText":"PlatformError - Forbidden",
"errors":[
{
"type":"EdgeTypeForbiddenError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Relationship type (??????????) not permitted"
}
]
}
HTTP status code 404
Recurso no encontrado.
Body
Media type: application/json
Type: object
Examples:
EdgeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"EdgeType ?????????? not found"
}
]
}
NodeTypeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeType ?????????? not found"
}
]
}
NodeTypesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeTypesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"NodeTypes ?????????? not found"
}
]
}
CatalogNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"CatalogNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog ?????????? not found"
}
]
}
ShapeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ShapeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape ?????????? not found"
}
]
}
ClientOfProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ClientOfProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ClientOfProductInstance ?????????? not found"
}
]
}
EdgeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? not found"
}
]
}
EdgesNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"EdgesNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edges ?????????? not found"
}
]
}
NodeNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"NodeNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? not found"
}
]
}
UserNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"UserNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"User ?????????? not found"
}
]
}
FunctionalityNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"FunctionalityNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Functionality ?????????? not found"
}
]
}
ProductInstanceNotFoundError:
{
"status":404,
"statusText":"PlatformError - Not Found",
"errors":[
{
"type":"ProductInstanceNotFoundError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? not found"
}
]
}
HTTP status code 422
Acción no procesable.
Body
Media type: application/json
Type: object
Examples:
ShapeReferencesUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeReferencesUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"References found for shape ??????????."
}
]
}
CatalogExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"CatalogExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Catalog with ?????????? already exists"
}
]
}
ShapeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"ShapeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Shape with ?????????? already exists"
}
]
}
NodeTypeUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type ??????????) not permitted"
}
]
}
EdgeEndsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeEndsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"You are not authorized to create or modify relationships between the specified nodes: ??????????}."
}
]
}
EdgeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge ?????????? already exists"
}
]
}
NodeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node ?????????? already exists"
}
]
}
NodeOrProductInstanceUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeOrProductInstanceUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node or ProductInstance ?????????? are unprocessable"
}
]
}
NodeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"NodeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Node type with ?????????? already exists"
}
]
}
EdgeTypeExistsUnprocessableEntityError:
{
"status":422,
"statusText":"PlatformError - Unprocessable Entity",
"errors":[
{
"type":"EdgeTypeExistsUnprocessableEntityError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"Edge type with ?????????? already exists"
}
]
}
HTTP status code 423
Recurso bloqueado.
Body
Media type: application/json
Type: object
Example:
ProductInstanceLockedError:
{
"status":423,
"statusText":"PlatformError - Locked",
"errors":[
{
"type":"ProductInstanceLockedError",
"data":"b173f20b-8e60-49fd-928b-d7f91552b39e",
"description":"ProductInstance ?????????? is locked"
}
]
}
HTTP status code 500
Cualquier otro posible error.
Body
Media type: application/json
Type: object
Example:
InternalServerError:
{
"status":500,
"statusText":"PlatformError - InternalServerError",
"errors":[
{
"type":"InternalServerError",
"data":"(Objeto de estructura desconocida)",
"description":"InternalServerError"
}
]
}
Subscriptions
Operaciones de la API de suscripciones
Crea un nueva subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.
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.
post /subscriptions
Crea un nueva subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "Subscripción 1",
"owner": "d51fac32-f6e6-42dd-9e21-70e6df69dd41",
"description": "Mi subscripción"
}
HTTP status code 201
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"id": "f675e83f-6e77-4201-8919-ac8d1b8f01e7"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
get /subscriptions
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.
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- owner: (string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Obtiene el cliente del que es propietario la cuenta.
Example:
c6236916-4a7c-4ede-afa4-faf07ceec6c3
- admin: (string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Obtiene los clientes del que es administrador la cuenta.
Example:
c6236916-4a7c-4ede-afa4-faf07ceec6c3
- filter: (string)
Filtra los clientes que contienen en el nombre lo pasado como parámetro.
Example:
amaem
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Examples:
Solo un resultado:
{
"id": "d8ed0705-4e09-484f-b7fc-fecb18302955",
"name": "AMAEM",
"description": "AMAEM",
"owner": "d51fac32-f6e6-42dd-9e21-70e6df69dd41"
}
Multiples resultados:
[
{
"id": "d8ed0705-4e09-484f-b7fc-fecb18302955",
"name": "AMAEM",
"description": "AMAEM",
"owner": "d51fac32-f6e6-42dd-9e21-70e6df69dd41"
},
{
"id": "f9b0dba3-1a76-4d11-a1fb-da0527b07a07",
"name": "Borrar",
"description": null,
"owner": "7b01e0d4-7d88-46a5-a3aa-15e870e0115c"
},
{
"id": "266c004c-74ee-44d1-ac72-ceb51a3d58b2",
"name": "GotLicense ",
"description": "Licencia de Got para Parla",
"owner": null
}
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtiene una subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.
Actualiza la información de una subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.
get /subscriptions/{subscriptionId}
Obtiene una subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"id": "d8ed0705-4e09-484f-b7fc-fecb18302955",
"name": "AMAEM",
"description": "AMAEM",
"owner": "d51fac32-f6e6-42dd-9e21-70e6df69dd41"
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
put /subscriptions/{subscriptionId}
Actualiza la información de una subscripción. Para realizar la acción necesitas ser Administrador de la plataforma.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "AMAEM",
"description": "AMAEM",
"owner": "d51fac32-f6e6-42dd-9e21-70e6df69dd41"
}
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"id": "d8ed0705-4e09-484f-b7fc-fecb18302955",
"name": "AMAEM",
"description": "AMAEM",
"owner": "d51fac32-f6e6-42dd-9e21-70e6df69dd41"
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Consulta si el usuario es o no administrador de la suscripción.
get /subscriptions/{subscriptionId}/isSubscriptionAdmin
Consulta si el usuario es o no administrador de la suscripción.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"isAdmin": true
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
(DEPRECADO - Usar /accounts/available) Busca entre las cuentas disponibles para añadir a una suscripción.
get /subscriptions/{subscriptionId}/available-accounts
(DEPRECADO - Usar /accounts/available) Busca entre las cuentas disponibles para añadir a una suscripción.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: required(string)
filtra por nombre y email
Example:
accounts?filter=email2@test.com
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"items": [
{
"id": "3e32837a-a420-4c2f-82b3-839c25d6a798",
"email": "test@test.es",
"type": "User",
"name": "Prueba",
"surname": "De Cuenta",
"fullname": "Prueba De Cuenta",
"registerat": "2017-01-01T00:00:00Z",
"fromDU": false,
"inviteAvailable": false
}
],
"itemsCount": 1
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Busca entre las cuentas de la suscripción.
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.
get /subscriptions/{subscriptionId}/accounts
Busca entre las cuentas de la suscripción.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: (string)
filtra por nombre y email
Example:
accounts?filter=email2@test.com
- offset: (integer)
Número del elemento a partir del cual vamos a obtener resultados.
Example:
/accounts?offset=0
- limit: (integer)
Especifica el número máximo de elementos que va a devolver la petición. Máximo 100.
Example:
/accounts?limit=15
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"data": [
{
"id": "64b2f704-d97c-4045-9531-f92d71c2b69f",
"email": "hackeando_182341@account.api",
"registerat": 1526456962897,
"fullName": "HACKEANDO_182341",
"isSubscriptionAdmin": false,
"isDigitalEntity": false,
"avatar": null
},
{
"id": "01c044e1-f1f3-4c98-a408-63c837e333c1",
"email": "hackeando_182341234@account.api",
"registerat": 1526459506999,
"fullName": "HACKEANDO_182341234",
"isSubscriptionAdmin": false,
"isDigitalEntity": true,
"avatar": null
}
],
"pagination": {
"offset": 2,
"limit": 4,
"totalItems": 7,
"previous": {
"offset": 0
},
"next": {
"offset": 2
}
}
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /subscriptions/{subscriptionId}/accounts
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.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- email: (string)
email de la cuenta
- name: (string)
Nombre
- surname: (string)
Apellido
- language: (string)
Idioma del usuario
- isAdmin: required(boolean)
Especifica si la cuenta va a ser administradora de la suscripción
- fromDU: required(boolean)
Especifica si es una cuenta delegada
- isDigitalEntity: (boolean)
Especifica si la cuenta es una identidad digital
- fromSubscriptionId: (string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Indica el Id de la suscripción a la que pertenece la identidad digital
Examples:
exist_account:
{
"email": "ewoksAreNotThatBad@sw.facts",
"isAdmin": false,
"fromDU": false
}
delegate_account:
{
"email": "JohnDoe@delegated.com",
"isAdmin": false,
"fromDU": true,
"name": "John",
"surname": "Doe",
"language": "en-US"
}
exist_digital_entity:
{
"name": "myDigitalEntity",
"isAdmin": true,
"fromDU": false,
"isDigitalEntity": true,
"fromSubscriptionId": "6a854239-2c41-4901-8a76-722e740dc8aa"
}
new_digital_entity:
{
"name": "myDigitalEntity",
"isAdmin": true,
"fromDU": false,
"isDigitalEntity": true,
"language": "en-US"
}
HTTP status code 201
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Examples:
exist_account, delegate_account, exist_digital_entity:
{
"apiVersion": "1.2.1",
"data": {
"self": {
"isAdmin": false,
"accountId": "f675e83f-6e77-4201-8919-ac8d1b8f01e7"
}
}
}
new_digital_entity:
{
"apiVersion": "1.2.1",
"data": {
"self": {
"isAdmin": false,
"accountId": "008d34cf-f73c-48cb-a00a-93ce14e18f68",
"email": "Postman-af10e989-a832-4075-8274-69cee672dd6e-deleteme@97f8c763-3b04-4fdd-a51e-0da3374f7ce7",
"name": "Postman-af10e989-a832-4075-8274-69cee672dd6e-deleteme",
"authenticationMethod": {
"type": "apikey",
"apiKey2": "MDA4ZDM0Y2YtZjczYy00OGNiLWEwMGEtOTNjZTE0ZTE4ZjY4Oi1UTUM9TDEwMn4="
},
"ownedBy": true
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Elimina una cuenta de una suscripción.
Permite obtener dado su id los datos de una cuenta.
delete /subscriptions/{subscriptionId}/accounts/{accountId}
Elimina una cuenta de una suscripción.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- accountId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
La petición ha sido correcta.
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
get /subscriptions/{subscriptionId}/accounts/{accountId}
Permite obtener dado su id los datos de una cuenta.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- accountId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve los datos de una cuenta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"id": "d51fac32-f6e6-42dd-9e21-70e6df69dd41",
"name": "Admin",
"surname": "Pérez",
"language": "es-ES",
"email": "admin@admin.com",
"contactemail": "admin@admin.com",
"type": "User",
"isAdmin": true,
"isDeveloper": true
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": "ins_add_wrong_arg",
"errors": []
}
}
HTTP status code 403
Error de autentificación.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "AUTH_EXCEPTION",
"message": "Invalid xxx",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "UNKNOWN_ERROR",
"message": "Unknown Error",
"errors": []
}
}
Cambia los privilegios de una cuenta de usuario pudiendo pasar de usuario a administrador y viceversa.
put /subscriptions/{subscriptionId}/accounts/{accountId}/changePrivileges
Cambia los privilegios de una cuenta de usuario pudiendo pasar de usuario a administrador y viceversa.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
- accountId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"isAdmin": true
}
HTTP status code 204
La petición ha sido correcta.
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 409
No se puede convertir a usuario el propietario de la suscripción
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Búsqueda de cuentas disponibles para añadir a una suscripción
get /subscriptions/{subscriptionId}/accounts/available
Búsqueda de cuentas disponibles para añadir a una suscripción
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Token de la cuenta realizando la operación.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: required(string)
Email o nombre de cuenta por el cual filtrar
Example:
test@mail.com
- isDigitalEntity: (boolean - default: false)
Especifica si se quiere consultar Identidades Digitales
- fromSubscriptionId: (string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción a la que pertenece una Identidad Digital
Example:
e564824a-14ec-4087-8e0b-e74ade6e21cf
- offset: (integer - default: 0 - minimum: 0)
Página de resultados
- limit: (integer - default: 5 - minimum: 1 - maximum: 100)
Límite de resultados por página
HTTP status code 200
Búsqueda correcta de una cuenta
Body
Media type: application/json
Type: any
Examples:
User:
{
"apiVersion": "AUTO",
"data": {
"itemsCount": 1,
"items": [
{
"id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595",
"email": "abusquiel@test.com",
"registerat": 1483228800000,
"preregisterat": null,
"fullName": "abusquiel",
"avatar": null,
"isDigitalEntity": false,
"type": "ACCOUNT",
"normalizedName": "abusquiel",
"fromDU": false
}
]
}
}
Digital Identity:
{
"apiVersion": "AUTO",
"data": {
"itemsCount": 1,
"items": [
{
"id": "ff7c3d5f-36e3-4d82-bc74-f6964a042595",
"email": "DI@e564824a-14ec-4087-8e0b-e74ade6e21cf",
"registerat": 1483228800000,
"preregisterat": null,
"fullName": "DI",
"avatar": null,
"isDigitalEntity": true,
"type": "ACCOUNT",
"normalizedName": "DI",
"fromDU": false,
"ownedBy": "e564824a-14ec-4087-8e0b-e74ade6e21cf"
}
]
}
}
HTTP status code 500
Error interno
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "\"query.fromSubscriptionId\" is not allowed",
"errors": []
}
}
Obtiene los grupos de usuario de una suscripción.
Crea un nuevo grupo de usuarios para un cliente.
get /subscriptions/{subscriptionId}/usergroups
Obtiene los grupos de usuario de una suscripción.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"items": [
{
"id": "ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0",
"name": "Grupo Prueba",
"description": null
}
],
"itemCount": 1
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /subscriptions/{subscriptionId}/usergroups
Crea un nuevo grupo de usuarios para un cliente.
URI Parameters
- subscriptionId: required(string - pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$)
Identificador de la suscripción
Example:
0dae5b93-9451-4b08-b7bb-f0b944fbcdf2
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "Grupo Prueba",
"description": "Descripción"
}
HTTP status code 201
La petición ha sido correcta y devuelve el id del nuevo cliente
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"id": "26801e24-ecf6-4499-8eaa-5ceffc6ba4cf"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Tags
Operaciones de la API de tags
Create a context
post /tags/instances/{instancesId}/contexts
Create a context
URI Parameters
- instancesId: required(string)
Id from the application in platform
Body
Media type: application/json
Type: object
Properties- contextId: (string)
Name for the context
- description: (string)
Description for the context
HTTP status code 201
Context created succesffuly
Body
Media type: application/json
Type: object
Properties- id: (string)
- description: (string)
- _id: (string)
Example:
{"id": "DocumentsContext", "description":"Context for documents tags", "_id": "DocumentId"}
HTTP status code 460
Error: Context with the same id already exists
Get a context by Id
get /tags/instances/{instancesId}/contexts/{contextId}
Get a context by Id
URI Parameters
- instancesId: required(string)
Id from the application in platform
- contextId: required(string)
Creates and object
post /tags/instances/{instancesId}/contexts/{contextId}/objects
Creates and object
URI Parameters
- instancesId: required(string)
Id from the application in platform
- contextId: required(string)
Body
Media type: application/json
Type: Taggable Object
HTTP status code 200
Object created successfully
Body
Media type: application/json
Type: Taggable Object
Example:
{
"id": "obj1",
"tags": ["tag1", "tag2", "tag3"],
"contextId": "DocumentsContext",
"_id": "DocumentId"}
HTTP status code 400
Bad request (check params values)
Body
Media type: application/json
Type: object
HTTP status code 404
Context Id not found
HTTP status code 460
Object Id already exists
Get an object data (mainly its tags)
Deletes and object
get /tags/instances/{instancesId}/contexts/{contextId}/objects/{objectId}
Get an object data (mainly its tags)
delete /tags/instances/{instancesId}/contexts/{contextId}/objects/{objectId}
Add a tag in an object
post /tags/instances/{instancesId}/contexts/{contextId}/objects/{objectId}/tags
Add a tag in an object
URI Parameters
- instancesId: required(string)
Id from the application in platform
- contextId: required(string)
- objectId: required(string)
- contextId: required(string)
Body
Media type: application/json
Type: object
Properties- tag: required(string)
Tag value
Example:
{
"tag": "magenta"
}
Deletes a tag in an object
delete /tags/instances/{instancesId}/contexts/{contextId}/objects/{objectId}/tags/{tagName}
Deletes a tag in an object
URI Parameters
- instancesId: required(string)
Id from the application in platform
- contextId: required(string)
- objectId: required(string)
- tagName: required(string)
- contextId: required(string)
HTTP status code 200
Tag removed successfully
Body
Media type: application/json
Type: Taggable Object
Example:
{
"id": "obj34",
"tags": [
"69",
"red"
],
"contextId": "x"
}
Search objects by tags
post /tags/instances/{instancesId}/contexts/{contextId}/search
Search objects by tags
URI Parameters
- instancesId: required(string)
Id from the application in platform
- contextId: required(string)
Context where to search
Query Parameters
- limit: (number)
Page size (10 by default)
Example:
limit=10
- offset: (number)
Page number (0 by default)
Example:
offset=3
Body
Media type: application/json
Type: object
Properties- tags: required(array of string)
Tags to find
- type: required(one of ANY, ALL)
Type of tags inclusion for the search (ANY or ALL)
Example:
{
"tags": ["red", "important"],
"type": "ANY"
}
HTTP status code 200
Search OK
Body
Media type: application/json
Type: object
Properties- list: required(array of object)
Items: items
- id: required(string)
Object Id
- tags: required(array of string)
Tags of the object
- id: required(string)
- limit: required(number - default: 10 - minimum: 1 - maximum: 100)
limit or page size of this search
- offset: required(number - default: 0 - minimum: 0)
Offset or page that was returned
Example:
{
"list": [
{
"id": "obj33",
"tags": [
"66",
"red"
],
"contextId": "x"
},
{
"id": "obj54",
"tags": [
"69",
"red"
],
"contextId": "x"
}
],
"limit": 2,
"offset": 0
}
Filter tags by containing text
get /tags/instances/{instancesId}/contexts/{contextId}/tags
Filter tags by containing text
URI Parameters
- instancesId: required(string)
Id from the application in platform
- contextId: required(string)
Query Parameters
- search: (string)
String to search for inside the tags
Example:
search=era
- limit: (number - default: 10 - minimum: 1 - maximum: 100)
Page size of the results (default=10)
Example:
limit=10
- offset: (number - default: 0 - minimum: 0)
Number of page of the results (default=0)
Example:
offset=3
HTTP status code 200
Result of the search
Body
Media type: application/json
Type: object
Properties- list: required(array of object)
List of tags
Items: items
- name: required(string)
Name of the tag
Example:
blue
- count: required(string)
Number of the tag appearances in the context
- name: required(string)
- limit: required(number)
Limit or page size of the results
- offset: required(number)
Offset or Page of the results
Example:
{
"list": [
{
"name": "blue",
"count": 231948
}
],
"limit": 10,
"offset": 0
}
HTTP status code 400
Incorrect query params
HTTP status code 404
Context Id not found
Gets tag context data by name
get /tags/instances/{instancesId}/contexts/{contextId}/tags/{tagName}
Gets tag context data by name
URI Parameters
- instancesId: required(string)
Id from the application in platform
- contextId: required(string)
- tagName: required(string)
- contextId: required(string)
Template service
Operaciones de la API de templates
Permite buscar una plantilla, se puede poner uno o varios paramteros en la busqueda.
get /template/{instanceId}
Permite buscar una plantilla, se puede poner uno o varios paramteros en la busqueda.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- name: (string)
buscar por nombre de la plantilla
Example:
/template/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?name=Outlook
- description: (string)
buscar por descripción de la plantilla
Example:
/template/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?description=Plantilla para dar de alta
- defaultlanguage: (string)
Idioma por defecto de la plantilla
Example:
/template/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?defaultlanguage=es
- active: (boolean)
Indicador de si la plantilla se puede usar o esta en borrador
Example:
/template/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?active=true
- tags: (string)
Etuiquetas de las plantillas
Example:
/template/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?tags=Barcelona,Aqualogy
HTTP status code 200
Devuelve la/las plantilla/s de la instancia de servicio
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": [
{
"_id": "5bb4e02d4b5bcb4e90f0a535",
"name": "Nombre de la plantilla :)",
"description": "Dasdasd",
"active": true,
"mediaTypes": {
"sms": {
"active": true,
"type": "sms",
"slots": [
{
"id": "_message",
"type": "plain_text",
"name": "Contenido del SMS",
"description": "El texto máximo por SMS es 160 caracteres"
}
]
},
"email": {
"active": true,
"type": "email",
"config": {
"model": {
"name": "Otro modelo. Con el título lo más largo posible!!!",
"_id": "5b88e9f414457d4e9c5f89cb",
"sample": {
"name": "email.png",
"id": "407814a3-2585-474c-a50c-e7f3bcfe7d94",
"images": {
"original": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_original.png"
},
"medium": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_medium.png"
},
"large": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_large.png"
},
"small": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_small.png"
}
}
}
},
"modelId": "5b88e9f414457d4e9c5f89cb"
},
"slots": [
{
"id": "_subject",
"type": "plain_text",
"name": "Asunto",
"description": "El texto que aparecerá en el asunto del email"
},
{
"id": "header",
"type": "text",
"description": "No debería superar los 50 caracteres",
"name": "Texto de cabecera"
},
{
"id": "avatar",
"type": "image",
"description": "En formato cuadrado",
"name": "Logotipo para el banner"
},
{
"id": "banner",
"type": "image",
"description": null,
"name": "Banner publicitario"
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje"
},
{
"id": "footer",
"type": "image",
"description": "No más de 140 caracteres",
"name": "Texto al pié"
}
]
}
},
"serviceInstanceId": "a26cb412-18bd-4dab-9408-4985a622ae4e",
"creationDate": "2018-10-03T15:28:45.805Z",
"modificationDate": "2018-10-04T06:25:39.879Z",
"content": {
"es_ES": {
"code": "es_ES",
"creationDate": "2018-10-03T15:29:02.435Z",
"modificationDate": "2018-10-04T06:25:39.879Z",
"email": {
"_subject": {
"value": "Pruba 1, 2, 3"
},
"header": {
"value": "<p>Texto de cabecera, con variables {{uno}}, {{dos}} y {{tres}}</p>"
},
"avatar": {
"value": "https://absneargodevimages1002.blob.core.windows.net/ndezmwq0mjatzjfhny00ognllwi0ztetzgzjnwe4yjuymwfj-logocontent/DcdqeRIvlh9pouXYMEIfdYmyfTwMKewWAXWWnoDOwHdP4kLoTxmrMD20i9vq45fl_original.png"
},
"banner": {
"value": "https://elpais.com/economia/imagenes/2015/09/01/actualidad/1441124762_228468_1441126267_noticia_fotograma.jpg"
},
"body": {
"value": "<p>Esto es el cuerpo del mensaje.</p>"
}
},
"variables": {
"uno": {
"count": 1
},
"dos": {
"count": 1
},
"tres": {
"count": 1
}
}
}
},
"defaultLanguage": "es_ES"
},
{
"_id": "8bb4e02d4b5bcb4e90f0a538",
"name": "Aviso Agua",
"description": "Aviso factura nueva",
"active": true,
"mediaTypes": {
"sms": {
"active": true,
"type": "sms",
"slots": [
{
"id": "_message",
"type": "plain_text",
"name": "Contenido del SMS",
"description": "El texto máximo por SMS es 160 caracteres"
}
]
},
"email": {
"active": true,
"type": "email",
"config": {
"model": {
"name": "Otro modelo. Con el título lo más largo posible!!!",
"_id": "5b88e9f414457d4e9c5f89cb",
"sample": {
"name": "email.png",
"id": "407814a3-2585-474c-a50c-e7f3bcfe7d94",
"images": {
"original": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_original.png"
},
"medium": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_medium.png"
},
"large": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_large.png"
},
"small": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_small.png"
}
}
}
},
"modelId": "5b88e9f414457d4e9c5f89cb"
},
"slots": [
{
"id": "_subject",
"type": "plain_text",
"name": "Asunto",
"description": "El texto que aparecerá en el asunto del email"
},
{
"id": "header",
"type": "text",
"description": "No debería superar los 50 caracteres",
"name": "Texto de cabecera"
},
{
"id": "avatar",
"type": "image",
"description": "En formato cuadrado",
"name": "Logotipo para el banner"
},
{
"id": "banner",
"type": "image",
"description": null,
"name": "Banner publicitario"
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje"
},
{
"id": "footer",
"type": "image",
"description": "No más de 140 caracteres",
"name": "Texto al pié"
}
]
}
},
"serviceInstanceId": "a26cb412-18bd-4dab-9408-4985a622ae4e",
"creationDate": "2018-10-03T15:28:45.805Z",
"modificationDate": "2018-10-04T06:25:39.879Z",
"content": {
"es_ES": {
"code": "es_ES",
"creationDate": "2018-10-03T15:29:02.435Z",
"modificationDate": "2018-10-04T06:25:39.879Z",
"email": {
"_subject": {
"value": "Pruba 1, 2, 3"
},
"header": {
"value": "<p>Texto de cabecera, con variables {{uno}}, {{dos}} y {{tres}}</p>"
},
"avatar": {
"value": "https://absneargodevimages1002.blob.core.windows.net/ndezmwq0mjatzjfhny00ognllwi0ztetzgzjnwe4yjuymwfj-logocontent/DcdqeRIvlh9pouXYMEIfdYmyfTwMKewWAXWWnoDOwHdP4kLoTxmrMD20i9vq45fl_original.png"
},
"banner": {
"value": "https://elpais.com/economia/imagenes/2015/09/01/actualidad/1441124762_228468_1441126267_noticia_fotograma.jpg"
},
"body": {
"value": "<p>Esto es el cuerpo del mensaje.</p>"
}
},
"variables": {
"uno": {
"count": 1
},
"dos": {
"count": 1
},
"tres": {
"count": 1
}
}
}
},
"defaultLanguage": "es_ES"
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Permite obtener una plantilla mediante su id
Añadir una planificación por defecto en una plantilla
get /template/{instanceId}/{id}
Permite obtener una plantilla mediante su id
URI Parameters
- instanceId: required(string)
- id: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve la plantilla
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": [
{
"_id": "5bb4e02d4b5bcb4e90f0a535",
"name": "Nombre de la plantilla :)",
"description": "Dasdasd",
"active": true,
"mediaTypes": {
"sms": {
"active": true,
"type": "sms",
"slots": [
{
"id": "_message",
"type": "plain_text",
"name": "Contenido del SMS",
"description": "El texto máximo por SMS es 160 caracteres"
}
]
},
"email": {
"active": true,
"type": "email",
"config": {
"model": {
"name": "Otro modelo. Con el título lo más largo posible!!!",
"_id": "5b88e9f414457d4e9c5f89cb",
"sample": {
"name": "email.png",
"id": "407814a3-2585-474c-a50c-e7f3bcfe7d94",
"images": {
"original": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_original.png"
},
"medium": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_medium.png"
},
"large": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_large.png"
},
"small": {
"url": "https://absneargodevimages1002.blob.core.windows.net/nda3ode0ytmtmju4ns00nzrjlwe1mgmtztdmm2jjzmu3zdk0-logocontent/vNBIlaICadMotZx100qlI4vaCZOIcbkvQgWBx7ltG6lJIbptk9jFTLfU9xISgj3R_small.png"
}
}
}
},
"modelId": "5b88e9f414457d4e9c5f89cb"
},
"slots": [
{
"id": "_subject",
"type": "plain_text",
"name": "Asunto",
"description": "El texto que aparecerá en el asunto del email"
},
{
"id": "header",
"type": "text",
"description": "No debería superar los 50 caracteres",
"name": "Texto de cabecera"
},
{
"id": "avatar",
"type": "image",
"description": "En formato cuadrado",
"name": "Logotipo para el banner"
},
{
"id": "banner",
"type": "image",
"description": null,
"name": "Banner publicitario"
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje"
},
{
"id": "footer",
"type": "image",
"description": "No más de 140 caracteres",
"name": "Texto al pié"
}
]
}
},
"serviceInstanceId": "a26cb412-18bd-4dab-9408-4985a622ae4e",
"creationDate": "2018-10-03T15:28:45.805Z",
"modificationDate": "2018-10-04T06:25:39.879Z",
"content": {
"es_ES": {
"code": "es_ES",
"creationDate": "2018-10-03T15:29:02.435Z",
"modificationDate": "2018-10-04T06:25:39.879Z",
"email": {
"_subject": {
"value": "Pruba 1, 2, 3"
},
"header": {
"value": "<p>Texto de cabecera, con variables {{uno}}, {{dos}} y {{tres}}</p>"
},
"avatar": {
"value": "https://absneargodevimages1002.blob.core.windows.net/ndezmwq0mjatzjfhny00ognllwi0ztetzgzjnwe4yjuymwfj-logocontent/DcdqeRIvlh9pouXYMEIfdYmyfTwMKewWAXWWnoDOwHdP4kLoTxmrMD20i9vq45fl_original.png"
},
"banner": {
"value": "https://elpais.com/economia/imagenes/2015/09/01/actualidad/1441124762_228468_1441126267_noticia_fotograma.jpg"
},
"body": {
"value": "<p>Esto es el cuerpo del mensaje.</p>"
}
},
"variables": {
"uno": {
"count": 1
},
"dos": {
"count": 1
},
"tres": {
"count": 1
}
}
}
},
"defaultLanguage": "es_ES"
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
put /template/{instanceId}/{id}
Añadir una planificación por defecto en una plantilla
URI Parameters
- instanceId: required(string)
- id: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: object
Properties- scheduledDelivery: required(object)
- planningId: required(string)
Identificación de la planificación.
- timeZone: required(string)
Zona horaria (TZ database name), lista de zonas disponibles - https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- planningId: required(string)
Example:
{
"scheduledDelivery": {
"planningId": "5f71abd9273bae2e98f6049b",
"timeZone": "Europe/Madrid"
}
}
HTTP status code 200
Devuelve la plantilla
Body
Media type: application/json
Type: any
Example:
{
"_id": "6135dd19a785822cb4b2938a",
"name": "Test1",
"description": "",
"active": true,
"mediaTypes": {
"sms": {
"active": true,
"type": "sms",
"slots": [
{
"id": "_message",
"type": "plain_text",
"name": "Contenido del SMS",
"description": "El texto máximo por SMS es 160 caracteres"
}
]
},
"email": {
"active": true,
"type": "email",
"config": {
"model": {
"name": "GENERAL. Respuesta general (CX)",
"_id": "60c8c0ac4a99d50018abec63",
"sample": null,
"html": {
"file": {},
"name": "modelo_clientes_explotacion_JFVV.html",
"content": "<!DOCTYPE html>\n\n<!-- Prueba JFVV Modelo para duplicado documentos -->\n\n<html>\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n <title>Notificación</title>\n </head>\n\n <body>\n \n <table>\n <tr>\n <td><img aq-slot=\"avatar\" type=\"image\" name=\"Logotipo para el banner\" description=\"Imagen para el logo de la sociedad\" style=\"border:none;display:block;\" width=\"100%\"></td>\n <td><img src=\"http://www.aguasonline.es/afsp/CABECERA_ES_01.jpg\" style=\"border:none;display:block;\" width=\"100%\" /></td>\n </tr>\n </table>\n\n <p aq-slot=\"body\" type=\"text\" name=\"Cuerpo del mensaje\"></p>\n \n <!-- <p aq-slot=\"footer\" type=\"text\" name=\"Texto de pie\" description=\"No debería superar los 50 caracteres\"> -->\n <img src=\"http://www.aguasonline.es/afsp/PIE_01.jpg\" style=\"border:none;display:block;\" width=\"100%\" /> \n\n\t<p aq-model-slot=\"pie\" type=\"text\" name=\"Mensaje del pie\"></p>\n <p aq-model-slot=\"pie\" type=\"text\" name=\"Mensaje del pie 2\"></p>\n </body>\n</html>",
"slots": [
{
"id": "avatar",
"type": "image",
"description": "Imagen para el logo de la sociedad",
"name": "Logotipo para el banner",
"isModelSlot": false
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje",
"isModelSlot": false
},
{
"id": "pie",
"type": "text",
"description": null,
"name": "Mensaje del pie",
"isModelSlot": true
},
{
"id": "pie",
"type": "text",
"description": null,
"name": "Mensaje del pie 2",
"isModelSlot": true
}
],
"html": {}
}
},
"modelId": "60c8c0ac4a99d50018abec63"
},
"slots": [
{
"id": "_subject",
"type": "plain_text",
"name": "Asunto",
"description": "El texto que aparecerá en el asunto del email"
},
{
"id": "avatar",
"type": "image",
"description": "Imagen para el logo de la sociedad",
"name": "Logotipo para el banner",
"isModelSlot": false
},
{
"id": "body",
"type": "text",
"description": null,
"name": "Cuerpo del mensaje",
"isModelSlot": false
},
{
"id": "pie",
"type": "text",
"description": null,
"name": "Mensaje del pie",
"isModelSlot": true
},
{
"id": "pie",
"type": "text",
"description": null,
"name": "Mensaje del pie 2",
"isModelSlot": true
}
]
}
},
"serviceInstanceId": "7189d2d4-e4b6-42ca-a3f4-b5e67a909879",
"creationDate": "2021-09-06T09:19:21.376Z",
"content": {
"va_ES": {
"code": "va_ES",
"creationDate": "2022-12-07T13:26:51.436Z",
"email": {
"body": {
"value": "Hola {{admin}} que tal"
}
},
"modificationDate": "2023-03-02T15:38:00.723Z",
"variables": {
"admin": {
"count": 1,
"defaultValue": "lyubo"
},
"myUser": {
"count": 1
}
},
"sms": {
"_message": {
"value": "Hola {{myUser}},\nSaludos del equipo de Nautilus!!!"
}
}
}
},
"defaultLanguage": "va_ES",
"modificationDate": "2023-03-08T10:25:45.586Z",
"tags": [
"5"
],
"scheduledDelivery": {
"planningId": "60a61d8470b1760018a7963a",
"timeZone": "Europe/Madrid"
}
}
HTTP status code 400
Los parámetros de entrada no son validos.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"error": {
"code": 400,
"message": {
"error": {
"localeMessage": " Wrong timezone Europe/Lleida",
"code": "WRONG_TIME_ZONE"
}
},
"errors": []
}
}
HTTP status code 404
planificación no encontrada
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "AUTO",
"error": {
"code": 404,
"message": {
"error": {
"localeMessage": "Planning: 60a61d8470b1760018a7963h not found",
"code": "NOT_FOUND"
}
},
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {},
"error": {
"code": "REQUEST_ERRORSEND_EXCEPTION",
"message": "Hubo un error en el envío del correo.",
"criticity": 5,
"errors": []
}
}
Permite obtener los idiomas que tiene una plantilla
get /template/{instanceId}/{id}/languages
Permite obtener los idiomas que tiene una plantilla
URI Parameters
- instanceId: required(string)
- id: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
Devuelve los idiomas
Body
Media type: application/json
Type: any
Example:
[
"es_ES",
"en_UK",
"it_IT"
]
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"statusCode": 400,
"code": "INVALID_PARAMETERS"
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"error": {
"code": "NOT_FOUND_EXCEPTION",
"message": "No existe la plantilla con el id: 9b0fb5d8c35b24317cc8fcc5",
"errors": []
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"code": "MongoError",
"name": "MongoError"
}
Permite filtrar las plantillas, el filtro aplica al nombre, descripción, etiquetas, repositorios, Publicadas/No publicadas, email y/o sms.
get /template/{instanceId}/filter
Permite filtrar las plantillas, el filtro aplica al nombre, descripción, etiquetas, repositorios, Publicadas/No publicadas, email y/o sms.
URI Parameters
- instanceId: required(string)
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: required(string)
Filtro
Example:
/template/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc/filter?filter=les
- tags: (string)
Etiquetas de las plantillas
Example:
/template/f4d7ac16-748a-11e8-adc0-fa7ae01bbebc?tags=Barcelona,Aqualogy
Translations
En el siguiente listado se muestran todas las operaciones disponibles para la consulta de traducciones
Obtiene todas las traducciones de un servicio.
get /translate/translations/list/{app}/{type}/{language}
Obtiene todas las traducciones de un servicio.
URI Parameters
- app: required(string)
- type: required(string)
- language: required(string)
HTTP status code 200
Devuelve un objeto clave/valor con todas las traducciones
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"items": [
{
"code": "WELCOME",
"text": "Bienvenido a File Service"
},
{
"code": "404",
"text": "404. Recurso no encontrado"
},
{
"code": "500",
"text": "00. Ups... Hemos tenido un problema."
},
{
"code": "FILE_NAME",
"text": "Nombre"
},
{
"code": "FILE_REGDATE",
"text": "Fecha registro"
},
{
"code": "FILE_CREATED_AT",
"text": "Fecha creación"
},
{
"code": "FILES_LIST_TITLE",
"text": "Listado de ficheros"
},
{
"code": "FILE_TAGS",
"text": "Etiquetas"
},
{
"code": "YES",
"text": "yes"
},
{
"code": "NO",
"text": "no"
},
{
"code": "CLOSE",
"text": "Cerrar"
},
{
"code": "EMPTY_FILES",
"text": "No hay elementos que mostrar"
},
{
"code": "INTERNET_EXCEPTION",
"text": "Ups... La conexión no responde"
},
{
"code": "ITEMS_PER_PAGE",
"text": "Elementos por página"
},
{
"code": "OF",
"text": "de"
},
{
"code": "SEARCH_FILE",
"text": "Buscar por nombre"
},
{
"code": "START_DATE",
"text": "Fecha inicio"
},
{
"code": "END_DATE",
"text": "Fecha final"
},
{
"code": "CREATION",
"text": "Creación"
},
{
"code": "REGISTRATION",
"text": "Registro"
},
{
"code": "DATE_TYPE",
"text": "Tipo de fecha"
}
]
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "RESOURCE_NOT_FOUND"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "SERVER_ERROR"
}
}
Obtiene todas las traducciones de un servicio.
get /translate/translations/{app}/{type}/{language}
Obtiene todas las traducciones de un servicio.
URI Parameters
- app: required(string)
- type: required(string)
- language: required(string)
HTTP status code 200
Devuelve un objeto clave/valor con todas las traducciones
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"self": {
"404": "404. Recurso no encontrado",
"500": "00. Ups... Hemos tenido un problema.",
"FILE_REGDATE": "Fecha registro",
"NO": "no",
"EMPTY_FILES": "No hay elementos que mostrar",
"YES": "yes",
"ITEMS_PER_PAGE": "Elementos por página",
"WELCOME": "Bienvenido a File Service",
"END_DATE": "Fecha final",
"START_DATE": "Fecha inicio",
"CLOSE": "Cerrar",
"FILE_NAME": "Nombre",
"DATE_TYPE": "Tipo de fecha",
"FILES_LIST_TITLE": "Listado de ficheros",
"INTERNET_EXCEPTION": "Ups... La conexión no responde",
"OF": "de",
"CREATION": "Creación",
"FILE_TAGS": "Etiquetas",
"REGISTRATION": "Registro",
"FILE_CREATED_AT": "Fecha creación",
"SEARCH_FILE": "Buscar por nombre"
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "RESOURCE_NOT_FOUND"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "SERVER_ERROR"
}
}
Obtiene todos los lenguajes disponibles.
get /translate/translate/metadata/languages
Obtiene todos los lenguajes disponibles.
HTTP status code 200
Devuelve un array con todos los lenguajes disponibles.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"items": [
{
"id": "L0",
"visibility": "origin"
},
{
"id": "ca-ES",
"visibility": "all"
},
{
"id": "en-GB",
"visibility": "all"
},
{
"id": "en-US",
"visibility": "all"
},
{
"id": "es-ES",
"visibility": "all"
},
{
"id": "fr-FR",
"visibility": "all"
},
{
"id": "de-DE",
"visibility": "all"
},
{
"id": "pt-PT",
"visibility": "all"
}
]
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "RESOURCE_NOT_FOUND"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "SERVER_ERROR"
}
}
Obtiene todos los lenguajes disponibles en una aplicación.
get /translate/translate/metadata/languages/{app}
Obtiene todos los lenguajes disponibles en una aplicación.
URI Parameters
- app: required(string)
HTTP status code 200
Devuelve un array con todos los lenguajes disponibles.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"data": {
"items": [
{
"id": "L0",
"visibility": "origin"
},
{
"id": "ca-ES",
"visibility": "all"
},
{
"id": "en-GB",
"visibility": "all"
},
{
"id": "en-US",
"visibility": "all"
},
{
"id": "es-ES",
"visibility": "all"
},
{
"id": "fr-FR",
"visibility": "all"
},
{
"id": "de-DE",
"visibility": "all"
},
{
"id": "pt-PT",
"visibility": "all"
}
]
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "RESOURCE_NOT_FOUND"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "SERVER_ERROR"
}
}
User Groups
Operaciones de la API de grupos
Obtiene un grupo de usuarios.
Actualiza un grupo de usuarios.
Borra un grupo de usuarios y todos sus usuarios.
get /usergroups/{userGroupId}
Obtiene un grupo de usuarios.
URI Parameters
- userGroupId: required(string)
Example:
ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"id": "ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0",
"name": "Grupo Prueba",
"description": null,
"accounts": [
{
"accountId": "e60ac104-6a01-4928-89a5-f5bbd751ff4c"
}
]
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
put /usergroups/{userGroupId}
Actualiza un grupo de usuarios.
URI Parameters
- userGroupId: required(string)
Example:
ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"name": "Grupo Prueba",
"description": "Descripción"
}
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"id": "ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0",
"name": "Grupo Prueba",
"description": null,
"accounts": [
{
"accountId": "e60ac104-6a01-4928-89a5-f5bbd751ff4c"
}
]
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
delete /usergroups/{userGroupId}
Borra un grupo de usuarios y todos sus usuarios.
URI Parameters
- userGroupId: required(string)
Example:
ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
La petición ha sido correcta.
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Obtienes las cuentas asociadas a un grupo de usuarios.
Asocia una cuenta a un grupo de usuarios.
get /usergroups/{userGroupId}/accounts
Obtienes las cuentas asociadas a un grupo de usuarios.
URI Parameters
- userGroupId: required(string)
Example:
ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Query Parameters
- filter: (string)
filtra por nombre y email
Example:
accounts?filter=email2@test.com
- offset: (integer)
Número del elemento a partir del cual vamos a obtener resultados.
Example:
/accounts?offset=0
- limit: (integer)
Especifica el número máximo de elementos que va a devolver la petición. Máximo 100.
Example:
/accounts?limit=15
HTTP status code 200
La petición ha sido correcta.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "1.0.0",
"data": {
"self": {
"data": [
{
"id": "64b2f704-d97c-4045-9531-f92d71c2b69f",
"email": "hackeando_182341@account.api",
"registerat": 1526456962897,
"fullName": "HACKEANDO_182341",
"isSubscriptionAdmin": false,
"isDigitalEntity": false,
"avatar": null
},
{
"id": "01c044e1-f1f3-4c98-a408-63c837e333c1",
"email": "hackeando_182341234@account.api",
"registerat": 1526459506999,
"fullName": "HACKEANDO_182341234",
"isSubscriptionAdmin": false,
"isDigitalEntity": true,
"avatar": null
}
],
"pagination": {
"offset": 2,
"limit": 4,
"totalItems": 7,
"previous": {
"offset": 0
},
"next": {
"offset": 2
}
}
}
}
}
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
post /usergroups/{userGroupId}/accounts
Asocia una cuenta a un grupo de usuarios.
URI Parameters
- userGroupId: required(string)
Example:
ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
Body
Media type: application/json
Type: any
Example:
{
"accountId": "e60ac104-6a01-4928-89a5-f5bbd751ff4c"
}
HTTP status code 201
La petición ha sido correcta
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 409
No se puede asociar la cuenta porque no pertenece al cliente al que pertenece el grupo de usuarios.
Body
Media type: application/json
Type: any
Example:
{
"CODE": "ACCOUNT_CLIENT_NOT_EXIST"
}
HTTP status code 460
La entidad que se quiere crear ya existe o al actualizar el nombre ya existe alguna con ese nombre
Body
Media type: application/json
Type: any
Example:
{
"example": {
"apiVersion": "0.0.0",
"error": {
"code": "DUPLICATE_ENTITY",
"message": "Ya existe un recurso con el mismo identificador",
"errors": []
}
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
Borra una cuenta de un grupo de usuario.
delete /usergroups/{userGroupId}/accounts/{accountId}
Borra una cuenta de un grupo de usuario.
URI Parameters
- userGroupId: required(string)
Example:
ac3bf3d1-6547-4eec-9eeb-cfb973be0dd0
- accountId: required(string)
Example:
e60ac104-6a01-4928-89a5-f5bbd751ff4c
Headers
- Authorization: required(string)
Identidad digital. Tiene caducidad.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJTVVBFUl9BRE1JTiIsIm5iZiI6IjIwMTctMDUtMTZUMTY6MDA6MTUuOTYwWiIsImV4cCI6MTUyNjQ4NjQxNS45NTksImF1ZCI6ImFwaSIsInRva2VuVHlwZSI6IkFDQ0VTU19UT0tFTiIsImxvY2FsZSI6ImVzX0VTIiwidXNlck5hbWUiOiJTdXBlciBBZG1pbiIsInJvbGVzIjpbXX0.MycT6QoxZGDjn0owv5_vm1PGPdjRG60iFMdS_UdJhs_Ifgy4aUzIhfhgvSTURtqMeAMBaSigdgqb2oweyDqKf1vQSugbC19P0uJeOKGiaQuq2amtdU42fDpzs2hHouJ-Ffbtjxg4J25iCxm0Hrvb6EZxfbOtHJU_9r6ZwggBoc8
HTTP status code 204
La petición ha sido correcta.
HTTP status code 400
Petición mal formada. Faltan campos obligatorios o los campos informados no tienen el formato correcto.
Body
Media type: application/json
Type: any
Example:
{
"apiVersion": "0.0.0",
"error": {
"code": "INVALID_PARAMETERS",
"message": ".params.id should match pattern \"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$\"",
"errors": []
}
}
HTTP status code 403
Error de autentificación. No tiene permisos permisos para acceder a los datos
Body
Media type: application/json
Type: any
Example:
{
"status": 403,
"type": "Forbidden",
"reasons": [
{
"message": "Authorization failed. The selected account does not have permissions for the selected product.",
"details": "User does not have privileges"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "1ff31755e1921e1a:1ff31755e1921e1a:0:1"
}
}
HTTP status code 404
Servicio o recurso no encontrado.
Body
Media type: application/json
Type: any
Example:
{
"status": 404,
"type": "AccountNotFound",
"reasons": [
{
"message": "Esta cuenta no existe.",
"details": "Account 64f3e593-829b-4b83-9b18-6cc0382a27d1 not found"
}
],
"origin": {
"service": "Account",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}
HTTP status code 500
Internal Server Error - Cualquier otro posible error
Body
Media type: application/json
Type: any
Example:
{
"status": 500,
"type": "UnknownError",
"reasons": [
{
"message": "Error desconocido",
"details": "An unknown error has occurred"
}
],
"origin": {
"service": "api",
"version": "AUTO",
"traceId": "6db622527c7b3a3c:6db622527c7b3a3c:0:1"
}
}