IMBI-API Reference
Version 0.5.2
Overview
IMBICLOUD API uses JWT for authorization.
Access tokens expire after 9 hours. Refresh tokens expire after 9 days. All the endpoints needs for authorization to add in the header the Bearer token, except the login and refresh token endpoints.
For User Manual go to https://web.imbicloud.com/docs
Use HTTPS protocol in your requests to protect the connection.
Errors
All our endpoints return a 200 HTTP status code when everything works as expected, but it returns an error code when there is one. The codes used are the standard codes for HTTP response.
Order by
The records are order by updateAt descendent (the date when the record was updated). Endpoints have query params to specify the column and the order values.
POST
Login
https://{{host}}:{{port}}/api/auth/login
Gets a token that is requested giving an email and password.
BODY raw
{
"email": "example@imbi.com",
"password": "password"
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/auth/login
{
"email": "example@imbi.com",
"password": "password"
}
Example Response
200 - OK
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InByb3BpZXRhcmlvQHByb3BpZWRhZC5jb20iLCJpYXQiOjE2NzE1NTQ1ODYsImV4cCI6MTY3MTU1ODE4Nn0.JPsT_ypYOiJGlnsVc1jk9pGjiRbYIAebFHlBDu_havE",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InByb3BpZXRhcmlvQHByb3BpZWRhZC5jb20iLCJpYXQiOjE2NzE1NTQ1ODYsImV4cCI6MTY3MjE1OTM4Nn0.C3d2Bu-ekAPZqrYixSGWZqWyLOOOzYXjCEoQWXlGklg"
}
POST
Refresh Token
https://{{host}}:{{port}}/api/auth/refresh-token
Gets a refresh token.
BODY raw
{
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNlcnZpY2lvc2dlbmVyYWxlc0Bwcm9waWVkYWQuY29tIiwiaWF0IjoxNjAyOTU1NDkwLCJleHAiOjE2MDU1NDc0OTB9.FALHeM0JkZBZSOS0eLkghkJPzO_M5fZggsLjWpnolAE"
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/auth/refresh-token
{
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InByb3BpZXRhcmlvQHByb3BpZWRhZC5jb20iLCJpYXQiOjE2NzE1NTY0ODMsImV4cCI6MTY3MjE2MTI4M30.8gXuCZrSPu4TYcevaT49X1QhaJyiG-C26OXlnasH7nY"
}
Example Response
200 - OK
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InByb3BpZXRhcmlvQHByb3BpZWRhZC5jb20iLCJpYXQiOjE2NzE1NTY1MjMsImV4cCI6MTY3MTU2MDEyM30.iBTnNwjjJKKJC17yj2rvXvfEzrt79naC5LHZNtKD0GM"
}
GET
Me
https://{{host}}:{{port}}/api/auth/me
Gets information about the user logged.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/auth/me
Example Response
200 - OK
{
"id": 209,
"email": "propietario@propiedad.com",
"name": "Propietario",
"surname": "Propiedad",
"mobile": null,
"photo": null,
"isSuperAdmin": false,
"createdAt": "2021-06-03T09:33:38.000Z",
"updatedAt": "2021-06-03T09:33:38.000Z",
"creatorId": 44,
"updatorId": null,
"companyId": 1,
"addressId": null
}
GET
All
https://{{host}}:{{port}}/api/categories
Gets all the categories and subcategories defined by IMBICLOUD. These are the same in the service for every facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/categories
Example Response
200 - OK
[
{
"id": 1,
"name": "ELECTRICIDAD",
"parentCategoryId": null
},
{
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
},
{
"id": 3,
"name": "Canalizaciones",
"parentCategoryId": 1
},
{
"id": 4,
"name": "Cables",
"parentCategoryId": 1
},
{
"id": 5,
"name": "Mecanismos",
"parentCategoryId": 1
},
{
"id": 6,
"name": "Control",
"parentCategoryId": 1
},
{
"id": 7,
"name": "Alumbrado de emergencia",
"parentCategoryId": 1
},
{
"id": 8,
"name": "Alumbrado normal",
"parentCategoryId": 1
},
{
"id": 9,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 1
},
{
"id": 10,
"name": "CLIMATIZACIÓN, CALEFACCIÓN Y ACS",
"parentCategoryId": null
},
{
"id": 11,
"name": "Conductos",
"parentCategoryId": 10
},
{
"id": 12,
"name": "Control",
"parentCategoryId": 10
},
{
"id": 13,
"name": "Equipos Producción",
"parentCategoryId": 10
},
{
"id": 14,
"name": "Tuberías",
"parentCategoryId": 10
},
{
"id": 15,
"name": "Unidades Terminales (Fan-coil, Difusores, Rejillas)",
"parentCategoryId": 10
},
{
"id": 16,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 10
},
{
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
},
{
"id": 18,
"name": "Aparatos Sanitarios (lavabos, inodoros, etc)",
"parentCategoryId": 17
},
{
"id": 19,
"name": "Contador",
"parentCategoryId": 17
},
{
"id": 20,
"name": "Grifería",
"parentCategoryId": 17
},
{
"id": 21,
"name": "Tubería",
"parentCategoryId": 17
},
{
"id": 22,
"name": "Equipos de bombeo",
"parentCategoryId": 17
},
{
"id": 23,
"name": "Depósitos",
"parentCategoryId": 17
},
{
"id": 24,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 17
},
{
"id": 25,
"name": "SANEAMIENTO",
"parentCategoryId": null
},
{
"id": 26,
"name": "Pozos y arquetas",
"parentCategoryId": 25
},
{
"id": 27,
"name": "Sumideros",
"parentCategoryId": 25
},
{
"id": 28,
"name": "Tubería",
"parentCategoryId": 25
},
{
"id": 29,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 25
},
{
"id": 30,
"name": "REDES TELECOMUNICACIONES",
"parentCategoryId": null
},
{
"id": 31,
"name": "Cableado Redes/Datos",
"parentCategoryId": 30
},
{
"id": 32,
"name": "Cableado Telefonía/Voz",
"parentCategoryId": 30
},
{
"id": 33,
"name": "Equipos Redes/Datos",
"parentCategoryId": 30
},
{
"id": 34,
"name": "Equipos Telefonía/Voz",
"parentCategoryId": 30
},
{
"id": 35,
"name": "Mecanismos (Tomas de Tlf, Datos y SAI)",
"parentCategoryId": 30
},
{
"id": 36,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 30
},
{
"id": 37,
"name": "PCI",
"parentCategoryId": null
},
{
"id": 38,
"name": "Armarios",
"parentCategoryId": 37
},
{
"id": 39,
"name": "BIEs",
"parentCategoryId": 37
},
{
"id": 40,
"name": "Centralita",
"parentCategoryId": 37
},
{
"id": 41,
"name": "Electricidad (Cuadros, tuberías, cableado, etc)",
"parentCategoryId": 37
},
{
"id": 42,
"name": "Equipo de Presión/Bombeo",
"parentCategoryId": 37
},
{
"id": 43,
"name": "Extintores",
"parentCategoryId": 37
},
{
"id": 44,
"name": "Otro sistema extinción (gas, etc)",
"parentCategoryId": 37
},
{
"id": 45,
"name": "Rociadores",
"parentCategoryId": 37
},
{
"id": 46,
"name": "Señalización",
"parentCategoryId": 37
},
{
"id": 47,
"name": "Detectores",
"parentCategoryId": 37
},
{
"id": 48,
"name": "Sirenas",
"parentCategoryId": 37
},
{
"id": 49,
"name": "Tuberías",
"parentCategoryId": 37
},
{
"id": 50,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 37
},
{
"id": 51,
"name": "VENTILACIÓN Y EXTRACCIÓN",
"parentCategoryId": null
},
{
"id": 52,
"name": "Rejillas",
"parentCategoryId": 51
},
{
"id": 53,
"name": "Compuertas",
"parentCategoryId": 51
},
{
"id": 54,
"name": "Conductos",
"parentCategoryId": 51
},
{
"id": 55,
"name": "Control (Cuadros, tuberías, cableado)",
"parentCategoryId": 51
},
{
"id": 56,
"name": "Electricidad (Cuadros, tuberías, cableado, etc)",
"parentCategoryId": 51
},
{
"id": 57,
"name": "Ventiladores",
"parentCategoryId": 51
},
{
"id": 58,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 51
},
{
"id": 59,
"name": "EQUIPAMIENTO INFORMÁTICO",
"parentCategoryId": null
},
{
"id": 60,
"name": "Ordenadores",
"parentCategoryId": 59
},
{
"id": 61,
"name": "Racks",
"parentCategoryId": 59
},
{
"id": 62,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 59
},
{
"id": 63,
"name": "MOBILIARIO",
"parentCategoryId": null
},
{
"id": 64,
"name": "Armarios y Archivos",
"parentCategoryId": 63
},
{
"id": 65,
"name": "Mamparas/Divisiones",
"parentCategoryId": 63
},
{
"id": 66,
"name": "Mesas",
"parentCategoryId": 63
},
{
"id": 67,
"name": "Sillas",
"parentCategoryId": 63
},
{
"id": 68,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 63
},
{
"id": 69,
"name": "ELEMENTOS CONSTRUCTIVOS",
"parentCategoryId": null
},
{
"id": 70,
"name": "Carpintería de Madera",
"parentCategoryId": 69
},
{
"id": 71,
"name": "Carpintería Metálica/Cerrajería",
"parentCategoryId": 69
},
{
"id": 72,
"name": "Elementos estructurales",
"parentCategoryId": 69
},
{
"id": 73,
"name": "Paredes",
"parentCategoryId": 69
},
{
"id": 74,
"name": "Pavimentos Exteriores",
"parentCategoryId": 69
},
{
"id": 75,
"name": "Suelos/Pavimentos interiores",
"parentCategoryId": 69
},
{
"id": 76,
"name": "Techos",
"parentCategoryId": 69
},
{
"id": 77,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 69
},
{
"id": 78,
"name": "Vidrios",
"parentCategoryId": 69
},
{
"id": 79,
"name": "TRANSPORTE",
"parentCategoryId": null
},
{
"id": 80,
"name": "Ascensores",
"parentCategoryId": 79
},
{
"id": 81,
"name": "Escaleras Mecánicas",
"parentCategoryId": 79
},
{
"id": 82,
"name": "Travelators",
"parentCategoryId": 79
},
{
"id": 83,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 79
},
{
"id": 84,
"name": "OTROS",
"parentCategoryId": null
},
{
"id": 85,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 84
},
{
"id": 86,
"name": "Pulsadores",
"parentCategoryId": 37
},
{
"id": 87,
"name": "Válvulas",
"parentCategoryId": 37
},
{
"id": 88,
"name": "Válvulas",
"parentCategoryId": 17
},
{
"id": 89,
"name": "GAS",
"parentCategoryId": null
},
{
"id": 90,
"name": "Contador",
"parentCategoryId": 89
},
{
"id": 91,
"name": "Tuberías",
"parentCategoryId": 89
},
{
"id": 92,
"name": "Varios (pequeño material y resto)",
"parentCategoryId": 89
}
]
GET
Unread
https://{{host}}:{{port}}/api/chat-messages/unread?facilityId={{facilityId}}
Gets a number of the messages unread in the facility.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/chat-messages/unread?facilityId=1
Example Response
200 - OK
{
"count": 94
}
GET
All
https://{{host}}:{{port}}/api/companies?facilityId={{facilityId}}&companyTypeId={{companyTypeId}}
Gets all the companies in IMBICLOUD.
PARAMS
cif
B7
String to filter by CIF.
name
SL
String to filter by name of the company.
facilityId
{{facilityId}}
Number that is the ID of the facility.
companyTypeId
{{companyTypeId}}
Number that is the ID that is 1 for Client and 2 for Maintenance company type.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/companies?companyTypeId=2&facilityId=2
Example Response
200 - OK
[
{
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108,
"address": {
"id": 108,
"formattedAddress": "3528 Lucinda Vista",
"postalCode": "88358",
"city": "Jonathanbury",
"state": "Arizona",
"country": "Bosnia and Herzegovina",
"latitude": "-57.454500",
"longitude": "-70.554300",
"createdAt": "2020-06-03T14:10:48.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": 44
},
"categories": [
{
"id": 55,
"createdAt": "2020-10-21T10:43:55.000Z",
"creatorId": 44,
"companyId": 6,
"categoryId": 1,
"facilityId": 2,
"category": {
"id": 1,
"name": "ELECTRICIDAD",
"parentCategoryId": null
}
},
{
"id": 57,
"createdAt": "2020-10-21T10:43:55.000Z",
"creatorId": 44,
"companyId": 6,
"categoryId": 25,
"facilityId": 2,
"category": {
"id": 25,
"name": "SANEAMIENTO",
"parentCategoryId": null
}
},
{
"id": 59,
"createdAt": "2020-10-21T10:43:55.000Z",
"creatorId": 44,
"companyId": 6,
"categoryId": 63,
"facilityId": 2,
"category": {
"id": 63,
"name": "MOBILIARIO",
"parentCategoryId": null
}
},
{
"id": 60,
"createdAt": "2020-10-21T10:43:55.000Z",
"creatorId": 44,
"companyId": 6,
"categoryId": 84,
"facilityId": 2,
"category": {
"id": 84,
"name": "OTROS",
"parentCategoryId": null
}
},
{
"id": 56,
"createdAt": "2020-10-21T10:43:55.000Z",
"creatorId": 44,
"companyId": 6,
"categoryId": 17,
"facilityId": 2,
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
},
{
"id": 58,
"createdAt": "2020-10-21T10:43:55.000Z",
"creatorId": 44,
"companyId": 6,
"categoryId": 59,
"facilityId": 2,
"category": {
"id": 59,
"name": "EQUIPAMIENTO INFORMÁTICO",
"parentCategoryId": null
}
},
{
"id": 61,
"createdAt": "2020-10-21T10:43:55.000Z",
"creatorId": 44,
"companyId": 6,
"categoryId": 69,
"facilityId": 2,
"category": {
"id": 69,
"name": "ELEMENTOS CONSTRUCTIVOS",
"parentCategoryId": null
}
}
],
"types": [
{
"id": 6,
"createdAt": "2020-06-03T16:42:46.000Z",
"creatorId": 1,
"companyId": 6,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
],
"companyFacilityTypes": [
{
"id": 24,
"createdAt": "2020-09-14T10:32:17.000Z",
"updatedAt": "2020-09-14T10:32:17.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"facilityId": 2,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
},
{
"id": 1,
"cif": "B86142510",
"name": "Propiedad SL",
"createdAt": "2020-06-03T05:10:05.000Z",
"updatedAt": "2020-10-20T10:25:56.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 103,
"address": {
"id": 103,
"formattedAddress": "8129 Tressa Tunnel",
"postalCode": "49531-7890",
"city": "New Oswaldo",
"state": "Florida",
"country": "Norway",
"latitude": "-70.054700",
"longitude": "-2.047300",
"createdAt": "2020-06-03T00:52:27.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": 44
},
"categories": [
{
"id": 52,
"createdAt": "2020-10-20T10:25:56.000Z",
"creatorId": 44,
"companyId": 1,
"categoryId": 59,
"facilityId": 2,
"category": {
"id": 59,
"name": "EQUIPAMIENTO INFORMÁTICO",
"parentCategoryId": null
}
},
{
"id": 53,
"createdAt": "2020-10-20T10:25:56.000Z",
"creatorId": 44,
"companyId": 1,
"categoryId": 63,
"facilityId": 2,
"category": {
"id": 63,
"name": "MOBILIARIO",
"parentCategoryId": null
}
},
{
"id": 54,
"createdAt": "2020-10-20T10:25:56.000Z",
"creatorId": 44,
"companyId": 1,
"categoryId": 84,
"facilityId": 2,
"category": {
"id": 84,
"name": "OTROS",
"parentCategoryId": null
}
},
{
"id": 51,
"createdAt": "2020-10-20T10:25:56.000Z",
"creatorId": 44,
"companyId": 1,
"categoryId": 10,
"facilityId": 2,
"category": {
"id": 10,
"name": "CLIMATIZACIÓN, CALEFACCIÓN Y ACS",
"parentCategoryId": null
}
},
{
"id": 50,
"createdAt": "2020-10-20T10:25:56.000Z",
"creatorId": 44,
"companyId": 1,
"categoryId": 17,
"facilityId": 2,
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
}
],
"types": [
{
"id": 1,
"createdAt": "2020-06-03T12:22:13.000Z",
"creatorId": 1,
"companyId": 1,
"companyTypeId": 1,
"companyType": {
"id": 1,
"name": "CLIENTE"
}
},
{
"id": 11,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
],
"companyFacilityTypes": [
{
"id": 23,
"createdAt": "2020-09-14T09:47:52.000Z",
"updatedAt": "2020-09-14T09:47:52.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"facilityId": 2,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
},
{
"id": 5,
"cif": "B66694764",
"name": "Empresa 4 Mantenimiento",
"createdAt": "2020-06-03T03:42:30.000Z",
"updatedAt": "2020-06-04T00:00:14.000Z",
"creatorId": 1,
"updatorId": null,
"addressId": 107,
"address": {
"id": 107,
"formattedAddress": "91017 Kelly Rest",
"postalCode": "97094-1374",
"city": "North Grady",
"state": "Illinois",
"country": "Rwanda",
"latitude": "20.312200",
"longitude": "168.419000",
"createdAt": "2020-06-03T17:05:43.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": null
},
"categories": [],
"types": [
{
"id": 5,
"createdAt": "2020-06-03T02:24:34.000Z",
"creatorId": 1,
"companyId": 5,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
],
"companyFacilityTypes": [
{
"id": 7,
"createdAt": "2020-06-03T14:39:56.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 5,
"facilityId": 2,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
},
{
"id": 10,
"cif": "B65036237",
"name": "Empresa 9 Mantenimiento",
"createdAt": "2020-06-03T03:23:36.000Z",
"updatedAt": "2020-06-04T00:00:14.000Z",
"creatorId": 1,
"updatorId": null,
"addressId": 112,
"address": {
"id": 112,
"formattedAddress": "94505 Hettinger Mountain",
"postalCode": "44833-8703",
"city": "Vandervortland",
"state": "Texas",
"country": "Somalia",
"latitude": "-48.940400",
"longitude": "33.865900",
"createdAt": "2020-06-03T21:49:56.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": null
},
"categories": [],
"types": [
{
"id": 10,
"createdAt": "2020-06-03T18:00:42.000Z",
"creatorId": 1,
"companyId": 10,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
],
"companyFacilityTypes": [
{
"id": 14,
"createdAt": "2020-06-03T07:38:22.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 10,
"facilityId": 2,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
},
{
"id": 8,
"cif": "B24714359",
"name": "Empresa 7 Mantenimiento",
"createdAt": "2020-06-03T15:10:10.000Z",
"updatedAt": "2020-06-04T00:00:14.000Z",
"creatorId": 1,
"updatorId": null,
"addressId": 110,
"address": {
"id": 110,
"formattedAddress": "2062 Nikolaus Fall",
"postalCode": "89504",
"city": "Heathland",
"state": "Kansas",
"country": "Finland",
"latitude": "26.425500",
"longitude": "-103.573900",
"createdAt": "2020-06-03T11:14:16.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": null
},
"categories": [],
"types": [
{
"id": 8,
"createdAt": "2020-06-03T02:16:23.000Z",
"creatorId": 1,
"companyId": 8,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
],
"companyFacilityTypes": [
{
"id": 11,
"createdAt": "2020-06-03T21:17:17.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 8,
"facilityId": 2,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
}
]
GET
Not In Facility
https://{{host}}:{{port}}/api/companies/not-in-facility?facilityId={{facilityId}}&companyTypeId={{companyTypeId}}&page=1&limit=10&sortBy=companyType&order=DESC
Gets the companies that are NOT related to the facility. Either as client or maintenance.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
companyTypeId
{{companyTypeId}}
Number that is the ID of the company.
page
1
Number of the page.
limit
10
Number of elements per page.
sortBy
companyType
String that is the name of the field of the table to order by the result.
order
DESC
String that indicates the order or the records DESC or ASC.
name
text
String to filter by name of the company.
cif
text
String to filter by CIF of the company.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/companies/not-in-facility?facilityId={{facilityId}}&companyTypeId={{companyTypeId}}&page=1&limit=10&sortBy=companyType&order=DESC
Example Response
200 - OK
{
"items": [
{
"id": 5,
"cif": "B66694764",
"name": "Empresa 4 Mantenimiento",
"createdAt": "2020-06-03T03:42:30.000Z",
"updatedAt": "2020-06-04T00:00:14.000Z",
"creatorId": 1,
"updatorId": null,
"addressId": 107,
"types": [
{
"id": 5,
"createdAt": "2020-06-03T02:24:34.000Z",
"creatorId": 1,
"companyId": 5,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
},
{
"id": 8,
"cif": "B24714359",
"name": "Empresa 7 Mantenimiento",
"createdAt": "2020-06-03T15:10:10.000Z",
"updatedAt": "2020-06-04T00:00:14.000Z",
"creatorId": 1,
"updatorId": null,
"addressId": 110,
"types": [
{
"id": 8,
"createdAt": "2020-06-03T02:16:23.000Z",
"creatorId": 1,
"companyId": 8,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
},
{
"id": 10,
"cif": "B65036237",
"name": "Empresa 9 Mantenimiento",
"createdAt": "2020-06-03T03:23:36.000Z",
"updatedAt": "2020-06-04T00:00:14.000Z",
"creatorId": 1,
"updatorId": null,
"addressId": 112,
"types": [
{
"id": 10,
"createdAt": "2020-06-03T18:00:42.000Z",
"creatorId": 1,
"companyId": 10,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
]
}
],
"meta": {
"totalItems": 3,
"itemCount": 3,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
GET
In Facility
https://{{host}}:{{port}}/api/companies/in-facility?facilityId={{facilityId}}
Gets the companies that are related to the facility. Either as client or maintenance.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of the page.
limit
10
Number of elements per page.
sortBy
companyType
String that is the name of the field of the table to order by the result.
order
DESC
String that indicates the order or the records DESC or ASC.
cif
text
String to filter by CIF of the company.
name
text
String to filter by name of the company.
companyTypeId
{{companyTypeId}}
Number that is the ID of the company.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/companies/in-facility?facilityId={{facilityId}}
GET
One
https://{{host}}:{{port}}/api/companies/{{companyId}}
Gets the company indicated in the param that is the company ID.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/companies/{{companyId}}
Example Response
200 - OK
{
"id": 16,
"cif": "AS2323",
"name": "Mantenimiento LTD",
"createdAt": "2021-03-26T08:59:37.000Z",
"updatedAt": "2021-03-26T08:59:51.000Z",
"creatorId": 44,
"updatorId": 44,
"addressId": 304,
"address": {
"id": 304,
"formattedAddress": "Calle de Montalbán, 3, 28014 Madrid, España",
"postalCode": "28014",
"city": "Madrid",
"state": "Madrid",
"country": "España",
"latitude": "40.418279",
"longitude": "-3.691038",
"createdAt": "2021-03-26T08:59:37.000Z",
"updatedAt": "2021-03-26T08:59:37.000Z",
"creatorId": 44,
"updatorId": 44
},
"categories": [],
"types": [
{
"id": 18,
"createdAt": "2021-03-26T08:59:37.000Z",
"creatorId": 44,
"companyId": 16,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
],
"companyContacts": [
{
"id": 23,
"name": "pepe",
"description": null,
"email": "",
"phone": "987654321",
"createdAt": "2021-03-26T08:59:51.000Z",
"updatedAt": "2021-03-26T08:59:51.000Z",
"creatorId": 44,
"updatorId": null,
"companyOwnerId": 1,
"companyFromId": 16
}
]
}
POST
Create
https://{{host}}:{{port}}/api/companies?facilityId={{facilityId}}
Creates a company and a relation with the facility indicated in the query param.
The typeId of a company could be 1 for client type or 2 for maintenance type.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"cif": "ASD123456",
"name": "Compañía de prueba",
"typesId": [1, 2],
"categoriesId": [1],
"address": {
"city": "Rivas-Vaciamadrid",
"country": "España",
"formattedAddress": "Paseo de Capa Negra, 6, 28522 Rivas-Vaciamadrid, Madrid, España",
"latitude": 40.35319,
"longitude": -3.5393289,
"postalCode": "28522",
"state": "Madrid"
},
"contacts": [
{
"name": "Contact Name",
"email": "acontactname@gmail.com",
"phone": "654321000"
},
{
"name": "Another Contact Name",
"email": "anothercontactname@gmail.com",
"phone": "654321000"
}
]
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/companies?facilityId={{facilityId}}
{
"cif": "ASD123456",
"name": "Compañía de prueba",
"typesId": [1, 2],
"categoriesId": [1],
"address": {
"city": "Rivas-Vaciamadrid",
"country": "España",
"formattedAddress": "Paseo de Capa Negra, 6, 28522 Rivas-Vaciamadrid, Madrid, España",
"latitude": 40.35319,
"longitude": -3.5393289,
"postalCode": "28522",
"state": "Madrid"
},
"contacts": [
{
"name": "Contact Name",
"email": "acontactname@gmail.com",
"phone": "654321000"
},
{
"name": "Another Contact Name",
"email": "anothercontactname@gmail.com",
"phone": "654321000"
}
]
}
PATCH
Edit
https://{{host}}:{{port}}/api/companies/{{companyId}}?facilityId={{facilityId}}
Updates the information about the company indicated in the param that is the company ID. The user must have a role in the facility indicated in the query param facilityId.
Only an administrator role of the company or a superior role can update a company.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"cif": "B86142511",
"name": "Propiedad SL",
"typesId": [1,2],
"categoriesId": [1, 10, 17, 25, 30, 51, 59, 63, 84, 69],
"address": {
"id": 201,
"city": "Rivas-Vaciamadrid2",
"country": "España2",
"formattedAddress": "Paseo de Capa Negra, 6, 28522 Rivas-Vaciamadrid, Madrid, España2",
"latitude": 40.353192,
"longitude": -3.53932892,
"postalCode": "285222",
"state": "Madrid2"
},
"contacts": [
{
"name": "A Contact Name",
"email": "acontactname@gmail.com",
"phone": "654321000"
},
{
"name": "Another Contact Name",
"email": "anothercontactname@gmail.com",
"phone": "654321000"
},
{
"name": "Another Contact Name2",
"email": "anothercontactname2@gmail.com",
"phone": "6543210002"
},
{
"name": "Another Contact Name3",
"email": "anothercontactname3@gmail.com",
"phone": "6543210003"
}
]
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/companies/{{companyId}}?facilityId={{facilityId}}
{
"cif": "B86142511",
"name": "Propiedad SL",
"typesId": [1,2],
"categoriesId": [1, 10, 17, 25, 30, 51, 59, 63, 84, 69],
"address": {
"id": 201,
"city": "Rivas-Vaciamadrid2",
"country": "España2",
"formattedAddress": "Paseo de Capa Negra, 6, 28522 Rivas-Vaciamadrid, Madrid, España2",
"latitude": 40.353192,
"longitude": -3.53932892,
"postalCode": "285222",
"state": "Madrid2"
},
"contacts": [
{
"name": "A Contact Name",
"email": "acontactname@gmail.com",
"phone": "654321000"
},
{
"name": "Another Contact Name",
"email": "anothercontactname@gmail.com",
"phone": "654321000"
},
{
"name": "Another Contact Name2",
"email": "anothercontactname2@gmail.com",
"phone": "6543210002"
},
{
"name": "Another Contact Name3",
"email": "anothercontactname3@gmail.com",
"phone": "6543210003"
}
]
}
Example Response
200 - OK
{
"id": 1,
"cif": "B86142511",
"name": "Propiedad SL",
"createdAt": "2020-06-03T05:10:05.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 1,
"updatorId": 209,
"addressId": 103,
"address": {
"id": 103,
"formattedAddress": "8129 Tressa Tunnel",
"postalCode": "49531-7890",
"city": "New Oswaldo",
"state": "Florida",
"country": "Norway",
"latitude": "-70.054700",
"longitude": "-2.047300",
"createdAt": "2020-06-03T00:52:27.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": 44
},
"categories": [
{
"id": 34,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 1,
"facilityId": 1,
"category": {
"id": 1,
"name": "ELECTRICIDAD",
"parentCategoryId": null
}
},
{
"id": 35,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 10,
"facilityId": 1,
"category": {
"id": 10,
"name": "CLIMATIZACIÓN, CALEFACCIÓN Y ACS",
"parentCategoryId": null
}
},
{
"id": 36,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 17,
"facilityId": 1,
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
},
{
"id": 37,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 25,
"facilityId": 1,
"category": {
"id": 25,
"name": "SANEAMIENTO",
"parentCategoryId": null
}
},
{
"id": 38,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 30,
"facilityId": 1,
"category": {
"id": 30,
"name": "REDES TELECOMUNICACIONES",
"parentCategoryId": null
}
},
{
"id": 40,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 51,
"facilityId": 1,
"category": {
"id": 51,
"name": "VENTILACIÓN Y EXTRACCIÓN",
"parentCategoryId": null
}
},
{
"id": 43,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 59,
"facilityId": 1,
"category": {
"id": 59,
"name": "EQUIPAMIENTO INFORMÁTICO",
"parentCategoryId": null
}
},
{
"id": 41,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 63,
"facilityId": 1,
"category": {
"id": 63,
"name": "MOBILIARIO",
"parentCategoryId": null
}
},
{
"id": 42,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 69,
"facilityId": 1,
"category": {
"id": 69,
"name": "ELEMENTOS CONSTRUCTIVOS",
"parentCategoryId": null
}
},
{
"id": 45,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"categoryId": 84,
"facilityId": 1,
"category": {
"id": 84,
"name": "OTROS",
"parentCategoryId": null
}
}
],
"types": [
{
"id": 1,
"createdAt": "2020-06-03T12:22:13.000Z",
"creatorId": 1,
"companyId": 1,
"companyTypeId": 1,
"companyType": {
"id": 1,
"name": "CLIENTE"
}
},
{
"id": 11,
"createdAt": "2020-06-04T13:35:32.000Z",
"creatorId": 1,
"companyId": 1,
"companyTypeId": 2,
"companyType": {
"id": 2,
"name": "MANTENIMIENTO"
}
}
],
"companyContacts": [
{
"id": 25,
"name": "A Contact Name",
"description": null,
"email": "acontactname@gmail.com",
"phone": "654321000",
"createdAt": "2022-12-20T17:25:25.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 209,
"updatorId": null,
"companyOwnerId": 1,
"companyFromId": 1
},
{
"id": 26,
"name": "Another Contact Name",
"description": null,
"email": "anothercontactname@gmail.com",
"phone": "654321000",
"createdAt": "2022-12-20T17:25:25.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 209,
"updatorId": null,
"companyOwnerId": 1,
"companyFromId": 1
},
{
"id": 27,
"name": "Another Contact Name2",
"description": null,
"email": "anothercontactname2@gmail.com",
"phone": "6543210002",
"createdAt": "2022-12-20T17:25:25.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 209,
"updatorId": null,
"companyOwnerId": 1,
"companyFromId": 1
},
{
"id": 28,
"name": "Another Contact Name3",
"description": null,
"email": "anothercontactname3@gmail.com",
"phone": "6543210003",
"createdAt": "2022-12-20T17:25:25.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 209,
"updatorId": null,
"companyOwnerId": 1,
"companyFromId": 1
}
]
}
GET
Users
https://{{host}}:{{port}}/api/companies/{{companyId}}/users?roleId={{roleId}}&facilityId={{facilityId}}
Gets all the users of the company that have a role in the facility indicated in the query param.
PARAMS
roleId
{{roleId}}
Number to filter by role id of user.
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/companies/{{companyId}}/users?roleId={{roleId}}&facilityId={{facilityId}}
Example Response
200 - OK
[
{
"id": 209,
"email": "propietario@propiedad.com",
"name": "Propietario",
"surname": "Propiedad",
"mobile": null,
"photo": null,
"isSuperAdmin": false,
"createdAt": "2021-06-03T09:33:38.000Z",
"updatedAt": "2021-06-03T09:33:38.000Z",
"creatorId": 44,
"updatorId": null,
"companyId": 1,
"addressId": null
}
]
GET
All
https://{{host}}:{{port}}/api/company-types
Gets the two records about types of company. Client and Maintenance.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/company-types
Example Response
200 - OK
[
{
"id": 1,
"name": "CLIENTE"
},
{
"id": 2,
"name": "MANTENIMIENTO"
}
]
GET
One (by Id)
https://{{host}}:{{port}}/api/components/{{componentId}}?facilityId={{facilityId}}
Gets the information about the component, also its space, floor, component type, and the number of incidences, service request, scheduled task by componentId as param.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/{{componentId}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1,
"space": {
"id": 1,
"name": "Acceso Exterior",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "13.5700",
"netArea": "13.5700",
"volume": "33.9250",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 1,
"floorId": 1,
"floor": {
"id": 1,
"name": "Planta +1",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-0000068f",
"elevation": "3.3000",
"height": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 5,
"facilityId": 1
}
},
"type": {
"id": 77,
"name": "Cubo_Cubo",
"description": "Cubo_Cubo",
"modelNumber": null,
"modelReference": null,
"warrantyDurationParts": null,
"warrantyDurationLabor": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bb8",
"replacementCost": null,
"expectedLife": null,
"warrantyDescription": null,
"nominalHeight": null,
"nominalLength": null,
"nominalWidth": null,
"shape": null,
"size": null,
"color": null,
"finish": null,
"grade": null,
"material": null,
"constituents": null,
"features": null,
"accessibilityPerformance": null,
"codePerformance": null,
"sustainabilityPerformance": null,
"company": null,
"warrantyGuarantorLabor": null,
"warrantyGuarantorParts": null,
"createdAt": "2019-02-22T12:14:21.000Z",
"creatorId": 2,
"manufacturerId": null,
"warrantyDurationUnitId": null,
"expectedLifeUnitId": null,
"facilityId": 1
},
"incidencesCount": "2",
"serviceRequestsCount": "0",
"tasksCount": "0"
}
GET
One (by externalIdentifier)
https://{{host}}:{{port}}/api/components/{{externalIdentifier}}?facilityId={{facilityId}}
Gets the information about the component, also its space, floor, component type, and the number of incidences, service request, scheduled task by externalIdentifier as param.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/{{externalIdentifier}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1,
"space": {
"id": 1,
"name": "Acceso Exterior",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "13.5700",
"netArea": "13.5700",
"volume": "33.9250",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 1,
"floorId": 1,
"floor": {
"id": 1,
"name": "Planta +1",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-0000068f",
"elevation": "3.3000",
"height": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 5,
"facilityId": 1
}
},
"type": {
"id": 77,
"name": "Cubo_Cubo",
"description": "Cubo_Cubo",
"modelNumber": null,
"modelReference": null,
"warrantyDurationParts": null,
"warrantyDurationLabor": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bb8",
"replacementCost": null,
"expectedLife": null,
"warrantyDescription": null,
"nominalHeight": null,
"nominalLength": null,
"nominalWidth": null,
"shape": null,
"size": null,
"color": null,
"finish": null,
"grade": null,
"material": null,
"constituents": null,
"features": null,
"accessibilityPerformance": null,
"codePerformance": null,
"sustainabilityPerformance": null,
"company": null,
"warrantyGuarantorLabor": null,
"warrantyGuarantorParts": null,
"createdAt": "2019-02-22T12:14:21.000Z",
"creatorId": 2,
"manufacturerId": null,
"warrantyDurationUnitId": null,
"expectedLifeUnitId": null,
"facilityId": 1
},
"incidencesCount": "2",
"serviceRequestsCount": "0",
"tasksCount": "0"
}
PATCH
Edit (by id)
https://{{host}}:{{port}}/api/components/{{componentId}}?facilityId={{facilityId}}
Updates some of the data of a component. Only can be modified assetIdentifier, description, serialNumber, installatedOn, warrantyStartOn and replaceOn.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"description": "A",
"serialNumber": "B",
"installatedOn": "2020-01-01T00:00:00.000Z",
"warrantyStartOn": "2020-01-01T00:00:00.000Z",
"replacedOn": "2020-01-01T00:00:00.000Z",
"assetIdentifier": "C"
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/{{componentId}}?facilityId={{facilityId}}
{
"description": "A",
"serialNumber": "B",
"installatedOn": "2020-01-01T00:00:00.000Z",
"warrantyStartOn": "2020-01-01T00:00:00.000Z",
"replacedOn": "2020-01-01T00:00:00.000Z",
"assetIdentifier": "C"
}
PATCH
Edit (by externalIdentifier)
https://{{host}}:{{port}}/api/components/{{externalIdentifier}}?facilityId={{facilityId}}
Updates some of the data of a component. Only can be modified assetIdentifier, description, serialNumber, installatedOn, warrantyStartOn and replaceOn.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"description": "D",
"serialNumber": "E",
"installatedOn": "2020-02-01T00:00:00.000Z",
"warrantyStartOn": "2020-02-01T00:00:00.000Z",
"assetIdentifier": "F"
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/{{externalIdentifier}}?facilityId={{facilityId}}
{
"description": "D",
"serialNumber": "E",
"installatedOn": "2020-02-01T00:00:00.000Z",
"warrantyStartOn": "2020-02-01T00:00:00.000Z",
"assetIdentifier": "F"
}
PATCH
Edit (Upload CSV)
https://{{host}}:{{port}}/api/components/csv?facilityId={{facilityId}}
Only can be modified assetIdentifier, description, serialNumber, installatedOn, warrantyStartOn and replaceOn. The rest of the fields will be ignored. It is necessary to indicate the ID of the component.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY formdata
file
None
Path of the CSV file to update the components.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/csv?facilityId={{facilityId}}
POST
Filter
https://{{host}}:{{port}}/api/components/filter?facilityId={{facilityId}}&page=1&limit=10
Gets a list of components that match the filter in the request body using inclusive and exclusive conditions. For every field you can use an array of values. And the fields that are allowed to use are:
- assetIdentifier to filter by a String that match the assetIdentifier field.
- name to filter by a String that match the component name.
- floor to filter by a String that match the name of the floor where the component is located.
- space to filter by a String that match the name of the space where the component is located.
- type to filter by a String that match the name of the component type.
The values must be nested in the inclusiveFilters or exclusiveFilters clauses inside the request body.
inclusiveFilters means that the filter searches for the rows that match the criteria, whereas exclusiveFilters excludes the rows that match the criteria. Between fields there is used an AND condition whereas between the values in the array of the field is used an OR condition.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of the page.
limit
10
Number of elements per page.
BODY raw
{
"inclusiveFilters": [
{
"assetIdentifier": [
"00B", "00A"
],
"name":[
"silla", "mesa"
]
}
],
"exclusiveFilters": [
{
"space" : [
"despacho"
],
"floor" :[
"-"
],
"type": [
"reclinable"
]
}
]
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/filter?facilityId={{facilityId}}&page=1&limit=10
{
"inclusiveFilters": [
{
"assetIdentifier": [
"00B", "00A"
],
"name":[
"silla", "mesa"
]
}
],
"exclusiveFilters": [
{
"space" : [
"despacho"
],
"floor" :[
"-"
],
"type": [
"reclinable"
]
}
]
}
Example Response
200 - OK
{
"items": [
{
"id": 2672,
"name": "Silla-Apilable | Silla-Apilable | 536586",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Mobiliario",
"externalIdentifier": "416865d9-5524-421f-9e3b-e71f5b343ec4-0008300a",
"serialNumber": "343ec4-8300a",
"installatedOn": "2020-02-01T23:00:00.000Z",
"warrantyStartOn": "2020-02-01T23:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "0008300A",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"updatedAt": "2020-10-13T09:20:42.000Z",
"creatorId": 2,
"spaceId": 15,
"typeId": 27,
"facilityId": 1,
"space": {
"id": 15,
"name": "Aula 06",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bd7",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "49.8991",
"netArea": "49.8991",
"volume": "124.7477",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 1,
"floorId": 3,
"floor": {
"id": 3,
"name": "Planta Baja",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-000003a5",
"elevation": "0.0000",
"height": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 5,
"facilityId": 1
}
},
"type": {
"id": 27,
"name": "Silla-Apilable_Silla-Apilable",
"description": "Silla-Apilable_Silla-Apilable",
"modelNumber": null,
"modelReference": null,
"warrantyDurationParts": null,
"warrantyDurationLabor": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Mobiliario",
"externalIdentifier": "71051b76-1967-4b81-81c4-33b09cb7cdc3-0007211c",
"replacementCost": null,
"expectedLife": null,
"warrantyDescription": null,
"nominalHeight": null,
"nominalLength": null,
"nominalWidth": null,
"shape": null,
"size": null,
"color": null,
"finish": null,
"grade": null,
"material": null,
"constituents": null,
"features": null,
"accessibilityPerformance": null,
"codePerformance": null,
"sustainabilityPerformance": null,
"company": null,
"warrantyGuarantorLabor": null,
"warrantyGuarantorParts": null,
"createdAt": "2019-02-22T11:14:21.000Z",
"creatorId": 2,
"manufacturerId": null,
"warrantyDurationUnitId": null,
"expectedLifeUnitId": null,
"facilityId": 1
}
}
],
"meta": {
"totalItems": 1,
"itemCount": 1,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
POST
Filtered
https://{{host}}:{{port}}/api/components/filtered?facilityId={{facilityId}}&page=1&limit=10
Gets a list of components that are paginated and filter by the request body.
The filter are specified in the body. The fields for filtering are:
- floors, to filter by a String that match the floor name.
- spaces, to filter by a String that match the space name.
- types, to filter by a String that match the name of the component type.
- names, to filter by a String that match the component name.
- assetIdentifier, to filter by a String that match the assetIdentifier (also referred as code) or the externalIdentifier.
Fields in the filter body have arrays of Strings that are treated as OR conditions if it is about the same field but as AND condition if it is about a different field.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of the page.
limit
10
Number of elements per page.
sortBy
floorName
String that could be floorName, spaceName, componentTypeName, facilityName, ids, or any name of a field of the component structure.
order
DESC
String that indicates the order or the records DESC or ASC.
BODY raw
{
"floors": ["sotano"],
"spaces": ["ascensor"],
"types": [],
"names": [],
"assetIdentifiers": ["00A", "BB"]
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/filtered?facilityId={{facilityId}}&page=1&limit=10&sortBy=floorName&order=DESC
{
"floors": ["sotano"],
"spaces": ["ascensor"],
"types": [],
"names": [],
"assetIdentifiers": ["00A", "BB"]
}
Example Response
200 - OK
{
"items": [
{
"id": 8,
"name": "Ascensor S-1",
"description": "Descripción del componente",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bf4",
"serialNumber": "d14fcd-a5bf4",
"installatedOn": "2020-02-01T23:00:00.000Z",
"warrantyStartOn": "2020-02-01T23:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BF4",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"updatedAt": "2020-10-13T09:21:23.000Z",
"creatorId": 2,
"spaceId": 5,
"typeId": 77,
"facilityId": 1,
"type": {
"id": 77,
"name": "Cubo_Cubo",
"description": "Cubo_Cubo",
"modelNumber": null,
"modelReference": null,
"warrantyDurationParts": null,
"warrantyDurationLabor": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bb8",
"replacementCost": null,
"expectedLife": null,
"warrantyDescription": null,
"nominalHeight": null,
"nominalLength": null,
"nominalWidth": null,
"shape": null,
"size": null,
"color": null,
"finish": null,
"grade": null,
"material": null,
"constituents": null,
"features": null,
"accessibilityPerformance": null,
"codePerformance": null,
"sustainabilityPerformance": null,
"company": null,
"warrantyGuarantorLabor": null,
"warrantyGuarantorParts": null,
"createdAt": "2019-02-22T11:14:21.000Z",
"creatorId": 2,
"manufacturerId": null,
"warrantyDurationUnitId": null,
"expectedLifeUnitId": null,
"facilityId": 1
},
"space": {
"id": 5,
"name": "Ascensor S-1",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bf4",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "3.6841",
"netArea": "3.6841",
"volume": "9.2101",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 1,
"floorId": 4,
"floor": {
"id": 4,
"name": "Sótano -1",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "b2395c07-7aa8-43d1-b020-5b0e673c27d2-000269ac",
"elevation": "-3.3000",
"height": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 5,
"facilityId": 1
}
},
"facility": {
"id": 1,
"name": "Colegio Alegra",
"description": "Construccion Colegio Alegra",
"phase": "Construccion",
"category": "Colegio",
"projectName": "Proyecto Colegio Alegra C/Sorolla 4, Majadahonda (Madrid)",
"siteName": "Majadahonda",
"linearUnit": "Meters",
"areaUnit": "Square Meters",
"volumeUnit": "Cubic Meters",
"currencyUnit": "Euro",
"areaMeasurement": "Revit default area calculation method",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalSiteIdentifier": "32c5jt5y91uf6x2dgZS$w_",
"externalSiteObject": "IfcSite",
"externalProjectIdentifier": "32c5jt5y91uf6x2dgZS$wy",
"externalProjectObject": "IfcProject",
"externalFacilityIdentifier": "32c5jt5y91uf6x2dgZS$wz",
"externalFacilityObject": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6YWxlZ3JhL2FsZWdyYS56aXA=",
"viewerId": 1550,
"createdAt": "2020-06-03T21:51:17.000Z",
"updatedAt": "2020-06-19T07:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": null
}
}
],
"meta": {
"totalItems": 1,
"itemCount": 1,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
POST
Filtered (CSV)
https://{{host}}:{{port}}/api/components/filtered/csv?facilityId={{facilityId}}
Gets a list of components that are in a tabular format separated by commas.
The filter are specified in the request body. The fields for filtering are:
- floors, to filter by a String that match the floor name.
- spaces, to filter by a String that match the space name.
- types, to filter by a String that match the name of the component type.
- names, to filter by a String that match the component name.
- assetIdentifier, to filter by a String that match the assetIdentifier (also referred as code) or the externalIdentifier.
Fields in the filter body have arrays of Strings that are treated as OR conditions if it is about the same field but as AND condition if it is about a different field.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"floors": [],
"spaces": [],
"types": [],
"names": ["mesa"],
"assetIdentifiers": []
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/filtered/csv?facilityId={{facilityId}}
{
"floors": [],
"spaces": [],
"types": [],
"names": ["mesa"],
"assetIdentifiers": []
}
Example Response
200 - OK
id,name,description,externalSystem,externalObject,externalIdentifier,serialNumber,installatedOn,warrantyStartOn,replacedOn,barcode,assetIdentifier,area,length,createdAt,updatedAt,creatorId,spaceId,typeId
"1124","Mesa - Redonda | Diámetro 0900 | 495680","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","f10f32eb-47ce-4c39-8c42-6ce7977da023-00079040","7da023-79040","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","79040","","","2019-02-22T11:14:20.000Z","2020-10-13T09:21:09.000Z","2","23","21"
"1125","Mesa - Redonda | Diámetro 0900 | 495693","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","f10f32eb-47ce-4c39-8c42-6ce7977da023-0007904d","7da023-7904d","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007904D","","","2019-02-22T11:14:20.000Z","2020-10-13T09:21:09.000Z","2","23","21"
"1126","Mesa - Redonda | Diámetro 0900 | 495706","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","f10f32eb-47ce-4c39-8c42-6ce7977da023-0007905a","7da023-7905a","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007905A","","","2019-02-22T11:14:20.000Z","2020-10-13T09:21:09.000Z","2","23","21"
"1127","Mesa - Redonda | Diámetro 0900 | 495719","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","f10f32eb-47ce-4c39-8c42-6ce7977da023-00079067","7da023-79067","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","79067","","","2019-02-22T11:14:20.000Z","2020-10-13T09:21:09.000Z","2","23","21"
"1128","Mesa - Redonda | Diámetro 0900 | 495732","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","f10f32eb-47ce-4c39-8c42-6ce7977da023-00079074","7da023-79074","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","79074","","","2019-02-22T11:14:20.000Z","2020-10-13T09:21:09.000Z","2","23","21"
"1105","Mesa - Cristal | Mesa - Cristal Sala Profesores | 507429","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","f78a0d88-277a-4b11-b3af-f888b1740248-0007be25","740248-7be25","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007BE25","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:58.000Z","2","51","20"
"1138","Mesa de café 2 | 0600 x 0900 x 0610 mm | 496553","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","31e0b2aa-8e6c-490f-b62e-3e6002ee4157-000793a9","ee4157-793a9","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000793A9","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:57.000Z","2","55","22"
"1139","Mesa de café 2 | 0600 x 0900 x 0610 mm | 496564","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","31e0b2aa-8e6c-490f-b62e-3e6002ee4157-000793b4","ee4157-793b4","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000793B4","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:57.000Z","2","56","22"
"1148","Mesa-Café | 0700 x 0700 x 0610 mm | 496558","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","31e0b2aa-8e6c-490f-b62e-3e6002ee4157-000793ae","ee4157-793ae","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000793AE","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:57.000Z","2","55","24"
"1149","Mesa-Café | 0700 x 0700 x 0610 mm | 496559","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","31e0b2aa-8e6c-490f-b62e-3e6002ee4157-000793af","ee4157-793af","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000793AF","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:57.000Z","2","56","24"
"1111","Mesa - Redonda | Diámetro 0900 | 477456","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074910","de6341-74910","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","74910","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:51.000Z","2","10","21"
"1112","Mesa - Redonda | Diámetro 0900 | 477478","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074926","de6341-74926","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","74926","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:51.000Z","2","10","21"
"1113","Mesa - Redonda | Diámetro 0900 | 477500","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-0007493c","de6341-7493c","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007493C","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:51.000Z","2","10","21"
"1114","Mesa - Redonda | Diámetro 0900 | 477520","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074950","de6341-74950","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","74950","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:51.000Z","2","10","21"
"1115","Mesa - Redonda | Diámetro 0900 | 477540","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074964","de6341-74964","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","74964","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:51.000Z","2","10","21"
"1144","Mesa hexagonal | 600 x 460 x 600 mm | 536926","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-0008315e","343ec4-8315e","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0008315E","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:49.000Z","2","11","23"
"1145","Mesa hexagonal | 600 x 460 x 600 mm | 536934","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-00083166","343ec4-83166","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","83166","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:49.000Z","2","11","23"
"1140","Mesa hexagonal | 600 x 460 x 600 mm | 509709","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","bbcd6748-70d9-4388-b2ca-06bc8d8ec471-0007c70d","8ec471-7c70d","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007C70D","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:47.000Z","2","12","23"
"1141","Mesa hexagonal | 600 x 460 x 600 mm | 512873","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","d13a58d6-df13-4f09-8863-1314cedb9ea2-0007d369","db9ea2-7d369","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007D369","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:47.000Z","2","12","23"
"1134","Mesa - Redonda | Diámetro 0900 | 536960","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-00083180","343ec4-83180","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","83180","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:46.000Z","2","13","21"
"1135","Mesa - Redonda | Diámetro 0900 | 536980","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-00083194","343ec4-83194","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","83194","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:46.000Z","2","13","21"
"1142","Mesa hexagonal | 600 x 460 x 600 mm | 536455","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-00082f87","343ec4-82f87","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00082F87","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:46.000Z","2","13","23"
"1106","Mesa - Redonda | Diámetro 0900 | 476880","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-000746d0","de6341-746d0","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000746D0","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:45.000Z","2","14","21"
"1107","Mesa - Redonda | Diámetro 0900 | 477241","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074839","de6341-74839","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","74839","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:45.000Z","2","14","21"
"1108","Mesa - Redonda | Diámetro 0900 | 477263","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-0007484f","de6341-7484f","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007484F","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:45.000Z","2","14","21"
"1109","Mesa - Redonda | Diámetro 0900 | 477285","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074865","de6341-74865","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","74865","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:45.000Z","2","14","21"
"1110","Mesa - Redonda | Diámetro 0900 | 477307","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-0007487b","de6341-7487b","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007487B","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:45.000Z","2","14","21"
"1129","Mesa - Redonda | Diámetro 0900 | 536578","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-00083002","343ec4-83002","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","83002","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:44.000Z","2","15","21"
"1130","Mesa - Redonda | Diámetro 0900 | 536600","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-00083018","343ec4-83018","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","83018","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:44.000Z","2","15","21"
"1131","Mesa - Redonda | Diámetro 0900 | 536620","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-0008302c","343ec4-8302c","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0008302C","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:44.000Z","2","15","21"
"1132","Mesa - Redonda | Diámetro 0900 | 536690","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-00083072","343ec4-83072","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","83072","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:41.000Z","2","16","21"
"1133","Mesa - Redonda | Diámetro 0900 | 536761","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-000830b9","343ec4-830b9","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000830B9","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:41.000Z","2","16","21"
"1143","Mesa hexagonal | 600 x 460 x 600 mm | 536666","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","416865d9-5524-421f-9e3b-e71f5b343ec4-0008305a","343ec4-8305a","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0008305A","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:41.000Z","2","16","23"
"1116","Mesa - Redonda | Diámetro 0900 | 477738","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074a2a","de6341-74a2a","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074A2A","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:40.000Z","2","17","21"
"1117","Mesa - Redonda | Diámetro 0900 | 477915","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074adb","de6341-74adb","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074ADB","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:40.000Z","2","17","21"
"1118","Mesa - Redonda | Diámetro 0900 | 477935","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074aef","de6341-74aef","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074AEF","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:40.000Z","2","17","21"
"1119","Mesa - Redonda | Diámetro 0900 | 478043","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074b5b","de6341-74b5b","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074B5B","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:40.000Z","2","17","21"
"1122","Mesa - Redonda | Diámetro 0900 | 478146","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074bc2","de6341-74bc2","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074BC2","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:40.000Z","2","18","21"
"1123","Mesa - Redonda | Diámetro 0900 | 478159","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074bcf","de6341-74bcf","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074BCF","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:40.000Z","2","18","21"
"1120","Mesa - Redonda | Diámetro 0900 | 478107","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074b9b","de6341-74b9b","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074B9B","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:39.000Z","2","18","21"
"1121","Mesa - Redonda | Diámetro 0900 | 478120","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","41c2c467-bfa1-4b28-b6fa-2d797dde6341-00074ba8","de6341-74ba8","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00074BA8","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:39.000Z","2","18","21"
"1104","Mesa - Cristal | Mesa - Cristal Sala Profesores | 506562","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","f78a0d88-277a-4b11-b3af-f888b1740248-0007bac2","740248-7bac2","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","0007BAC2","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:33.000Z","2","50","20"
"1137","Mesa de café 2 | 0600 x 0900 x 0610 mm | 484047","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","61552741-0cc2-4259-9780-299896de110d-000762cf","de110d-762cf","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000762CF","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:32.000Z","2","54","22"
"1147","Mesa-Café | 0700 x 0700 x 0610 mm | 483859","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","61552741-0cc2-4259-9780-299896de110d-00076213","de110d-76213","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","76213","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:32.000Z","2","54","24"
"1136","Mesa de café 2 | 0600 x 0900 x 0610 mm | 482740","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","14a1e6f9-807f-4593-9c96-513636849511-00075db4","849511-75db4","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","00075DB4","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:31.000Z","2","53","22"
"1146","Mesa-Café | 0700 x 0700 x 0610 mm | 483780","","Autodesk Revit 2019, Build: 20180216_1515(x64)","Mobiliario","61552741-0cc2-4259-9780-299896de110d-000761c4","de110d-761c4","2020-02-01T23:00:00.000Z","2020-02-01T23:00:00.000Z","","","000761C4","","","2019-02-22T11:14:20.000Z","2020-10-13T09:20:31.000Z","2","53","24"
POST
Extended Search
https://{{host}}:{{port}}/api/components/extended-search?returnProperty=assetIdentifiers&facilityId={{facilityId}}
Gets a list of elements that are indicated in the returnProperty query param filter by the fields indicated in the request body.
The fields for filtering are:
- floors, to filter by a String that match the floor name.
- spaces, to filter by a String that match the space name.
- types, to filter by a String that match the name of the component type.
- names, to filter by a String that match the component name.
- assetIdentifier, to filter by a String that match the assetIdentifier (also referred as code) or the externalIdentifier.
Fields in the request body have arrays of Strings that are treated as OR conditions if it is about the same field, but as AND condition if it is about a different field.
PARAMS
returnProperty
assetIdentifiers
String that indicates what the result should be. ids, assetIdentifiers, types, floors, spaces. By default component name.
facilityId
{{facilityId}}
Number that is the ID of the facility.
limit
number
Number that is the maximum number of elements to return.
BODY raw
{
"floors": [],
"spaces": ["aula"],
"types": [],
"names": [],
"assetIdentifiers": []
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/components/extended-search?returnProperty=floors&facilityId={{facilityId}}
{
"floors": [],
"spaces": ["aula"],
"types": [],
"names": [],
"assetIdentifiers": []
}
Example Response
200 - OK
[
"Planta Baja",
"Planta +1"
]
GET
All
https://{{host}}:{{port}}/api/component-types?facilityId={{facilityId}}&page=1&limit=10&company=text&sortBy=components&order=DESC
Gets a list of component types paginated and filtered by the query params.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of the page.
limit
10
Number of elements per page.
id
text
Number to filter by ID of the component type.
name
text
String to filter by name of the component type.
modelNumber
text
String to filter by model.
company
text
String to filter by trademark.
sortBy
components
String to indicates the field by which the rows are ordered. Use \"components\" to order by the count of component of the component type, and use \"company\" to order by the trademark.
order
DESC
String to indicates the order ASC or DESC.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/component-types?facilityId={{facilityId}}&page=1&limit=10&company=MARCA&sortBy=components&order=DESC
Example Response
200 - OK
{
"items": [
{
"id": 89,
"name": "Tuberías_Idesie_Acero EDITOOTRA VEZ",
"description": "Tuberías_Idesie_Acero EDITOOTRA VEZ",
"modelNumber": "TUB-009",
"modelReference": null,
"warrantyDurationParts": 20,
"warrantyDurationLabor": 50,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Tuberías",
"externalIdentifier": "no-cambiar",
"replacementCost": "33.2300",
"expectedLife": 100,
"warrantyDescription": null,
"nominalHeight": null,
"nominalLength": null,
"nominalWidth": null,
"shape": null,
"size": null,
"color": null,
"finish": null,
"grade": null,
"material": null,
"constituents": null,
"features": null,
"accessibilityPerformance": null,
"codePerformance": null,
"sustainabilityPerformance": null,
"company": "MARCATUB",
"warrantyGuarantorLabor": "jorge",
"warrantyGuarantorParts": "pepe@tub.com",
"createdAt": "2019-01-28T12:12:12.000Z",
"creatorId": 3,
"manufacturerId": null,
"warrantyDurationUnitId": null,
"expectedLifeUnitId": null,
"facilityId": 1,
"manufacturer": null,
"documents": [
{
"id": 25,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603276562998-Captura de pantalla 2020-10-09 a las 16.23.37.png",
"identifier": "1603276562998-Captura de pantalla 2020-10-09 a las 16.23.37.png",
"createdAt": "2020-10-21T10:36:05.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 26,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603276614669-Captura de pantalla 2019-02-24 a las 11.47.24.png",
"identifier": "1603276614669-Captura de pantalla 2019-02-24 a las 11.47.24.png",
"createdAt": "2020-10-21T10:36:55.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 27,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603289675126-0.jpg",
"identifier": "1603289675126-0.jpg",
"createdAt": "2020-10-21T14:14:36.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 29,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603289846300-0-3.jpg",
"identifier": "1603289846300-0-3.jpg",
"createdAt": "2020-10-21T14:17:27.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 30,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603289952267-EdPolicy Data Privacy Key TakeAways.pdf",
"identifier": "1603289952267-EdPolicy Data Privacy Key TakeAways.pdf",
"createdAt": "2020-10-21T14:19:12.000Z",
"creatorId": 44,
"componentTypeId": 89
}
],
"components": 89
}
],
"meta": {
"totalItems": 1,
"itemCount": 1,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
GET
All (CSV)
https://{{host}}:{{port}}/api/component-types/csv?facilityId={{facilityId}}&company=text
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
id
number
Number to filter by ID of the component type.
name
text
String to filter by name of the component type.
modelNumber
text
String to filter by model.
company
text
String to filter by trademark.
sortBy
components
String to indicates the field by which the rows are ordered. Use \"components\" to order by the count of component of the component type, and use \"company\" to order by the trademark.
order
DESC
String to indicates the order ASC or DESC.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/component-types/csv?facilityId={{facilityId}}&company=text
Example Response
200 - OK
id,name,description,modelNumber,modelReference,warrantyDurationParts,warrantyDurationLabor,externalSystem,externalObject,externalIdentifier,replacementCost,expectedLife,warrantyDescription,nominalHeight,nominalLength,nominalWidth,shape,size,color,finish,grade,material,constituents,features,accessibilityPerformance,codePerformance,sustainabilityPerformance,createdAt,creatorId,manufacturerId,warrantyGuarantorLabor,warrantyGuarantorParts,warrantyDurationUnitId,expectedLifeUnitId,company
GET
One
https://{{host}}:{{port}}/api/component-types/{{componentTypeId}}?facilityId={{facilityId}}
Gets information about the component indicated in the path param.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/component-types/{{componentTypeId}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 89,
"name": "Tuberías_Idesie_Acero EDITOOTRA VEZ",
"description": "Tuberías_Idesie_Acero EDITOOTRA VEZ",
"modelNumber": "TUB-009",
"modelReference": null,
"warrantyDurationParts": 20,
"warrantyDurationLabor": 50,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Tuberías",
"externalIdentifier": "no-cambiar",
"replacementCost": "33.2300",
"expectedLife": 100,
"warrantyDescription": null,
"nominalHeight": null,
"nominalLength": null,
"nominalWidth": null,
"shape": null,
"size": null,
"color": null,
"finish": null,
"grade": null,
"material": null,
"constituents": null,
"features": null,
"accessibilityPerformance": null,
"codePerformance": null,
"sustainabilityPerformance": null,
"company": "MARCATUB",
"warrantyGuarantorLabor": "jorge",
"warrantyGuarantorParts": "pepe@tub.com",
"createdAt": "2019-01-28T12:12:12.000Z",
"creatorId": 3,
"manufacturerId": null,
"warrantyDurationUnitId": null,
"expectedLifeUnitId": null,
"facilityId": 1,
"manufacturer": null,
"documents": [
{
"id": 25,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603276562998-Captura de pantalla 2020-10-09 a las 16.23.37.png",
"identifier": "1603276562998-Captura de pantalla 2020-10-09 a las 16.23.37.png",
"createdAt": "2020-10-21T10:36:05.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 26,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603276614669-Captura de pantalla 2019-02-24 a las 11.47.24.png",
"identifier": "1603276614669-Captura de pantalla 2019-02-24 a las 11.47.24.png",
"createdAt": "2020-10-21T10:36:55.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 27,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603289675126-0.jpg",
"identifier": "1603289675126-0.jpg",
"createdAt": "2020-10-21T14:14:36.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 29,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603289846300-0-3.jpg",
"identifier": "1603289846300-0-3.jpg",
"createdAt": "2020-10-21T14:17:27.000Z",
"creatorId": 44,
"componentTypeId": 89
},
{
"id": 30,
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1603289952267-EdPolicy Data Privacy Key TakeAways.pdf",
"identifier": "1603289952267-EdPolicy Data Privacy Key TakeAways.pdf",
"createdAt": "2020-10-21T14:19:12.000Z",
"creatorId": 44,
"componentTypeId": 89
}
],
"components": 89
}
PATCH
Edit
https://{{host}}:{{port}}/api/component-types/{{componentTypeId}}?facilityId={{facilityId}}
Updates the information about a component type indicated as path param.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "ARQ | Barandillas | Barandilla | Barrotes 222",
"modelNumber": null,
"warrantyDurationParts": 2,
"warrantyDurationUnitId": 1,
"warrantyDurationLabor": null,
"warrantyGuarantorPartsId": 1,
"warrantyGuarantorLaborId": 2,
"replacementCost": null,
"expectedLife": null,
"expectedLifeUnitId": 1
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/component-types/{{componentTypeId}}?facilityId={{facilityId}}
{
"name": "ARQ | Barandillas | Barandilla | Barrotes 222",
"modelNumber": null,
"warrantyDurationParts": 2,
"warrantyDurationUnitId": 1,
"warrantyDurationLabor": null,
"warrantyGuarantorPartsId": 1,
"warrantyGuarantorLaborId": 2,
"replacementCost": null,
"expectedLife": null,
"expectedLifeUnitId": 1
}
PATCH
Edit (CSV)
https://{{host}}:{{port}}/api/component-types/csv?facilityId={{facilityId}}
Updates the information about the component types indicates in the CSV file indicated in the param body.
The reference to identify the component type is its ID.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY formdata
file
None
CSV file to upload to update the information.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/component-types/csv?facilityId={{facilityId}}
POST
Upload Document
https://{{host}}:{{port}}/api/component-types/{{componentTypeId}}/document?facilityId={{facilityId}}
Save a document related to the component type.
The maximum size permitted is 30MiB.
Formats accepted: jpg, jpeg, png, pdf, docx, xlsx, pptx.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY formdata
document
None
File to upload.
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/component-types/{{componentTypeId}}/document?facilityId={{facilityId}}
DELETE
Delete Document
https://{{host}}:{{port}}/api/component-types/{{componentTypeId}}/document/{{documentName}}?facilityId={{facilityId}}
Deletes the file related to the component type.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/component-types/{{componentTypeId}}/document/{{documentName}}?facilityId={{facilityId}}
GET
All
https://{{host}}:{{port}}/api/criticality-levels?facilityId={{facilityId}}
Gets the criticality levels set for the facility indicated as query param.
time is in minutes.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/criticality-levels?facilityId={{facilityId}}
Example Response
200 - OK
[
{
"id": 1,
"name": "Urgente",
"time": 120,
"facilityId": 1
},
{
"id": 2,
"name": "Alta",
"time": 360,
"facilityId": 1
},
{
"id": 3,
"name": "Media",
"time": 1440,
"facilityId": 1
},
{
"id": 4,
"name": "Baja",
"time": 10080,
"facilityId": 1
},
{
"id": 5,
"name": "Muy baja",
"time": 20160,
"facilityId": 1
}
]
POST
Create
https://{{host}}:{{port}}/api/criticality-levels?facilityId={{facilityId}}
Creates a criticality level related to the facility indicated as query param.
You must have to indicate as param body name and time.
name is a String that is used as label.
time is a Number that is stored as minutes.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "Urgent",
"time": 120
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/criticality-levels?facilityId={{facilityId}}
{
"name": "Urgent",
"time": 120
}
PATCH
Edit
https://{{host}}:{{port}}/api/criticality-levels/{{criticalityLevelId}}?facilityId={{facilityId}}
Updates the name or time of the criticality level indicated as path param.
time must be in minutes.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "Urgent_",
"time": 2
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/criticality-levels/{{criticalityLevelId}}?facilityId={{facilityId}}
{
"name": "Urgent_",
"time": 2
}
DELETE
Delete
https://{{host}}:{{port}}/api/criticality-levels/{{criticalityLevelId}}?facilityId={{facilityId}}
Deletes a criticality level indicated as path param. Only is possible if it is not related to a work order.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/criticality-levels/{{criticalityLevelId}}?facilityId={{facilityId}}
GET
Dashboard
https://{{host}}:{{port}}/api/dashboard?facilityId={{facilityId}}&from=2020-02-01&to=2020-02-07&secondFrom=2020-02-08&secondTo=2020-02-14
(Deprecated)
Gets a lists of objects used in the dashboard to give insight about the state of the facility.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
from
2020-02-01
Date in format YYYY-MM-DD
to
2020-02-07
Date in format YYYY-MM-DD
secondFrom
2020-02-08
Date in format YYYY-MM-DD
secondTo
2020-02-14
Date in format YYYY-MM-DD
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/dashboard?facilityId={{facilityId}}&from=2020-02-01&to=2020-02-07&secondFrom=2020-02-08&secondTo=2020-02-14
Example Response
200 - OK
[
{
"value": [
{
"label": "my_active_incidences",
"value": "0",
"day": null
}
],
"id": "myActiveIncidences",
"type": "single",
"value2": [
{
"label": "my_active_incidences",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "my_unreviewed_incidences",
"value": "0",
"day": null
}
],
"id": "myUnreviewedIncidences",
"type": "single",
"value2": [
{
"label": "my_unreviewed_incidences",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "orders_count",
"value": "1",
"day": "2020-02-01"
},
{
"label": "orders_count",
"value": "0",
"day": "2020-02-02"
},
{
"label": "orders_count",
"value": "4",
"day": "2020-02-03"
},
{
"label": "orders_count",
"value": "1",
"day": "2020-02-04"
},
{
"label": "orders_count",
"value": "2",
"day": "2020-02-05"
},
{
"label": "orders_count",
"value": "1",
"day": "2020-02-06"
},
{
"label": "orders_count",
"value": "4",
"day": "2020-02-07"
}
],
"id": "ordersCount",
"type": "series",
"value2": [
{
"label": "orders_count",
"value": "5",
"day": "2020-02-08"
},
{
"label": "orders_count",
"value": "0",
"day": "2020-02-09"
},
{
"label": "orders_count",
"value": "0",
"day": "2020-02-10"
},
{
"label": "orders_count",
"value": "0",
"day": "2020-02-11"
},
{
"label": "orders_count",
"value": "1",
"day": "2020-02-12"
},
{
"label": "orders_count",
"value": "2",
"day": "2020-02-13"
},
{
"label": "orders_count",
"value": "3",
"day": "2020-02-14"
}
]
},
{
"value": [
{
"label": "orders_overtime",
"value": "5",
"day": null
}
],
"id": "ordersOverTime",
"type": "single",
"value2": [
{
"label": "orders_overtime",
"value": "9",
"day": null
}
]
},
{
"value": [
{
"label": "count_type_incidences",
"value": "1",
"day": "2020-02-01"
},
{
"label": "count_type_incidences",
"value": "1",
"day": "2020-02-02"
},
{
"label": "count_type_incidences",
"value": "1",
"day": "2020-02-03"
},
{
"label": "count_type_incidences",
"value": "0",
"day": "2020-02-04"
},
{
"label": "count_type_incidences",
"value": "1",
"day": "2020-02-05"
},
{
"label": "count_type_incidences",
"value": "1",
"day": "2020-02-06"
},
{
"label": "count_type_incidences",
"value": "0",
"day": "2020-02-07"
}
],
"id": "countTypeIncidences",
"type": "series",
"value2": [
{
"label": "count_type_incidences",
"value": "0",
"day": "2020-02-08"
},
{
"label": "count_type_incidences",
"value": "0",
"day": "2020-02-09"
},
{
"label": "count_type_incidences",
"value": "0",
"day": "2020-02-10"
},
{
"label": "count_type_incidences",
"value": "1",
"day": "2020-02-11"
},
{
"label": "count_type_incidences",
"value": "0",
"day": "2020-02-12"
},
{
"label": "count_type_incidences",
"value": "0",
"day": "2020-02-13"
},
{
"label": "count_type_incidences",
"value": "2",
"day": "2020-02-14"
}
]
},
{
"value": [
{
"label": "count_type_petitions",
"value": "1",
"day": "2020-02-01"
},
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-02"
},
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-03"
},
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-04"
},
{
"label": "count_type_petitions",
"value": "1",
"day": "2020-02-05"
},
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-06"
},
{
"label": "count_type_petitions",
"value": "2",
"day": "2020-02-07"
}
],
"id": "countTypePetitions",
"type": "series",
"value2": [
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-08"
},
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-09"
},
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-10"
},
{
"label": "count_type_petitions",
"value": "0",
"day": "2020-02-11"
},
{
"label": "count_type_petitions",
"value": "1",
"day": "2020-02-12"
},
{
"label": "count_type_petitions",
"value": "1",
"day": "2020-02-13"
},
{
"label": "count_type_petitions",
"value": "1",
"day": "2020-02-14"
}
]
},
{
"value": [
{
"label": "unstarted_incidences",
"value": "0",
"day": null
}
],
"id": "unstartedIncidences",
"type": "single",
"value2": [
{
"label": "unstarted_incidences",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "unassigned_incidences",
"value": "0",
"day": null
}
],
"id": "unassignedIncidences",
"type": "single",
"value2": [
{
"label": "unassigned_incidences",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "unfinished_incidences",
"value": "0",
"day": null
}
],
"id": "unfinishedIncidences",
"type": "single",
"value2": [
{
"label": "unfinished_incidences",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "unclosed_incidences",
"value": "0",
"day": null
}
],
"id": "unclosedIncidences",
"type": "single",
"value2": [
{
"label": "unclosed_incidences",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "inprogress_orders",
"value": "0",
"day": null
}
],
"id": "inProgressOrders",
"type": "single",
"value2": [
{
"label": "inprogress_orders",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "waiting_orders",
"value": "0",
"day": null
}
],
"id": "waitingOrders",
"type": "single",
"value2": [
{
"label": "waiting_orders",
"value": "0",
"day": null
}
]
},
{
"value": [
{
"label": "incidence_cost",
"value": "14896.19",
"day": "2020-02-01"
},
{
"label": "incidence_cost",
"value": "36321.42",
"day": "2020-02-02"
},
{
"label": "incidence_cost",
"value": "0.00",
"day": "2020-02-03"
},
{
"label": "incidence_cost",
"value": "44955.82",
"day": "2020-02-04"
},
{
"label": "incidence_cost",
"value": "0.00",
"day": "2020-02-05"
},
{
"label": "incidence_cost",
"value": "13946.68",
"day": "2020-02-06"
},
{
"label": "incidence_cost",
"value": "37456.42",
"day": "2020-02-07"
}
],
"id": "incidenceCost",
"type": "series",
"value2": [
{
"label": "incidence_cost",
"value": "0.00",
"day": "2020-02-08"
},
{
"label": "incidence_cost",
"value": "0.00",
"day": "2020-02-09"
},
{
"label": "incidence_cost",
"value": "16441.43",
"day": "2020-02-10"
},
{
"label": "incidence_cost",
"value": "8366.19",
"day": "2020-02-11"
},
{
"label": "incidence_cost",
"value": "1792.69",
"day": "2020-02-12"
},
{
"label": "incidence_cost",
"value": "10107.04",
"day": "2020-02-13"
},
{
"label": "incidence_cost",
"value": "18563.79",
"day": "2020-02-14"
}
]
},
{
"value": [
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-01"
},
{
"label": "petition_cost",
"value": "15460.32",
"day": "2020-02-02"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-03"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-04"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-05"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-06"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-07"
}
],
"id": "petitionCost",
"type": "series",
"value2": [
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-08"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-09"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-10"
},
{
"label": "petition_cost",
"value": "10181.20",
"day": "2020-02-11"
},
{
"label": "petition_cost",
"value": "12386.79",
"day": "2020-02-12"
},
{
"label": "petition_cost",
"value": "18577.23",
"day": "2020-02-13"
},
{
"label": "petition_cost",
"value": "17644.77",
"day": "2020-02-14"
}
]
}
]
GET
Dashboard By Name
https://{{host}}:{{port}}/api/dashboard/{{dashboardMetric}}?facilityId={{facilityId}}&from=2020-02-01&to=2020-02-07&secondFrom=2020-02-08&secondTo=2020-02-14
Gets a metric that is used in the dashboard of IMBICLOUD. The metric could be simple (a single number) or series (a series of number to the period of time indicated in the query params)
For series it will be:
- days when the period of time is less or equal to 12 weeks.
- weeks when the period of time is less or equal to 48 weeks.
- months when the period of time is less or equal to 576 weeks.
- years when the period of time is greater than 576 weeks.
Metrics to every user:
- myActiveIncidences, number of incidences created by the user who asks.
- myUnreviewedIncidences, number of incidences ready to set a rate but there is no evaluation yet.
Metrics only to Administrators and Owners
- unstartedIncidences, number of incidences in a Created status.
- unassignedIncidences, number of incidences in an Opened status.
- unfinishedIncidences, number of incidences in In Progress status.
- unclosedIncidences, number of incidences in Finished status.
- countTypeIncidences, series of numbers of incidences.
- countTypePetitions, series of numbers of service request (also referred as petitions).
Metrics only to Owners
- incidenceCost, series of numbers about the cost of incidences.
- petitionCost, series of numbers about the cost of service requests.
Metrics only to Administrators, Maintenance Administrators, and Owners.
- waitingOrders, number of work orders in a Created status.
- inProgressOrders, number of work orders in In progress status.
- unassignedOrders, number of work orders that do not have assigned a user to do the work.
- ordersOverTime, number of work orders that overlap the time to be finished according to the time of the criticality level.
- ordersCount, series of numbers of work orders.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
from
2020-02-01
Date in format YYYY-MM-DD
to
2020-02-07
Date in format YYYY-MM-DD
secondFrom
2020-02-08
Date in format YYYY-MM-DD
secondTo
2020-02-14
Date in format YYYY-MM-DD
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/dashboard/{{dashboardMetric}}}}?facilityId={{facilityId}}&from=2020-02-01&to=2020-02-07&secondFrom=2020-02-08&secondTo=2020-02-14
Example Response
200 - OK
{
"value": [
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-01"
},
{
"label": "petition_cost",
"value": "15460.32",
"day": "2020-02-02"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-03"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-04"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-05"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-06"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-07"
}
],
"id": "petitionCost",
"type": "series",
"value2": [
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-08"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-09"
},
{
"label": "petition_cost",
"value": "0.00",
"day": "2020-02-10"
},
{
"label": "petition_cost",
"value": "10181.20",
"day": "2020-02-11"
},
{
"label": "petition_cost",
"value": "12386.79",
"day": "2020-02-12"
},
{
"label": "petition_cost",
"value": "18577.23",
"day": "2020-02-13"
},
{
"label": "petition_cost",
"value": "17644.77",
"day": "2020-02-14"
}
]
}
GET
All
https://{{host}}:{{port}}/api/facilities?page=1&limit=10
Gets a list of facilities that the user can access.
PARAMS
page
1
Number of the page.
limit
10
Number of elements per page.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/facilities?page=1&limit=10
Example Response
200 - OK
{
"items": [
{
"id": 1,
"name": "Colegio Alegra",
"description": "Construccion Colegio Alegra",
"phase": "Construccion",
"category": "Colegio",
"projectName": "Proyecto Colegio Alegra C/Sorolla 4, Majadahonda (Madrid)",
"siteName": "Majadahonda",
"linearUnit": "Meters",
"areaUnit": "Square Meters",
"volumeUnit": "Cubic Meters",
"currencyUnit": "Euro",
"areaMeasurement": "Revit default area calculation method",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalSiteIdentifier": "32c5jt5y91uf6x2dgZS$w_",
"externalSiteObject": "IfcSite",
"externalProjectIdentifier": "32c5jt5y91uf6x2dgZS$wy",
"externalProjectObject": "IfcProject",
"externalFacilityIdentifier": "32c5jt5y91uf6x2dgZS$wz",
"externalFacilityObject": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6YWxlZ3JhL2FsZWdyYS56aXA=",
"viewerId": 1550,
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": null,
"userFacilityRoles": [
{
"id": 213,
"createdAt": "2021-06-03T09:33:38.000Z",
"updatedAt": "2021-06-03T09:33:38.000Z",
"creatorId": 44,
"updatorId": null,
"userId": 209,
"facilityId": 1,
"roleId": 6,
"role": {
"id": 6,
"name": "Propietario",
"description": "Propietario de la instalación",
"createdAt": "2021-12-16T14:43:59.000Z",
"updatedAt": "2021-12-16T14:43:59.000Z",
"creatorId": 1,
"updatorId": null
}
}
]
},
{
"id": 3,
"name": "PV132",
"description": null,
"phase": null,
"category": null,
"projectName": null,
"siteName": null,
"linearUnit": null,
"areaUnit": null,
"volumeUnit": null,
"currencyUnit": null,
"areaMeasurement": null,
"externalSystem": null,
"externalSiteIdentifier": null,
"externalSiteObject": null,
"externalProjectIdentifier": null,
"externalProjectObject": null,
"externalFacilityIdentifier": null,
"externalFacilityObject": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6cmV2aWxsYS9QVjEzMl8yMjA1MTYucnZ0",
"viewerId": 3417,
"createdAt": "2021-04-30T10:11:50.000Z",
"updatedAt": "2021-04-30T10:11:50.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": null,
"userFacilityRoles": [
{
"id": 218,
"createdAt": "2021-12-16T14:45:40.000Z",
"updatedAt": "2021-12-16T14:45:40.000Z",
"creatorId": 1,
"updatorId": null,
"userId": 209,
"facilityId": 3,
"roleId": 6,
"role": {
"id": 6,
"name": "Propietario",
"description": "Propietario de la instalación",
"createdAt": "2021-12-16T14:43:59.000Z",
"updatedAt": "2021-12-16T14:43:59.000Z",
"creatorId": 1,
"updatorId": null
}
}
]
}
],
"meta": {
"totalItems": 2,
"itemCount": 2,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
GET
One
https://{{host}}:{{port}}/api/facilities/{{facilityId}}
Gets the information about the facility. Also the relations with the companies and the users.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/facilities/{{facilityId}}
Example Response
200 - OK
{
"id": 1,
"name": "Colegio Alegra",
"description": "Construccion Colegio Alegra",
"phase": "Construccion",
"category": "Colegio",
"projectName": "Proyecto Colegio Alegra C/Sorolla 4, Majadahonda (Madrid)",
"siteName": "Majadahonda",
"linearUnit": "Meters",
"areaUnit": "Square Meters",
"volumeUnit": "Cubic Meters",
"currencyUnit": "Euro",
"areaMeasurement": "Revit default area calculation method",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalSiteIdentifier": "32c5jt5y91uf6x2dgZS$w_",
"externalSiteObject": "IfcSite",
"externalProjectIdentifier": "32c5jt5y91uf6x2dgZS$wy",
"externalProjectObject": "IfcProject",
"externalFacilityIdentifier": "32c5jt5y91uf6x2dgZS$wz",
"externalFacilityObject": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6YWxlZ3JhL2FsZWdyYS56aXA=",
"viewerId": 1550,
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": null,
"companyFacilityTypes": [
{
"id": 3,
"createdAt": "2020-06-03T10:02:43.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 2,
"facilityId": 1,
"companyTypeId": 1
},
{
"id": 6,
"createdAt": "2020-06-03T19:17:02.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 4,
"facilityId": 1,
"companyTypeId": 2
}
],
"userFacilityRoles": [
{
"id": 43,
"createdAt": "2020-06-03T20:15:57.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"userId": 44,
"facilityId": 1,
"roleId": 1
},
{
"id": 45,
"createdAt": "2020-06-03T15:55:52.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null,
"userId": 46,
"facilityId": 1,
"roleId": 2
},
{
"id": 47,
"createdAt": "2020-06-03T17:48:18.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null,
"userId": 48,
"facilityId": 1,
"roleId": 6
}
]
}
GET
Floors
https://{{host}}:{{port}}/api/facilities/{{facilityId}}/floors
Gets a list of the floors of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/facilities/{{facilityId}}/floors
Example Response
200 - OK
[
{
"id": 1,
"name": "Planta +1",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-0000068f",
"elevation": "3.3000",
"height": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 5,
"facilityId": 1
},
{
"id": 2,
"name": "Planta +2",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "b2395c07-7aa8-43d1-b020-5b0e673c27d2-00026714",
"elevation": "6.7800",
"height": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 5,
"facilityId": 1
},
{
"id": 3,
"name": "Planta Baja",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-000003a5",
"elevation": "0.0000",
"height": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 5,
"facilityId": 1
},
{
"id": 4,
"name": "Sótano -1",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "b2395c07-7aa8-43d1-b020-5b0e673c27d2-000269ac",
"elevation": "-3.3000",
"height": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 5,
"facilityId": 1
}
]
GET
Chats
https://{{host}}:{{port}}/api/facilities/{{facilityId}}/chats
Gets a list of the incidences with the messages unread.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/facilities/{{facilityId}}/chats
Example Response
200 - OK
[
{
"id": 8819,
"topic": "puerta de entrada sucia",
"createdAt": "2022-03-10T17:50:26.000Z",
"updatedAt": "2022-03-10T17:50:26.000Z",
"creatorId": 90,
"facilityId": 1,
"facility": {
"name": "Colegio Alegra"
},
"type": null,
"workOrders": [],
"unreadChats": [
{
"id": 4010,
"text": "Avisado a profesor.",
"type": "USER",
"action": null,
"payload": null,
"createdAt": "2022-03-10T17:50:39.000Z",
"creatorId": 90,
"incidenceId": 8819
}
]
},
{
"id": 8294,
"topic": "Grifo con fuga de agua",
"createdAt": "2020-02-27T15:48:33.000Z",
"updatedAt": "2020-02-27T15:48:33.000Z",
"creatorId": 90,
"facilityId": 1,
"facility": {
"name": "Colegio Alegra"
},
"type": {
"name": "SERVICE_REQUEST"
},
"workOrders": [],
"unreadChats": [
{
"id": 2516,
"text": "Notificado a encargado.",
"type": "USER",
"action": null,
"payload": null,
"createdAt": "2020-10-28T10:21:04.000Z",
"creatorId": 71,
"incidenceId": 8294
},
{
"id": 2652,
"text": "Probando, probando",
"type": "USER",
"action": null,
"payload": null,
"createdAt": "2021-03-26T09:04:33.000Z",
"creatorId": 44,
"incidenceId": 8294
},
{
"id": 3760,
"text": "visto",
"type": "USER",
"action": null,
"payload": null,
"createdAt": "2022-01-21T08:58:41.000Z",
"creatorId": 90,
"incidenceId": 8294
}
]
}
]
PUT
Add Company
https://{{host}}:{{port}}/api/facilities/{{facilityId}}/company
Relates a company with the facility indicated as path param. In the params body it must be companyId and companyTypeIds.
BODY raw
{
"companyId": 2,
"companyTypeIds": [1, 2]
}
Example Request
PUT https://api-dot-imbicloud.nw.r.appspot.com:80/api/facilities/{{facilityId}}/company
{
"companyId": 2,
"companyTypeIds": [1, 2]
}
GET
All
https://{{host}}:{{port}}/api/facility-groups?facilityId={{facilityId}}&page=1&limit=10
Gets a list of groups in the facility.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of the page.
limit
10
Number of elements per page.
name
Grocery
String to filter by name of the group.
id
1
Number to filter by id of the grouop.
sortBy
creatorId
String to indicates by whick filed to order.
order
DESC
String to indicates the order ASC or DESC.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/facility-groups?facilityId={{facilityId}}&page=1&limit=10
Example Response
200 - OK
{
"items": [
{
"id": 12,
"name": "My group",
"createdAt": "2020-11-07T11:23:08.000Z",
"updatedAt": "2020-11-07T11:23:08.000Z",
"creatorId": 44,
"updatorId": null,
"companyFacilityTypeId": 15,
"users": [
{
"id": 111,
"email": "usuariocliente1f1@empresa0cliente.com",
"name": "Usuario",
"surname": "Cliente 30",
"mobile": "201855289",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T15:55:51.000Z",
"updatedAt": "2020-06-04T00:00:16.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 111
},
{
"id": 203,
"email": "mantenimiento@propiedad.com",
"name": "Mantenimiento",
"surname": "Interno",
"mobile": null,
"photo": null,
"isSuperAdmin": false,
"createdAt": "2020-06-05T12:48:47.000Z",
"updatedAt": "2020-09-14T10:03:24.000Z",
"creatorId": 44,
"updatorId": null,
"companyId": 1,
"addressId": null
}
]
}
],
"meta": {
"totalItems": 2,
"itemCount": 1,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
GET
One
https://{{host}}:{{port}}/api/facility-groups/{{facilityGroupId}}?facilityId={{facilityId}}
Gets the information about the facility groups and the users of the group.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/facility-groups/{{facilityGroupId}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 1,
"name": "Grocery",
"createdAt": "2020-06-04T00:00:20.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 68,
"updatorId": null,
"companyFacilityTypeId": 1,
"users": [
{
"id": 47,
"email": "admincliente1f2@empresa0cliente.com",
"name": "Admin",
"surname": "Cliente 6",
"mobile": "506053993",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T09:55:51.000Z",
"updatedAt": "2020-06-04T00:00:15.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 47
},
{
"id": 54,
"email": "admincliente3f2@empresa0cliente.com",
"name": "Admin",
"surname": "Cliente 13",
"mobile": "803627526",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T22:55:40.000Z",
"updatedAt": "2020-06-04T00:00:16.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 54
},
{
"id": 68,
"email": "admincliente5f2@empresa0cliente.com",
"name": "Admin",
"surname": "Cliente 27",
"mobile": "202785600",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T10:21:43.000Z",
"updatedAt": "2020-06-04T00:00:16.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 68
}
],
"companyFacilityType": {
"id": 1,
"createdAt": "2020-06-03T02:04:22.000Z",
"updatedAt": "2020-06-19T09:24:22.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"facilityId": 2,
"companyTypeId": 1
}
}
POST
Create
https://{{host}}:{{port}}/api/facility-groups?facilityId={{facilityId}}
Creates a facility group with the name and users IDs indicates in the body.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "My group",
"users": [26, 42]
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/facility-groups?facilityId={{facilityId}}
{
"name": "My group",
"users": [26, 42]
}
PATCH
Edit
https://{{host}}:{{port}}/api/facility-groups/{{facilityGroupId}}?facilityId={{facilityId}}
Updates either the name of the group or its members.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "Sports2",
"users": [36]
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/facility-groups/{{facilityGroupId}}?facilityId={{facilityId}}
{
"name": "Sports2",
"users": [36]
}
DELETE
Delete
https://{{host}}:{{port}}/api/facility-groups/{{facilityGroupId}}?facilityId={{facilityId}}
Deletes the facility group only if it has no members.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/facility-groups/{{facilityGroupId}}?facilityId={{facilityId}}
GET
One
https://{{host}}:{{port}}/api/floors/{{floorId}}
Gets information about the floor.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/floors/1
Example Response
200 - OK
{
"id": 1,
"name": "Planta +1",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-0000068f",
"elevation": "3.3000",
"height": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 5,
"facilityId": 1
}
GET
Spaces
https://{{host}}:{{port}}/api/floors/{{floorId}}/spaces
Gets the spaces of the floor.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/floors/{{floorId}}/spaces
Example Response
200 - OK
[
{
"id": 1,
"name": "Acceso Exterior",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "13.5700",
"netArea": "13.5700",
"volume": "33.9250",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 1,
"floorId": 1
},
{
"id": 3,
"name": "Ascensor P1",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bf8",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "3.6841",
"netArea": "3.6841",
"volume": "9.2101",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 1,
"floorId": 1
},
{
"id": 6,
"name": "Aseo",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5be6",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "14.7970",
"netArea": "14.7970",
"volume": "36.9925",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 1,
"floorId": 1
}
]
POST
Filtered
https://{{host}}:{{port}}/api/floors/filtered?facilityId={{facilityId}}&page=1&limit=10
Gets information of the floors that match the filters in the body.
The filter are specified in the body. The fields for filtering are:
- floors, to filter by a String that match the floor name.
- spaces, to filter by a String that match the space name.
- types, to filter by a String that match the name of the component type.
- names, to filter by a String that match the component name.
- assetIdentifier, to filter by a String that match the assetIdentifier (also referred as code).
Fields in the filter body have arrays of Strings that are treated as OR conditions if it is about the same field but as AND condition if it is about a different field.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of the page.
limit
10
Number of the elements per page.
BODY raw
{
"floors": [],
"spaces": [],
"types": [],
"names": ["mesa"],
"assetIdentifiers": []
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/floors/filtered?facilityId={{facilityId}}&page=1&limit=10
{
"floors": [],
"spaces": [],
"types": [],
"names": ["mesa"],
"assetIdentifiers": []
}
Example Response
200 - OK
{
"items": [
{
"id": 1,
"name": "Planta +1",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-0000068f",
"elevation": "3.3000",
"height": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 5,
"facilityId": 1
},
{
"id": 3,
"name": "Planta Baja",
"category": "Floor",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Niveles",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-000003a5",
"elevation": "0.0000",
"height": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 5,
"facilityId": 1
}
],
"meta": {
"totalItems": 2,
"itemCount": 2,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
GET
All
https://{{host}}:{{port}}/api/incidences/1/chat-messages?facilityId={{facilityId}}
Gets all messages related to an incidence.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/chat-messages?facilityId={{facilityId}}
Example Response
200 - OK
[
{
"id": 1,
"text": null,
"type": "SYSTEM",
"action": "INCIDENCE_CREATED",
"payload": {
"creator": "Usuario Cliente 9"
},
"createdAt": "2020-06-04T13:41:07.000Z",
"creatorId": null,
"incidenceId": 1,
"creator": null
},
{
"id": 2,
"text": null,
"type": "SYSTEM",
"action": "INCIDENCE_EDITED",
"payload": {
"creator": "Super Administrador"
},
"createdAt": "2020-06-04T13:41:40.000Z",
"creatorId": null,
"incidenceId": 1,
"creator": null
},
{
"id": 3,
"text": null,
"type": "SYSTEM",
"action": "INCIDENCE_EDITED",
"payload": {
"creator": "Super Administrador"
},
"createdAt": "2020-06-04T13:41:51.000Z",
"creatorId": null,
"incidenceId": 1,
"creator": null
},
{
"id": 13,
"text": null,
"type": "SYSTEM",
"action": "INCIDENCE_OPENED",
"payload": {
"creator": "Admin Cliente 30"
},
"createdAt": "2020-06-04T14:30:01.000Z",
"creatorId": null,
"incidenceId": 1,
"creator": null
},
{
"id": 14,
"text": null,
"type": "SYSTEM",
"action": "INCIDENCE_CLOSED",
"payload": {
"creator": "Admin Cliente 30"
},
"createdAt": "2020-06-04T14:30:04.000Z",
"creatorId": null,
"incidenceId": 1,
"creator": null
},
{
"id": 1918,
"text": "Avisado a profesor.",
"type": "USER",
"action": null,
"payload": null,
"createdAt": "2020-07-05T03:12:57.000Z",
"creatorId": 44,
"incidenceId": 1,
"creator": {
"id": 44,
"email": "serviciosgenerales@propiedad.com",
"name": "Fulano",
"surname": "Perez",
"mobile": "999666333",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T02:41:20.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 44
}
}
]
POST
Create
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}/chat-messages?facilityId={{facilityId}}
Creates a message by the user logged.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"text": "admite 🤪"
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/chat-messages?facilityId={{facilityId}}
{
"text": "admite 🤪"
}
Example Response
400 - Bad Request
{
"name": "BadRequestError",
"message": "You cannot write new messages in closed incidences",
"code": "INC018"
}
GET
All
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}/work-orders?facilityId={{facilityId}}
Gets a list of work orders related to the incidence.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/work-orders?facilityId={{facilityId}}
Example Response
200 - OK
[
{
"id": 2779,
"workOrderStateId": 1,
"criticalityLevel": {
"id": 9,
"name": "Baja F2",
"time": 10080,
"facilityId": 2
},
"parentWorkOrder": null,
"assignedCompany": {
"id": 1,
"cif": "B86142511",
"name": "Propiedad SL",
"createdAt": "2020-06-03T05:10:05.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 1,
"updatorId": 209,
"addressId": 103
},
"assignedUser": null,
"problemType": {
"id": 108,
"text": "Tubería rota",
"facilityId": 2,
"categoryId": 17
},
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
},
{
"id": 2776,
"workOrderStateId": 1,
"criticalityLevel": {
"id": 9,
"name": "Baja F2",
"time": 10080,
"facilityId": 2
},
"parentWorkOrder": null,
"assignedCompany": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"assignedUser": null,
"problemType": {
"id": 174,
"text": "Tipo de problema ELECTRICIDAD 1",
"facilityId": 2,
"categoryId": 1
},
"category": {
"id": 1,
"name": "ELECTRICIDAD",
"parentCategoryId": null
}
},
{
"id": 2777,
"workOrderStateId": 1,
"criticalityLevel": {
"id": 9,
"name": "Baja F2",
"time": 10080,
"facilityId": 2
},
"parentWorkOrder": null,
"assignedCompany": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"assignedUser": null,
"problemType": {
"id": 183,
"text": "Tipo de problema FONTANERÍA 1",
"facilityId": 2,
"categoryId": 17
},
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
},
{
"id": 2778,
"workOrderStateId": 1,
"criticalityLevel": {
"id": 9,
"name": "Baja F2",
"time": 10080,
"facilityId": 2
},
"parentWorkOrder": null,
"assignedCompany": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"assignedUser": null,
"problemType": {
"id": 156,
"text": "Tipo de problema SANEAMIENTO 1",
"facilityId": 2,
"categoryId": 25
},
"category": {
"id": 25,
"name": "SANEAMIENTO",
"parentCategoryId": null
}
}
]
POST
Create
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}/work-orders?facilityId={{facilityId}}
Creates a work order related to the incidence.
The assignedCompenyId and the problemTypeId must be related to the categoryId to be able to create the work order.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"problemTypeId": 183,
"criticalityLevelId": 9,
"assignedCompanyId": 1,
"categoryId": 17,
"description": "Prueba"
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/work-orders?facilityId={{facilityId}}
{
"problemTypeId": 183,
"criticalityLevelId": 9,
"assignedCompanyId": 1,
"categoryId": 17,
"description": "Prueba"
}
GET
All
https://{{host}}:{{port}}/api/incidences?facilityId={{facilityId}}&page=1&limit=2
Gets all the incidences in the facility indicated.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
ids
[]
Array of numbers that are ids of incidences.
typeIds
[]
Array of number that are 1 for incidence and 2 for service requests.
topic
text
String to filter by subject of the incidence.
description
text
String to filter by text in the description that matches.
statusIds
[]
Array of numbers to filter by status of the incidence.
categoryIds
[]
Array of numbers to filter by categories of the work orders.
creator
text
String to filter by text that matches the name, surname or email of the creator.
fromCreation
2020-02-01
Date in format YYYY-MM-DD
toCreation
2020-02-07
Date in format YYYY-MM-DD
fromClose
Date in format YYYY-MM-DD
toClose
Date in format YYYY-MM-DD
page
1
Number of the page.
limit
2
Number of the elaments per page.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences?facilityId={{facilityId}}&page=1&limit=2
Example Response
200 - OK
{
"items": [
{
"id": 8819,
"topic": "puerta de entrada sucia",
"description": null,
"photos": [],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2022-03-10T17:50:26.000Z",
"updatedAt": "2022-03-10T17:50:26.000Z",
"assignedAt": null,
"openedAt": null,
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 90,
"updatorId": null,
"openerId": null,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 1,
"typeId": null,
"status": {
"id": 1,
"name": "CREATED"
},
"creator": {
"id": 90,
"email": "usuario@cliente.com",
"name": "Usuario",
"surname": "Cliente",
"mobile": "9876543",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T03:38:18.000Z",
"updatedAt": "2021-11-09T17:22:30.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 9,
"addressId": 90
}
},
{
"id": 8681,
"topic": "Silla rota editada",
"description": "editada",
"photos": [],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2021-05-23T20:26:51.000Z",
"updatedAt": "2022-01-21T08:15:01.000Z",
"assignedAt": null,
"openedAt": "2021-05-23T20:26:51.000Z",
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 44,
"updatorId": 44,
"openerId": 44,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 2,
"typeId": null,
"status": {
"id": 2,
"name": "OPENED"
},
"creator": {
"id": 44,
"email": "serviciosgenerales@propiedad.com",
"name": "Fulano",
"surname": "Perez",
"mobile": "999666333",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T02:41:20.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 44
}
}
],
"meta": {
"totalItems": 511,
"itemCount": 2,
"itemsPerPage": 2,
"totalPages": 256,
"currentPage": 1
}
}
GET
All (by component id)
https://{{host}}:{{port}}/api/incidences/component/{{componentId}}?facilityId={{facilityId}}&page=1&limit=10
Gets a list of incidences related to the component identified by its id.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number that is the page.
limit
10
Number that is the elements per page.
typeIds
[0]
Array of numbers to indicates (1) incidence (2) service request (0) null.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/component/{{componentId}}?facilityId={{facilityId}}&page=1&limit=10&typeIds=[0]
Example Response
200 - OK
{
"items": [
{
"id": 8667,
"topic": "My new Incidence",
"description": "Description of my new incidence",
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2021-04-29T12:12:06.000Z",
"updatedAt": "2021-04-29T12:12:06.000Z",
"assignedAt": null,
"openedAt": null,
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 90,
"updatorId": null,
"openerId": null,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 1,
"typeId": null,
"components": [
{
"id": 8231,
"createdAt": "2021-04-29T12:12:07.000Z",
"creatorId": 90,
"incidenceId": 8667,
"componentId": 1,
"component": {
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1
}
}
],
"status": {
"id": 1,
"name": "CREATED"
},
"creator": {
"id": 90,
"email": "usuario@cliente.com",
"name": "Usuario",
"surname": "Cliente",
"mobile": "9876543",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T03:38:18.000Z",
"updatedAt": "2021-11-09T17:22:30.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 9,
"addressId": 90
},
"firstWorkOrder": null
}
],
"meta": {
"totalItems": 1,
"itemCount": 1,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
GET
All (by component externalIdentifier)
https://{{host}}:{{port}}/api/incidences/component/{{externalIdentifier}}?facilityId=1&page=1&limit=10
Gets a list of incidences related to the component indicated by its externalIdentifier.
PARAMS
facilityId
1
Number that is the ID of the facility.
page
1
Number that is the page.
limit
10
Number that is the elements per page.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/component/{{externalIdentifier}}?facilityId=1&page=1&limit=10
Example Response
200 - OK
{
"items": [
{
"id": 8651,
"topic": "My new Incidence",
"description": "Description of my new incidence",
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2020-10-18T14:43:16.000Z",
"updatedAt": "2021-09-15T14:35:18.000Z",
"assignedAt": "2021-04-27T20:44:27.000Z",
"openedAt": "2020-10-18T14:43:16.000Z",
"finishedAt": null,
"closedAt": "2021-09-15T14:35:19.000Z",
"reviewedAt": null,
"creatorId": 44,
"updatorId": 44,
"openerId": 44,
"finisherId": null,
"closerId": 44,
"facilityId": 1,
"statusId": 5,
"typeId": 1,
"components": [
{
"id": 4,
"createdAt": "2020-10-18T14:43:16.000Z",
"creatorId": 44,
"incidenceId": 8651,
"componentId": 1,
"component": {
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1
}
}
],
"status": {
"id": 5,
"name": "CLOSED"
},
"creator": {
"id": 44,
"email": "serviciosgenerales@propiedad.com",
"name": "Fulano",
"surname": "Perez",
"mobile": "999666333",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T02:41:20.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 44
},
"firstWorkOrder": {
"id": 2783,
"description": "",
"photos": [
"https://imbicloud.appspot.com.storage.googleapis.com/1619556290600-abraham_simpson.jpg",
"https://imbicloud.appspot.com.storage.googleapis.com/1619556328272-dia-del-mujer.jpg"
],
"comment": null,
"workingTime": 2040,
"workingTimeCost": "45.0000",
"createdAt": "2021-04-27T20:44:26.000Z",
"updatedAt": "2021-09-15T14:35:01.000Z",
"startedAt": "2021-09-15T14:34:11.000Z",
"assignedAt": null,
"blockedAt": null,
"finishedAt": "2021-09-15T14:34:47.000Z",
"closedAt": "2021-09-15T14:35:02.000Z",
"creatorId": 44,
"updatorId": 44,
"starterId": 44,
"assignerId": null,
"finisherId": 44,
"closerId": 44,
"validatorId": 44,
"problemTypeId": 55,
"criticalityLevelId": 4,
"incidenceId": 8651,
"assignedCompanyId": 6,
"assignedUserId": null,
"workOrderStateId": 5,
"categoryId": 1,
"parentWorkOrderId": null
}
},
{
"id": 8653,
"topic": "My new Incidence",
"description": "Description of my new incidence",
"photos": [],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2020-10-20T12:53:24.000Z",
"updatedAt": "2020-10-21T14:32:40.000Z",
"assignedAt": "2020-10-21T14:32:40.000Z",
"openedAt": "2020-10-20T12:53:24.000Z",
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 44,
"updatorId": 44,
"openerId": 44,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 3,
"typeId": 1,
"components": [
{
"id": 10,
"createdAt": "2020-10-20T12:53:24.000Z",
"creatorId": 44,
"incidenceId": 8653,
"componentId": 1,
"component": {
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1
}
}
],
"status": {
"id": 3,
"name": "ASSIGNED"
},
"creator": {
"id": 44,
"email": "serviciosgenerales@propiedad.com",
"name": "Fulano",
"surname": "Perez",
"mobile": "999666333",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T02:41:20.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 44
},
"firstWorkOrder": {
"id": 2767,
"description": "",
"photos": [
"https://imbicloud.appspot.com.storage.googleapis.com/1603995716077-Captura de pantalla 2020-10-29 a las 18.43.01.png"
],
"comment": null,
"workingTime": null,
"workingTimeCost": null,
"createdAt": "2020-10-24T10:09:28.000Z",
"updatedAt": "2021-03-30T16:57:36.000Z",
"startedAt": null,
"assignedAt": null,
"blockedAt": "2021-03-30T16:57:37.000Z",
"finishedAt": null,
"closedAt": null,
"creatorId": 44,
"updatorId": null,
"starterId": 44,
"assignerId": null,
"finisherId": null,
"closerId": null,
"validatorId": null,
"problemTypeId": 48,
"criticalityLevelId": 2,
"incidenceId": 8653,
"assignedCompanyId": 1,
"assignedUserId": null,
"workOrderStateId": 2,
"categoryId": 51,
"parentWorkOrderId": 2764
}
},
{
"id": 8667,
"topic": "My new Incidence",
"description": "Description of my new incidence",
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2021-04-29T12:12:06.000Z",
"updatedAt": "2021-04-29T12:12:06.000Z",
"assignedAt": null,
"openedAt": null,
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 90,
"updatorId": null,
"openerId": null,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 1,
"typeId": null,
"components": [
{
"id": 8231,
"createdAt": "2021-04-29T12:12:07.000Z",
"creatorId": 90,
"incidenceId": 8667,
"componentId": 1,
"component": {
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1
}
}
],
"status": {
"id": 1,
"name": "CREATED"
},
"creator": {
"id": 90,
"email": "usuario@cliente.com",
"name": "Usuario",
"surname": "Cliente",
"mobile": "9876543",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T03:38:18.000Z",
"updatedAt": "2021-11-09T17:22:30.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 9,
"addressId": 90
},
"firstWorkOrder": null
}
],
"meta": {
"totalItems": 7,
"itemCount": 3,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
GET
One
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}?facilityId={{facilityId}}
Gets information about an incidence.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 8647,
"topic": "visto problema en puerta",
"description": null,
"photos": [],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2020-10-13T14:16:21.000Z",
"updatedAt": "2020-10-13T14:18:52.000Z",
"assignedAt": "2020-10-13T14:18:52.000Z",
"openedAt": "2020-10-13T14:16:22.000Z",
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 188,
"updatorId": 44,
"openerId": 188,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 3,
"typeId": 1,
"status": {
"id": 3,
"name": "ASSIGNED"
},
"components": [
{
"id": 5811,
"createdAt": "2020-10-13T14:16:21.000Z",
"creatorId": 188,
"incidenceId": 8647,
"componentId": 2360,
"component": {
"id": 2360,
"name": "puerta para muro cortina | Un cristal de muro cortina | 610969",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Puertas",
"externalIdentifier": "3a250eef-19f5-43c1-981f-e4ee8eeafe48-00095299",
"serialNumber": "eafe48-95299",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "95299",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:20:46.000Z",
"creatorId": 2,
"spaceId": 13,
"typeId": 62,
"facilityId": 1
}
},
{
"id": 5812,
"createdAt": "2020-10-13T14:16:21.000Z",
"creatorId": 188,
"incidenceId": 8647,
"componentId": 2360,
"component": {
"id": 2360,
"name": "puerta para muro cortina | Un cristal de muro cortina | 610969",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Puertas",
"externalIdentifier": "3a250eef-19f5-43c1-981f-e4ee8eeafe48-00095299",
"serialNumber": "eafe48-95299",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "95299",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:20:46.000Z",
"creatorId": 2,
"spaceId": 13,
"typeId": 62,
"facilityId": 1
}
}
],
"creator": {
"id": 188,
"email": "encargado@mantenimiento.com",
"name": "Encargado",
"surname": "Mantenimiento",
"mobile": "91929394",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T21:41:01.000Z",
"updatedAt": "2021-11-09T17:24:10.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"addressId": 188
},
"firstWorkOrder": {
"id": 2752,
"description": "",
"photos": [
"https://imbicloud.appspot.com.storage.googleapis.com/1619556649674-172033915_2898709127123398_3343226042789238982_n.png",
"https://imbicloud.appspot.com.storage.googleapis.com/1619556656883-dia-del-mujer.jpg"
],
"comment": null,
"workingTime": 180,
"workingTimeCost": "34.0000",
"createdAt": "2020-10-13T14:18:52.000Z",
"updatedAt": "2021-06-03T10:32:26.000Z",
"startedAt": "2020-10-17T19:24:52.000Z",
"assignedAt": "2021-04-27T20:56:34.000Z",
"blockedAt": null,
"finishedAt": "2021-04-27T20:56:35.000Z",
"closedAt": "2021-06-03T10:32:27.000Z",
"creatorId": 44,
"updatorId": 128,
"starterId": 44,
"assignerId": null,
"finisherId": 128,
"closerId": 128,
"validatorId": 44,
"problemTypeId": 55,
"criticalityLevelId": 4,
"incidenceId": 8647,
"assignedCompanyId": 6,
"assignedUserId": 166,
"workOrderStateId": 5,
"categoryId": 1,
"parentWorkOrderId": null
}
}
POST
Create
https://{{host}}:{{port}}/api/incidences?facilityId={{facilityId}}
Creates an incidence.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"topic": "My new Incidence",
"description": "Description of my new incidence",
"components": [
1,
2,
3
],
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
]
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences?facilityId={{facilityId}}
{
"topic": "My new Incidence",
"description": "Description of my new incidence",
"components": [
1,
2,
3
],
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
]
}
Example Response
200 - OK
{
"id": 8861,
"topic": "My new Incidence",
"description": "Description of my new incidence",
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2022-12-22T16:26:25.000Z",
"updatedAt": "2022-12-22T16:26:25.000Z",
"assignedAt": null,
"openedAt": "2022-12-22T16:26:26.000Z",
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 209,
"updatorId": null,
"openerId": 209,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 2,
"typeId": null,
"status": {
"id": 2,
"name": "OPENED"
},
"components": [
{
"id": 8569,
"createdAt": "2022-12-22T16:26:26.000Z",
"creatorId": 209,
"incidenceId": 8861,
"componentId": 1,
"component": {
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1
}
},
{
"id": 8570,
"createdAt": "2022-12-22T16:26:26.000Z",
"creatorId": 209,
"incidenceId": 8861,
"componentId": 2,
"component": {
"id": 2,
"name": "Almacén",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bca",
"serialNumber": "d14fcd-a5bca",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BCA",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:20:32.000Z",
"creatorId": 2,
"spaceId": 2,
"typeId": 77,
"facilityId": 1
}
},
{
"id": 8571,
"createdAt": "2022-12-22T16:26:26.000Z",
"creatorId": 209,
"incidenceId": 8861,
"componentId": 3,
"component": {
"id": 3,
"name": "Ascensor comercial - 1 embarque | Ascensor comercial - 1 embarque | 613049",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos especializados",
"externalIdentifier": "5c0597e9-ba3a-4f50-a7b4-9c87125fff69-00095ab9",
"serialNumber": "5fff69-95ab9",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "00095AB9",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:20:31.000Z",
"creatorId": 2,
"spaceId": 5,
"typeId": 4,
"facilityId": 1
}
}
],
"creator": {
"id": 666,
"email": "propietario@propiedad.com",
"name": "Propietario",
"surname": "Propiedad",
"mobile": null,
"photo": null,
"isSuperAdmin": false,
"createdAt": "2021-06-03T09:33:38.000Z",
"updatedAt": "2021-06-03T09:33:38.000Z",
"creatorId": 44,
"updatorId": null,
"companyId": 1,
"addressId": null
},
"firstWorkOrder": null
}
PATCH
Edit
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}?facilityId={{facilityId}}
Updates information of an incidence.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"topic": "My new Incidence",
"description": "Description of my new incidence",
"components": [
1,
3
],
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
],
"typeId": 1
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}?facilityId={{facilityId}}
{
"topic": "My new Incidence",
"description": "Description of my new incidence",
"components": [
1,
3
],
"photos": [
"https://picsum.photos/1280/720",
"https://picsum.photos/1280/720"
],
"typeId": 1
}
PATCH
Open
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}/open?facilityId={{facilityId}}
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/open?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 8724,
"topic": "gotera en el techo",
"description": null,
"photos": [],
"reviewScore": null,
"reviewDescription": null,
"createdAt": "2021-09-25T08:35:41.000Z",
"updatedAt": "2022-12-22T16:51:47.000Z",
"assignedAt": null,
"openedAt": "2022-12-22T16:51:47.000Z",
"finishedAt": null,
"closedAt": null,
"reviewedAt": null,
"creatorId": 69,
"updatorId": null,
"openerId": 666,
"finisherId": null,
"closerId": null,
"facilityId": 1,
"statusId": 2,
"typeId": null,
"status": {
"id": 2,
"name": "OPENED"
},
"components": [
{
"id": 8299,
"createdAt": "2021-09-25T08:35:41.000Z",
"creatorId": 1,
"incidenceId": 8724,
"componentId": 2802,
"component": {
"id": 2802,
"name": "Suelo | forjado sanitario con placa alveolar de 20+5 cm | 538682",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Suelos",
"externalIdentifier": "659b87f6-6674-42f9-a629-52e4756e4f71-0008383a",
"serialNumber": "6e4f71-8383a",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "0008383A",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:20:37.000Z",
"creatorId": 2,
"spaceId": 30,
"typeId": 68,
"facilityId": 1
}
}
],
"creator": {
"id": 69,
"email": "usuario@cliente.com",
"name": "Usuario",
"surname": "Cliente",
"mobile": "9876543",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T03:38:18.000Z",
"updatedAt": "2021-11-09T17:22:30.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 9,
"addressId": 90
},
"firstWorkOrder": null
}
PATCH
Finish
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}/finish?facilityId={{facilityId}}
Change the status of an incidence from ASSIGNED to FINISHED.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/finish?facilityId={{facilityId}}
PATCH
Close
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}/close?facilityId={{facilityId}}
Changes the status of an incidence from CREATED, OPENED, FINISHED to CLOSED.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/close?facilityId={{facilityId}}
PATCH
Review
https://{{host}}:{{port}}/api/incidences/{{incidenceId}}/review?facilityId={{facilityId}}
Set a score and description to the incidence by the creator. Score must be a number between 1 and 5.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"score": 3,
"description": "Fuck yeah!"
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/{{incidenceId}}/review?facilityId={{facilityId}}
{
"score": 3999,
"description": "Fuck yeah!"
}
Example Response
400 - Bad Request
{
"name": "BadRequestError",
"message": "Incidence must be finished or closed in order to be reviewed",
"code": "INC011"
}
POST
Upload Photo
https://{{host}}:{{port}}/api/incidences/photo
Upload a file in the cloud storage and return de url.
Front manages to edit the incidence and give the url of the file.
BODY formdata
photo
None
File to upload.
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/incidences/photo
Example Response
200 - OK
{
"url": "https://imbicloud.appspot.com.storage.googleapis.com/1671730596494-12e3067d9314c495953598ad44946292-tortoise-turtle-strength.jpg"
}
GET
Search
https://{{host}}:{{port}}/api/materials?search=text
Gets list of materials.
PARAMS
search
text
String to filter by name of the material.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/materials?search=cable
Example Response
200 - OK
[
{
"id": 61,
"name": "Cable UTP 5e",
"createdAt": "2020-06-16T07:45:51.000Z",
"creatorId": 1,
"categoryId": 4
},
{
"id": 238,
"name": "Salida cable BJC",
"createdAt": "2020-06-16T07:45:51.000Z",
"creatorId": 1,
"categoryId": 5
},
{
"id": 480,
"name": "Cable telefónico 2 hijos RJ11",
"createdAt": "2021-09-15T14:34:30.000Z",
"creatorId": 44,
"categoryId": 4
}
]
GET
All
https://{{host}}:{{port}}/api/problem-types?facilityId={{facilityId}}&categoryId=17&page=1&limit=3
Gets a list of problem types.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
categoryId
17
Number that is the ID of the category.
page
1
Number of the page.
limit
3
Number of elements per page.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/problem-types?facilityId={{facilityId}}&categoryId=17&page=1&limit=3
Example Response
200 - OK
{
"items": [
{
"id": 16,
"text": "FONT-TAP-MISSING",
"facilityId": 1,
"categoryId": 17,
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
},
{
"id": 28,
"text": "FONT-PIPE-STUCK",
"facilityId": 1,
"categoryId": 17,
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
},
{
"id": 52,
"text": "FONT-PIPE-BROKE",
"facilityId": 1,
"categoryId": 17,
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
}
],
"meta": {
"totalItems": 10,
"itemCount": 3,
"itemsPerPage": 3,
"totalPages": 4,
"currentPage": 1
}
}
GET
All (CSV)
https://{{host}}:{{port}}/api/problem-types/csv?facilityId={{facilityId}}
Gets the list of problem types setting in the facility in tabular format.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/problem-types/csv?facilityId={{facilityId}}
Example Response
200 - OK
category,problemType
"FONTANERÍA","Atasco - Bote Sifónico"
"FONTANERÍA","Atasco - Inodoro"
"FONTANERÍA","Atasco - Lavabo"
"FONTANERÍA","Atasco - Sumidero"
"FONTANERÍA","Atasco - Urinario"
"PCI","Atasco - Válvula"
"CLIMATIZACIÓN, CALEFACCIÓN Y ACS","Calor - Despacho"
"PCI","Colocación - Extintor"
"CLIMATIZACIÓN, CALEFACCIÓN Y ACS","Comprobación - Planta"
"CLIMATIZACIÓN, CALEFACCIÓN Y ACS","Conducto - Chapa"
"CLIMATIZACIÓN, CALEFACCIÓN Y ACS","Conducto - Suelto"
"ELECTRICIDAD","ELEC-CABLES-DESORGANIZADOS"
"ELECTRICIDAD","ELEC-CABLES-ROTOS"
"ELECTRICIDAD","ELEC-CANALIZACIONES-OBTRUIDAS"
"ELECTRICIDAD","ELEC-CANALIZACIONES-ROTAS"
"ELECTRICIDAD","ELEC-CUADRO-CORTOCIRCUITO"
"ELECTRICIDAD","ELEC-CUADRO-SUCIO"
"ELECTRICIDAD","ELEC-CUADROS"
"ELECTRICIDAD","ELEC-LUMINARIAS-MALESTADO"
"ELECTRICIDAD","ELEC-LUMINARIAS-ROTAS"
"ELECTRICIDAD","ELEC-LUMINARIAS-SUCIAS"
"TRANSPORTE","Fallo - Ascensor"
"PCI","Fallo - Baterías"
"CLIMATIZACIÓN, CALEFACCIÓN Y ACS","Fallo - Bomba"
"PCI","Fallo - Bomba Diesel"
"PCI","Fallo - Bomba Eléctrica"
"FONTANERÍA","Fallo - Bomba Grupo Presión"
"PCI","Fallo - Bomba Jockey"
"PCI","Fallo - Bomba Nivel"
"PCI","Fallo - Central Detección"
GET
One
https://{{host}}:{{port}}/api/problem-types/{{problemTypeId}}?facilityId={{facilityId}}
Get the problem type indicated in the path param.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/problem-types/1?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 1,
"text": "SANE-TUBERIA-ATASCADA",
"facilityId": 1,
"categoryId": 25,
"category": {
"id": 25,
"name": "SANEAMIENTO",
"parentCategoryId": null
}
}
POST
Create
https://{{host}}:{{port}}/api/problem-types?facilityId={{facilityId}}
Creates a new problem type related to the category indicated in the param body.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"text": "A new problem type",
"categoryId": 17
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/problem-types?facilityId={{facilityId}}
{
"text": "A new problem type",
"categoryId": 17
}
Example Response
200 - OK
{
"id": 302,
"text": "A new problem type",
"facilityId": 1,
"categoryId": 17,
"category": {
"id": 17,
"name": "FONTANERÍA",
"parentCategoryId": null
}
}
PATCH
Edit
https://{{host}}:{{port}}/api/problem-types/{{problemTypeId}}?facilityId={{facilityId}}
Updates a problem type.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"text": "A problem type edited",
"categoryId": 17
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/problem-types/{{problemTypeId}}?facilityId={{facilityId}}
{
"text": "A problem type edited",
"categoryId": 17
}
PATCH
Edit (Upload CSV)
https://{{host}}:{{port}}/api/problem-types/csv?facilityId={{facilityId}}
Uploads problem types from CSV file.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY formdata
file
None
CSV file to upload problem types.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/problem-types/csv?facilityId={{facilityId}}
DELETE
Delete
https://{{host}}:{{port}}/api/problem-types/{{problemTypeId}}?facilityId={{facilityId}}
Deletes a problem type only if it is not related to a work order.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/problem-types/{{problemTypeId}}?facilityId={{facilityId}}
GET
Report By Name
https://{{host}}:{{port}}/api/report/{{reportName}}?from=2020-01-01&to=2020-06-30&facilitiesId=[1]&secondFrom=2020-07-01&secondTo=2020-12-31&typesId=[1,2]&companiesId=[1]
Gets data about the reportName indicated in the path param.
- evolutionIncidencesByCategory, series of numbers that are the number of incidences by category.
- totalIncidencesByCategory, sum of the incidences by category.
- costsByCategory, sum of the cost by category.
- costsByFacility, sum of the cost by facility.
- materialCostsBrakeDown, detail of the material costs.
- costsByProblemType, count of problem types and its cost.
- costsByCompany, count of work orders by company.
PARAMS
from
2020-01-01
Date in format YYYY-MM-DD
to
2020-06-30
Date in format YYYY-MM-DD
page
1
Number that is the page. Only for tables.
limit
3
Number of elements per page. Only for tables.
facilitiesId
[1]
Array of numbers that are IDs of facilities.
secondFrom
2020-07-01
Date in format YYYY-MM-DD. To compare to a second period of time.
secondTo
2020-12-31
Date in format YYYY-MM-DD. To compare to a second period of time.
typesId
[1,2]
Array of numbers that are companyTypeIds
companiesId
[1]
Array of numbers that are companyIds.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/report/{{reportName}}?from=2020-01-01&to=2020-06-30&facilitiesId=[1]&secondFrom=2020-07-01&secondTo=2020-12-31
Example Response
200 - OK
{
"value": [
{
"categoryId": null,
"categoryName": null,
"countIncidences": "45"
},
{
"categoryId": 1,
"categoryName": "ELECTRICIDAD",
"countIncidences": "176"
},
{
"categoryId": 10,
"categoryName": "CLIMATIZACIÓN, CALEFACCIÓN Y ACS",
"countIncidences": "6"
},
{
"categoryId": 17,
"categoryName": "FONTANERÍA",
"countIncidences": "3"
},
{
"categoryId": 25,
"categoryName": "SANEAMIENTO",
"countIncidences": "1"
},
{
"categoryId": 30,
"categoryName": "REDES TELECOMUNICACIONES",
"countIncidences": "1"
},
{
"categoryId": 63,
"categoryName": "MOBILIARIO",
"countIncidences": "4"
},
{
"categoryId": 69,
"categoryName": "ELEMENTOS CONSTRUCTIVOS",
"countIncidences": "3"
}
],
"id": "totalIncidencesByCategory",
"type": "series",
"value2": [
{
"categoryId": null,
"categoryName": null,
"countIncidences": "7"
},
{
"categoryId": 1,
"categoryName": "ELECTRICIDAD",
"countIncidences": "5"
},
{
"categoryId": 17,
"categoryName": "FONTANERÍA",
"countIncidences": "4"
},
{
"categoryId": 25,
"categoryName": "SANEAMIENTO",
"countIncidences": "1"
},
{
"categoryId": 51,
"categoryName": "VENTILACIÓN Y EXTRACCIÓN",
"countIncidences": "1"
},
{
"categoryId": 63,
"categoryName": "MOBILIARIO",
"countIncidences": "5"
}
]
}
GET
Report CSV
https://{{host}}:{{port}}/api/report/{{reportName}}/csv?from=2020-01-01&to=2020-12-31&facilitiesId=[1]
Gets report in tabular format.
Only available for materialCostsBrakeDown.
PARAMS
from
2020-01-01
Date in format YYYY-MM-DD
to
2020-12-31
Date in format YYYY-MM-DD
facilitiesId
[1]
Array of numbers that are facilityIds
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/report/{{reportName}}/csv?from=2020-01-01&to=2020-12-31&facilitiesId=[1]
Example Response
200 - OK
facilityId,facilityName,companyId,companyName,incidenceId,orderId,categoryId,categoryName,subcategoryId,subcategoryName,materialId,materialName,closedAt,workingTime,timeCost,quantity,unitCost
1,Colegio Alegra,6,Mantenimiento 5 SL,13,14,63,MOBILIARIO,68,Varios (pequeño material y resto),11,Limpia cristales,2020-06-09 08:59:30,2.7500,9.0000,1,0.1000
1,Colegio Alegra,6,Mantenimiento 5 SL,13,14,63,MOBILIARIO,68,Varios (pequeño material y resto),11,Limpia cristales,2020-06-09 08:59:30,2.7500,9.0000,1,6.6000
1,Colegio Alegra,6,Mantenimiento 5 SL,14,15,63,MOBILIARIO,68,Varios (pequeño material y resto),11,Limpia cristales,2020-06-09 09:16:08,1.5500,10.0000,1,0.3000
1,Colegio Alegra,6,Mantenimiento 5 SL,15,16,69,ELEMENTOS CONSTRUCTIVOS,71,Carpintería Metálica/Cerrajería,12,puerta,2020-06-09 09:24:47,5.0000,155.0000,1,245.0000
1,Colegio Alegra,6,Mantenimiento 5 SL,448,22,1,ELECTRICIDAD,2,Cuadros,13,Cerradura,2020-06-15 09:21:06,2.2500,67.0000,45,67.0000
1,Colegio Alegra,6,Mantenimiento 5 SL,448,23,10,"CLIMATIZACIÓN, CALEFACCIÓN Y ACS",11,Conductos,14,Caja de ventilación de doble flujo,2020-06-15 09:23:33,4.0000,3.0000,45,45.0000
1,Colegio Alegra,6,Mantenimiento 5 SL,7915,1503,1,ELECTRICIDAD,2,Cuadros,13,Cerradura,2020-06-16 16:48:30,4.9167,93.7123,7,685.9612
1,Colegio Alegra,6,Mantenimiento 5 SL,7915,1503,1,ELECTRICIDAD,2,Cuadros,13,Cerradura,2020-06-16 16:48:30,4.9167,93.7123,7,833.3684
1,Colegio Alegra,6,Mantenimiento 5 SL,7987,1640,1,ELECTRICIDAD,2,Cuadros,13,Cerradura,2020-03-24 17:48:31,5.3167,21.9822,5,300.7524
1,Colegio Alegra,1,Propiedad SL,8637,2740,63,MOBILIARIO,67,Sillas,475,Silla plegable,2020-09-14 15:17:24,0.9000,9.5400,2,3.4000
1,Colegio Alegra,1,Propiedad SL,8638,2741,63,MOBILIARIO,67,Sillas,475,Silla plegable,2020-09-15 18:28:04,0.7500,0.0000,2,10.0000
1,Colegio Alegra,6,Mantenimiento 5 SL,8640,2743,17,FONTANERÍA,24,Varios (pequeño material y resto),477,Silicona,2020-09-20 20:21:33,1.5000,9.0000,1,5.4500
1,Colegio Alegra,6,Mantenimiento 5 SL,8641,2744,63,MOBILIARIO,68,Varios (pequeño material y resto),478,Tela,2020-09-21 08:54:20,1.5000,9.2300,3,34.3400
1,Colegio Alegra,6,Mantenimiento 5 SL,8335,2748,1,ELECTRICIDAD,4,Cables,61,Cable UTP 5e,2020-09-29 09:05:37,23.0000,22.0000,24,23.2300
GET
All
https://{{host}}:{{port}}/api/roles
Gets list of roles in IMBICLOUD.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/roles
Example Response
200 - OK
[
{
"id": 1,
"name": "Administrador",
"description": "Administrador de la instalación",
"createdAt": "2020-06-03T23:51:16.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null
},
{
"id": 2,
"name": "Gestor",
"description": "Gestor de usuarios cliente de la instalación",
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null
},
{
"id": 3,
"name": "Usuario",
"description": "Usuario básico de la instalación",
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null
},
{
"id": 4,
"name": "Administrador mantenimiento",
"description": "Administrador de una empresa de matenimiento",
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null
},
{
"id": 5,
"name": "Usuario mantenimiento",
"description": "Usuario de una empresa de mantenimiento",
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null
},
{
"id": 6,
"name": "Propietario",
"description": "Propietario de la instalación",
"createdAt": "2021-12-16T14:43:59.000Z",
"updatedAt": "2021-12-16T14:43:59.000Z",
"creatorId": 1,
"updatorId": null
}
]
GET
All
https://{{host}}:{{port}}/api/scheduled-tasks?facilityId={{facilityId}}&from=2022-03-01T04:57:30.000Z&to=2022-03-30T04:57:30.000Z&view=calendar&statusIds=[1,2]
Gets a list of scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
from
2022-03-01T04:57:30.000Z
Date in timezone format
to
2022-03-30T04:57:30.000Z
Date in timezone format
sortBy
text
String to indicate the field to order the rows of a table.
order
DESC
String that indicates the order ASC or DESC.
id
4
Number to filter by ID of the scheduled task in database.
name
text
String to filter by name of the scheduled task.
frequencyQuantity
2
Number to filter by frequency of the scheduled task.
frequencyUnit
days
String to filter by frequency of the scheduled task.
company
text
String to filter by company name.
category
text
String to filter by category name.
parent
text
String to filter by id seeing by user.
page
1
Number of page.
limit
10
Number of element per page in a table.
view
calendar
String that indicates the type of view: list, calendar, scheduled.
statusIds
[1,2]
Array of numbers to filter by statusId of the scheduled task.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks?facilityId=1&from=2022-03-01T04:57:30.000Z&to=2022-03-30T04:57:30.000Z&page=1&limit=10&view=list&statusIds=[1,2]
Example Response
200 - OK
{
"items": [
{
"id": 11179,
"name": "revision de ascensores",
"parent": "b7e4c4da-09d8-446f-b7b6-0641da230bce",
"frequencyQuantity": 2,
"frequencyUnit": "months",
"companyName": "Mantenimiento LTD",
"nextScheduledTask": "2022-03-10T16:38:00.000Z",
"lastScheduledTask": null,
"categoryName": "ELEMENTOS CONSTRUCTIVOS"
},
{
"id": 1225,
"name": "limpieza sillas",
"parent": "6b480c24-586e-42e9-af84-9cf603b1cbf8",
"frequencyQuantity": 1,
"frequencyUnit": "weeks",
"companyName": "Mantenimiento 5 SL",
"nextScheduledTask": "2022-03-16T22:22:00.000Z",
"lastScheduledTask": "2022-03-09T22:22:00.000Z",
"categoryName": "FONTANERÍA"
},
{
"id": 292,
"name": "cambio filtro modelos",
"parent": "bd4352a4-0580-4f86-abe9-25ff06bf6bb4",
"frequencyQuantity": 1,
"frequencyUnit": "weeks",
"companyName": "Mantenimiento 5 SL",
"nextScheduledTask": "2022-03-17T17:03:00.000Z",
"lastScheduledTask": "2022-03-10T17:03:00.000Z",
"categoryName": "VENTILACIÓN Y EXTRACCIÓN"
}
],
"meta": {
"totalItems": 3,
"itemCount": 3,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
},
"links": {
"first": "",
"previous": "",
"next": "",
"last": ""
}
}
GET
All (by component id)
https://{{host}}:{{port}}/api/scheduled-tasks/component/{{componentId}}?facilityId={{facilityId}}&page=1&limit=10&view=list
Gets a list of scheduled task related to a component searched by its ID.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
from
2020-08-01T04:57:30.000Z
Date in timezone format
to
2020-09-01T04:57:30.000Z
Date in timezone format
sortBy
text
String to indicate the field to order the rows of a table.
order
DESC
String that indicates the order ASC or DESC.
id
4
Number to filter by ID of the scheduled task in database.
name
text
String to filter by name of the scheduled task.
frequencyQuantity
2
Number to filter by frequency of the scheduled task.
frequencyUnit
days
String to filter by frequency of the scheduled task.
company
text
String to filter by company name.
category
text
String to filter by category name.
parent
text
String to filter by id seeing by user.
page
1
Number of page.
limit
10
Number of element per page in a table.
view
list
String that indicates the type of view: list, calendar, scheduled.
statusIds
[2]
Array of numbers to filter by statusId of the scheduled task.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/component/{{componentId}}?facilityId={{facilityId}}&page=1&limit=10&view=list
GET
All (by component externalIdentifier)
https://{{host}}:{{port}}/api/scheduled-tasks/component/{{externalIdentifier}}?facilityId={{facilityId}}&page=1&limit=10&view=list&statusIds=[2]
Gets a list of scheduled task related to a component searched by its externalIdentifier.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
from
2020-08-01T04:57:30.000Z
Date in timezone format
to
2020-09-01T04:57:30.000Z
Date in timezone format
sortBy
text
String to indicate the field to order the rows of a table.
order
DESC
String that indicates the order ASC or DESC.
id
4
Number to filter by ID of the scheduled task in database.
name
text
String to filter by name of the scheduled task.
frequencyQuantity
2
Number to filter by frequency of the scheduled task.
frequencyUnit
days
String to filter by frequency of the scheduled task.
company
text
String to filter by company name.
category
text
String to filter by category name.
parent
text
String to filter by id seeing by user.
page
1
Number of page.
limit
10
Number of element per page in a table.
view
list
String that indicates the type of view: list, calendar, scheduled.
statusIds
[2]
Array of numbers to filter by statusId of the scheduled task.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/component/{{externalIdentifier}}?facilityId={{facilityId}}&page=1&limit=10&view=list&statusIds=[2]
GET
One
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}?facilityId={{facilityId}}
Gets information about a scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 560,
"parent": "23e1821d-4427-4c02-812b-75e718fba772",
"name": "nueva tarea",
"frequencyQuantity": 1,
"timeSpent": null,
"frequencyUnit": "days",
"filter": {
"exclusiveFilters": [],
"inclusiveFilters": [
{
"type": [
"cubo"
]
}
]
},
"strictDates": false,
"createdAt": "2021-05-24T14:32:00.000Z",
"updatedAt": "2021-05-24T08:53:47.000Z",
"assignedAt": null,
"finishedAt": "2021-05-24T08:53:47.000Z",
"creatorId": 44,
"updatorId": null,
"assignedToId": null,
"assignedById": null,
"finisherId": 128,
"validatorId": 44,
"facilityId": 1,
"categoryId": 17,
"companyId": 6,
"statusId": 1,
"company": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"assignedTo": null,
"finisher": {
"id": 128,
"email": "admin@mantenimiento.com",
"name": "Admin",
"surname": "Mantenimiento",
"mobile": "98989898",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T13:24:20.000Z",
"updatedAt": "2021-11-09T17:23:31.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"addressId": 128
},
"validator": {
"id": 44,
"email": "serviciosgenerales@propiedad.com",
"name": "Fulano",
"surname": "Perez",
"mobile": "999666333",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T02:41:20.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 44
}
}
GET
Subtasks All
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}/components/subtasks?facilityId={{facilityId}}
Gets a list of subtasks for each component of the scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}/components/subtasks?facilityId={{facilityId}}
Example Response
200 - OK
{
"items": [
{
"id": 3701,
"createdAt": "2022-05-31T13:36:00.000Z",
"creatorId": 209,
"checkedDate": null,
"scheduledTasksId": 11595,
"componentsId": 228608,
"scheduledTask": {
"id": 11595,
"parent": "5eefa3f7-6cbb-4c04-9184-5b20d8e475a5",
"name": "M-FUENTE ORNAMENTAL",
"frequencyQuantity": 1,
"timeSpent": null,
"frequencyUnit": "months",
"filter": {
"exclusiveFilters": [],
"inclusiveFilters": [
{
"name": [
"FUENTE ORNAMENTAL"
]
}
]
},
"strictDates": false,
"createdAt": "2022-12-30T13:36:00.000Z",
"updatedAt": "2022-05-30T09:02:46.000Z",
"assignedAt": null,
"finishedAt": null,
"creatorId": 209,
"updatorId": null,
"assignedToId": null,
"assignedById": null,
"finisherId": null,
"validatorId": null,
"facilityId": 3,
"categoryId": 17,
"companyId": 19,
"statusId": 3
},
"component": {
"id": 228608,
"name": "MEP_FUENTE_ORN | Fuente Ornamental | 3493902",
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20200210_1400(x64)",
"externalObject": "IfcBuildingElementProxy",
"externalIdentifier": "2a6b00d6-ebd0-44a1-a623-b72ba4273349-0035500e",
"serialNumber": null,
"installatedOn": null,
"warrantyStartOn": null,
"replacedOn": null,
"barcode": null,
"assetIdentifier": "3493902",
"area": null,
"length": null,
"coordBottomLeftX": "426.7594",
"coordBottomLeftY": "445.8664",
"coordBottomLeftZ": "0.0100",
"coordTopRightX": "427.2858",
"coordTopRightY": "449.8734",
"coordTopRightZ": "3.0890",
"createdAt": "2022-04-21T15:46:07.000Z",
"updatedAt": null,
"creatorId": 1,
"spaceId": 909,
"typeId": 2388,
"facilityId": 3,
"space": {
"id": 909,
"name": "PBA_EXT_DCH",
"category": null,
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcSpace",
"externalIdentifier": "65b18789-8af7-4c3b-9bc5-fd266be0bad8-002d7358",
"roomTag": null,
"usableHeight": null,
"grossArea": "338.0719",
"netArea": "338.0719",
"volume": "1375.4292",
"coordBottomLeftX": "426.1134",
"coordBottomLeftY": "436.5361",
"coordBottomLeftZ": "0.0000",
"coordTopRightX": "449.8128",
"coordTopRightY": "451.8951",
"coordTopRightZ": "4.0685",
"createdAt": "2021-06-21T14:34:09.000Z",
"creatorId": 1,
"floorId": 28,
"floor": {
"id": 28,
"name": "Planta Baja",
"category": "Piso",
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcBuildingStorey",
"externalIdentifier": "8974fcd1-2e28-4ac7-a042-c6cec31e52a9-000003a5",
"elevation": "0.0000",
"height": null,
"createdAt": "2021-05-11T09:56:27.000Z",
"creatorId": 1,
"facilityId": 3
}
}
},
"scheduledTaskComponentsSubtasks": [
{
"id": 13511,
"code": "2",
"description": "Comprobar el correcto funcionamiento de equipos de desinfección del agua",
"updatorId": null,
"checkedOption": null,
"checkedDate": null,
"scheduledTaskComponentId": 3701
},
{
"id": 13536,
"code": "1",
"description": "Revisar el pre-filtro de la bomba y comprobar que se encuentra correctamente instalado y en buenas condiciones higiénicas.",
"updatorId": null,
"checkedOption": null,
"checkedDate": null,
"scheduledTaskComponentId": 3701
}
]
}
],
"meta": {
"totalItems": 1,
"totalPages": null
},
"links": {
"first": "/scheduled-tasks/11595/components?facilityId=1&page=1&limit=undefined",
"previous": "/scheduled-tasks/11595/components?facilityId=1&page=1&limit=undefined",
"next": "/scheduled-tasks/11595/components?facilityId=1&page=NaN&limit=undefined",
"last": "/scheduled-tasks/11595/components?facilityId=1&page=NaN&limit=undefined"
}
}
POST
Create
https://{{host}}:{{port}}/api/scheduled-tasks?facilityId={{facilityId}}
Creates a scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "test 2",
"frequencyQuantity": 1,
"frequencyUnit": "months",
"categoryId": 1,
"companyId": 6,
"strictDates": true,
"createdAt": "2022-03-11T19:21:09.809Z",
"filter": {
"exclusiveFilters": [],
"inclusiveFilters": [
{
"type": [
"silla"
]
}
]
}
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks?facilityId={{facilityId}}
{
"name": "test 2",
"frequencyQuantity": 1,
"frequencyUnit": "months",
"categoryId": 1,
"companyId": 6,
"strictDates": true,
"createdAt": "2022-03-11T19:21:09.809Z",
"filter": {
"exclusiveFilters": [],
"inclusiveFilters": [
{
"type": [
"silla"
]
}
]
}
}
PATCH
Edit
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}?facilityId={{facilityId}}&editNext=true
Updates the information about a scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
editNext
true
Boolean that indicates it only updates the current scheduled task or next too.
BODY raw
{
"name": "cambio filtro modelos 3",
"frequencyQuantity": 3,
"frequencyUnit": "weeks",
"filter": {
"exclusiveFilters": [
{
"floor": [
"Planta +1"
]
}
],
"inclusiveFilters": [
{
"type": [
"Equipos mecánicos | Cubo | Cubo"
]
}
]
},
"createdAt": "2022-02-26T10:40:00.000Z",
"categoryId": 1,
"companyId": 6,
"strictDates": false,
"timeSpent": 300
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}?facilityId={{facilityId}}&editNext=true
{
"name": "cambio filtro modelos 3",
"frequencyQuantity": 3,
"frequencyUnit": "weeks",
"filter": {
"exclusiveFilters": [
{
"floor": [
"Planta +1"
]
}
],
"inclusiveFilters": [
{
"type": [
"Equipos mecánicos | Cubo | Cubo"
]
}
]
},
"createdAt": "2022-02-26T10:40:00.000Z",
"categoryId": 1,
"companyId": 6,
"strictDates": false,
"timeSpent": 300
}
PATCH
Finish
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}/finish?facilityId={{facilityId}}
Finishes a scheduled task only if there is no component unchecked. And it is needed to validate with an email of an habitan of the facility and the time spent (minutes).
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"validatorEmail": "serviciosgenerales2f2@propiedadsl.com",
"spentTime": 200
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}/finish?facilityId={{facilityId}}
{
"validatorEmail": "serviciosgenerales2f2@propiedadsl.com",
"spentTime": 200
}
DELETE
Delete
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}?facilityId={{facilityId}}&deleteNext=false
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
deleteNext
false
Boolean that indicates it only deletes the current scheduled task or next too.
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}?facilityId={{facilityId}}&deleteNext=false
POST
One, with components filter.
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}/components?facilityId={{facilityId}}&page=1&limit=10
Gets information about a scheduled task and its components with a filter by componentName, assetIdentifier, typeName, spaceName, floorName.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of page.
limit
10
Number of elements per page.
BODY raw
{
"componentName": "",
"assetIdentifier": "",
"typeName": "",
"spaceName": "",
"floorName": ""
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}/components?facilityId={{facilityId}}&page=1&limit=10
{
"componentName": "",
"assetIdentifier": "",
"typeName": "",
"spaceName": "",
"floorName": ""
}
Example Response
200 - OK
{
"items": [
{
"id": 3036,
"createdAt": "2022-04-29T13:21:00.000Z",
"creatorId": 209,
"checkedDate": "2022-04-25T11:18:42.000Z",
"scheduledTasksId": 11373,
"componentsId": 227421,
"scheduledTask": {
"id": 11373,
"parent": "1342e89d-de15-4d66-b2d7-0cffbb40780c",
"name": "M-ALJIBE_PCI",
"frequencyQuantity": 1,
"timeSpent": 60,
"frequencyUnit": "months",
"filter": {
"exclusiveFilters": [],
"inclusiveFilters": [
{
"type": [
"ALGIBE AFS"
]
}
]
},
"strictDates": false,
"createdAt": "2022-04-29T13:21:00.000Z",
"updatedAt": "2022-04-25T11:19:13.000Z",
"assignedAt": null,
"finishedAt": "2022-04-25T11:19:13.000Z",
"creatorId": 209,
"updatorId": null,
"assignedToId": null,
"assignedById": null,
"finisherId": 213,
"validatorId": 213,
"facilityId": 3,
"categoryId": 37,
"companyId": 19,
"statusId": 1
},
"component": {
"id": 227421,
"name": "MEP_AFS_ALGIBE | Algibe AFS | 1482742",
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcFlowTerminal",
"externalIdentifier": "20541c64-f657-4680-b314-0a377e9e7a31-00169ff6",
"serialNumber": null,
"installatedOn": null,
"warrantyStartOn": null,
"replacedOn": null,
"barcode": null,
"assetIdentifier": "1482742",
"area": null,
"length": null,
"coordBottomLeftX": "448.8673",
"coordBottomLeftY": "435.8539",
"coordBottomLeftZ": "-8.1700",
"coordTopRightX": "450.3073",
"coordTopRightY": "437.2939",
"coordTopRightZ": "-6.8420",
"createdAt": "2021-06-21T17:27:13.000Z",
"updatedAt": null,
"creatorId": 1,
"spaceId": 980,
"typeId": 2261,
"facilityId": 3,
"type": {
"id": 2261,
"name": "Aparatos sanitarios | MEP_AFS_ALGIBE | Algibe AFS",
"description": "ALGIBE_AguaFríaSanitaria_Algibe AFS",
"modelNumber": null,
"modelReference": null,
"warrantyDurationParts": null,
"warrantyDurationLabor": null,
"externalSystem": "Autodesk Revit 2020, Build: 20200210_1400(x64)",
"externalObject": "IfcFlowTerminal",
"externalIdentifier": "fe602dae-d255-4f97-afc2-c8f4ac0a9014-00c7683a",
"replacementCost": null,
"expectedLife": null,
"warrantyDescription": null,
"nominalHeight": null,
"nominalLength": null,
"nominalWidth": null,
"shape": null,
"size": null,
"color": null,
"finish": null,
"grade": null,
"material": null,
"constituents": null,
"features": null,
"accessibilityPerformance": null,
"codePerformance": null,
"sustainabilityPerformance": null,
"company": null,
"warrantyGuarantorLabor": null,
"warrantyGuarantorParts": null,
"createdAt": "2022-04-21T15:31:57.000Z",
"creatorId": 1,
"manufacturerId": null,
"warrantyDurationUnitId": null,
"expectedLifeUnitId": null,
"facilityId": 3
},
"space": {
"id": 980,
"name": "S03_CUA_ALJ",
"category": null,
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcSpace",
"externalIdentifier": "24a5188c-a866-4c67-8e3d-1985db1db1f2-0028bb4f",
"roomTag": null,
"usableHeight": null,
"grossArea": "13.3711",
"netArea": "13.3711",
"volume": "28.9545",
"coordBottomLeftX": "447.8628",
"coordBottomLeftY": "433.4745",
"coordBottomLeftZ": "-8.4700",
"coordTopRightX": "451.1043",
"coordTopRightY": "441.2274",
"coordTopRightZ": "-6.2700",
"createdAt": "2021-06-21T14:34:12.000Z",
"creatorId": 1,
"floorId": 32,
"floor": {
"id": 32,
"name": "Sótano 3",
"category": "Piso",
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcBuildingStorey",
"externalIdentifier": "104147df-ddc4-40fe-8554-bfe5803e0bb2-00029358",
"elevation": "-8.4700",
"height": null,
"createdAt": "2021-05-11T09:56:27.000Z",
"creatorId": 1,
"facilityId": 3
}
}
}
}
],
"meta": {
"totalItems": 1,
"itemCount": 10,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
},
"links": {
"first": "/scheduled-tasks/11373/components?facilityId=1&page=1&limit=10",
"previous": "/scheduled-tasks/11373/components?facilityId=1&page=1&limit=10",
"next": "/scheduled-tasks/11373/components?facilityId=1&page=2&limit=10",
"last": "/scheduled-tasks/11373/components?facilityId=1&page=1&limit=10"
}
}
GET
One, by components ids, common and uncommon subtasks
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}/components/common-uncommon-subtasks?componentsIds=[1, 2, 3]&facilityId={{facilityId}}
Gets the common and uncommon subtask by components indicated as query param.
PARAMS
componentsIds
[1, 2, 3]
Array of number that are IDs of components.
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}/components/common-uncommon-subtasks?componentsIds=[1, 2, 3]&facilityId={{facilityId}}
GET
One, with components and subtasks
https://{{host}}:{{port}}/api/scheduled-tasks/{{scheduledTaskId}}/components/subtasks?facilityId=1&page=1&limit=10
Gets information about a scheduled task its components and its subtasks.
PARAMS
facilityId
1
Number that is the ID of the facility.
page
1
Number of the page.
limit
10
Number of elements per page.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/{{scheduledTaskId}}/components/subtasks?facilityId=1&page=1&limit=10
Example Response
200 - OK
{
"items": [
{
"id": 3036,
"createdAt": "2022-04-29T13:21:00.000Z",
"creatorId": 209,
"checkedDate": "2022-04-25T11:18:42.000Z",
"scheduledTasksId": 11373,
"componentsId": 227421,
"scheduledTask": {
"id": 11373,
"parent": "1342e89d-de15-4d66-b2d7-0cffbb40780c",
"name": "M-ALJIBE_PCI",
"frequencyQuantity": 1,
"timeSpent": 60,
"frequencyUnit": "months",
"filter": {
"exclusiveFilters": [],
"inclusiveFilters": [
{
"type": [
"ALGIBE AFS"
]
}
]
},
"strictDates": false,
"createdAt": "2022-04-29T13:21:00.000Z",
"updatedAt": "2022-04-25T11:19:13.000Z",
"assignedAt": null,
"finishedAt": "2022-04-25T11:19:13.000Z",
"creatorId": 209,
"updatorId": null,
"assignedToId": null,
"assignedById": null,
"finisherId": 213,
"validatorId": 213,
"facilityId": 3,
"categoryId": 37,
"companyId": 19,
"statusId": 1
},
"component": {
"id": 227421,
"name": "MEP_AFS_ALGIBE | Algibe AFS | 1482742",
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcFlowTerminal",
"externalIdentifier": "20541c64-f657-4680-b314-0a377e9e7a31-00169ff6",
"serialNumber": null,
"installatedOn": null,
"warrantyStartOn": null,
"replacedOn": null,
"barcode": null,
"assetIdentifier": "1482742",
"area": null,
"length": null,
"coordBottomLeftX": "448.8673",
"coordBottomLeftY": "435.8539",
"coordBottomLeftZ": "-8.1700",
"coordTopRightX": "450.3073",
"coordTopRightY": "437.2939",
"coordTopRightZ": "-6.8420",
"createdAt": "2021-06-21T17:27:13.000Z",
"updatedAt": null,
"creatorId": 1,
"spaceId": 980,
"typeId": 2261,
"facilityId": 3,
"space": {
"id": 980,
"name": "S03_CUA_ALJ",
"category": null,
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcSpace",
"externalIdentifier": "24a5188c-a866-4c67-8e3d-1985db1db1f2-0028bb4f",
"roomTag": null,
"usableHeight": null,
"grossArea": "13.3711",
"netArea": "13.3711",
"volume": "28.9545",
"coordBottomLeftX": "447.8628",
"coordBottomLeftY": "433.4745",
"coordBottomLeftZ": "-8.4700",
"coordTopRightX": "451.1043",
"coordTopRightY": "441.2274",
"coordTopRightZ": "-6.2700",
"createdAt": "2021-06-21T14:34:12.000Z",
"creatorId": 1,
"floorId": 32,
"floor": {
"id": 32,
"name": "Sótano 3",
"category": "Piso",
"description": null,
"externalSystem": "Autodesk Revit 2020, Build: 20190731_1515(x64)",
"externalObject": "IfcBuildingStorey",
"externalIdentifier": "104147df-ddc4-40fe-8554-bfe5803e0bb2-00029358",
"elevation": "-8.4700",
"height": null,
"createdAt": "2021-05-11T09:56:27.000Z",
"creatorId": 1,
"facilityId": 3
}
}
},
"scheduledTaskComponentsSubtasks": [
{
"id": 5475,
"code": "3",
"description": "COMPROBAR CIERRE Y APERTURA EN SISTEMA LLENADO",
"updatorId": 213,
"checkedOption": true,
"checkedDate": "2022-04-25T11:18:41.000Z",
"scheduledTaskComponentId": 3036
},
{
"id": 5476,
"code": "2",
"description": "VERIFICAR POSICION VÁLVULA (ASPIRACIÓN Y DESAGUE)",
"updatorId": 213,
"checkedOption": true,
"checkedDate": "2022-04-25T11:18:41.000Z",
"scheduledTaskComponentId": 3036
},
{
"id": 5477,
"code": "1",
"description": "OBSERVAR NIVEL DE AGUA",
"updatorId": 213,
"checkedOption": true,
"checkedDate": "2022-04-25T11:18:41.000Z",
"scheduledTaskComponentId": 3036
},
{
"id": 5579,
"code": "5",
"description": "COMPROBAR SUCIEDAD DEPÓSITO O ALJIBE (VACIADO,LIMPIEZA,LLENADO)",
"updatorId": 213,
"checkedOption": true,
"checkedDate": "2022-04-25T11:18:41.000Z",
"scheduledTaskComponentId": 3036
},
{
"id": 5582,
"code": "4",
"description": "COMPROBAR LIMPIEZA REBOSADERO",
"updatorId": 213,
"checkedOption": true,
"checkedDate": "2022-04-25T11:18:41.000Z",
"scheduledTaskComponentId": 3036
}
]
}
],
"meta": {
"totalItems": 1,
"itemCount": 10,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
},
"links": {
"first": "/scheduled-tasks/11373/components?facilityId=1&page=1&limit=10",
"previous": "/scheduled-tasks/11373/components?facilityId=1&page=1&limit=10",
"next": "/scheduled-tasks/11373/components?facilityId=1&page=2&limit=10",
"last": "/scheduled-tasks/11373/components?facilityId=1&page=1&limit=10"
}
}
PATCH
Finish all subtasks, by scheduled-task-component id
https://{{host}}:{{port}}/api/scheduled-tasks/component/{{componentId}}/finish-all?facilityId={{facilityId}}&checkedOption=true
Set the same option (true, false, null) to all the subtask of a component in a scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
checkedOption
true
Boolean to indicate the check option of all subtask to the component: true, false, null.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/component/{{componentId}}/finish-all?facilityId={{facilityId}}&checkedOption=true
PATCH
Finish scheduled-task-component
https://{{host}}:{{port}}/api/scheduled-tasks/component/{{scheduledTaskComponentSubtaskId}}/finish?facilityId={{facilityId}}&checkedOption=true
Set true, false or null to a subtask of a component in a scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
checkedOption
true
Boolean to indicate if the option of the subtask in the component.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks/component/{{scheduledTaskComponentSubtaskId}}/finish?facilityId={{facilityId}}&checkedOption=true
POST
Create
https://{{host}}:{{port}}/api/scheduled-tasks-components-subtask?facilityId={{facilityId}}&next=true
Creates a subtask related to the components in the scheduled task.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
next
true
Boolean to indicate if only afect to the current scheduled task or next too.
BODY raw
{
"code": "test 20",
"description": "soy una description",
"componentsIds": [1,2],
"scheduledTask" : {
"id": "1",
"parent" : "18dc0ff5-313a-42a5-9620-142dcad7004c",
"createdAt": "2022-02-06T09:40:00.000Z"
}
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks-components-subtask?facilityId={{facilityId}}&next=true
{
"code": "test 20",
"description": "soy una description",
"componentsIds": [1,2],
"scheduledTask" : {
"id": "1",
"parent" : "18dc0ff5-313a-42a5-9620-142dcad7004c",
"createdAt": "2022-02-06T09:40:00.000Z"
}
}
DELETE
Delete
https://{{host}}:{{port}}/api/scheduled-tasks-components-subtask?facilityId={{facilityId}}&next=true
Deletes the subtask related to the components in the scheduled task indicated.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
next
true
Boolean to indicate if the action is only to the current scheduled task or next too.
BODY raw
{
"code": "subtask2",
"componentsIds": [1, 3, 5, 11],
"scheduledTaskId": 1
}
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks-components-subtask?facilityId={{facilityId}}&next=true
{
"code": "subtask2",
"componentsIds": [1, 3, 5, 11],
"scheduledTaskId": 1
}
PATCH
Finish
https://{{host}}:{{port}}/api/scheduled-tasks-components-subtask/{{scheduledTaskComponentSubtaskId}}/finish?facilityId={{facilityId}}&checkedOption=null
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
checkedOption
null
Option to indicated true, false or null at the subtask of the component.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/scheduled-tasks-components-subtask/{{scheduledTaskComponentSubtaskId}}/finish?facilityId={{facilityId}}&checkedOption=null
GET
One
https://{{host}}:{{port}}/api/spaces/{{spaceId}}
Gets information about the space.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/spaces/1
Example Response
200 - OK
{
"id": 1,
"name": "Acceso Exterior",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "13.5700",
"netArea": "13.5700",
"volume": "33.9250",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"creatorId": 1,
"floorId": 1
}
GET
Components
https://{{host}}:{{port}}/api/spaces/{{spaceId}}/components
Gets componentes information of the space.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/spaces/{{spaceId}}/components
Example Response
200 - OK
[
{
"id": 1,
"name": "Acceso Exterior",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Equipos mecánicos",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bfb",
"serialNumber": "d14fcd-a5bfb",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000A5BFB",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 77,
"facilityId": 1
},
{
"id": 2371,
"name": "puerta para muro cortina | Un cristal de muro cortina | 612419",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Puertas",
"externalIdentifier": "74e375c6-4f6f-4c4a-9ca1-7c6fe83b7de8-00095843",
"serialNumber": "3b7de8-95843",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "95843",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 62,
"facilityId": 1
},
{
"id": 2808,
"name": "Suelo | Por defecto - 30 cm voladizo | 371161",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Suelos",
"externalIdentifier": "d539017c-4634-4317-a954-d89779c7b9ba-0005a9d9",
"serialNumber": "c7b9ba-5a9d9",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "0005A9D9",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:22.000Z",
"creatorId": 2,
"spaceId": 1,
"typeId": 71,
"facilityId": 1
}
]
POST
Filtered
https://{{host}}:{{port}}/api/spaces/filtered?facilityId={{facilityId}}&page=1&limit=2
Gets a list of spaces that match the filter in the param body.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of page.
limit
2
Number of elements per page.
BODY raw
{
"floors": [],
"spaces": [],
"types": [],
"names": ["mesa"],
"assetIdentifiers": []
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/spaces/filtered?facilityId={{facilityId}}&page=1&limit=2
{
"floors": [],
"spaces": [],
"types": [],
"names": ["mesa"],
"assetIdentifiers": []
}
Example Response
200 - OK
{
"items": [
{
"id": 10,
"name": "Aula 01",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bda",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "49.5085",
"netArea": "49.5085",
"volume": "123.7713",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 1,
"floorId": 3
},
{
"id": 11,
"name": "Aula 02",
"category": "",
"description": "",
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Espacios",
"externalIdentifier": "f81ecee3-d329-46cf-8cdc-643ff0d14fcd-000a5bdb",
"roomTag": null,
"usableHeight": "2.5000",
"grossArea": "51.1943",
"netArea": "51.1943",
"volume": "127.9860",
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T11:14:20.000Z",
"creatorId": 1,
"floorId": 3
}
],
"meta": {
"totalItems": 16,
"itemCount": 2,
"itemsPerPage": 2,
"totalPages": 8,
"currentPage": 1
}
}
GET
All
https://{{host}}:{{port}}/api/users?facilityId={{facilityId}}&page=1&limit=2
Gets a list of users.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
page
1
Number of page.
limit
2
Number of elements per page.
sortBy
text
String to indicate the name of the field to order.
order
DESC
String to indicate the order ASC or DESC.
name
text
String to filter by name of the user.
surname
text
String to filter by surname of the user.
email
text
String to filter by email of the user.
mobile
text
String to filter by mobile of the user.
rolesId
[1,2]
Array of numbers to filter by roleId
company
text
String to filter by name of the company.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/users?facilityId={{facilityId}}&page=1&limit=2
Example Response
200 - OK
{
"items": [
{
"id": 66,
"email": "encargado@mantenimiento.com",
"name": "Encargado",
"surname": "Mantenimiento",
"mobile": "91929394",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T21:41:01.000Z",
"updatedAt": "2021-11-09T17:24:10.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"addressId": 188,
"address": {
"id": 188,
"formattedAddress": "596 Spinka Pine",
"postalCode": "49712",
"city": "South Alexandreland",
"state": "Arkansas",
"country": "Tanzania",
"latitude": "-47.756700",
"longitude": "22.278300",
"createdAt": "2020-06-03T15:35:08.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": null
},
"company": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"userFacilityRoles": [
{
"id": 187,
"createdAt": "2020-06-03T17:12:29.000Z",
"updatedAt": "2021-11-09T17:24:10.000Z",
"creatorId": 1,
"updatorId": null,
"userId": 66,
"facilityId": 1,
"roleId": 5,
"role": {
"id": 5,
"name": "Usuario mantenimiento",
"description": "Usuario de una empresa de mantenimiento",
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null
}
}
]
},
{
"id": 69,
"email": "admin@mantenimiento.com",
"name": "Admin",
"surname": "Mantenimiento",
"mobile": "98989898",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T13:24:20.000Z",
"updatedAt": "2021-11-09T17:23:31.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"addressId": 128,
"address": {
"id": 128,
"formattedAddress": "387 Rosendo Views",
"postalCode": "54040",
"city": "Murphyland",
"state": "Connecticut",
"country": "Pitcairn Islands",
"latitude": "-51.436700",
"longitude": "-36.280800",
"createdAt": "2020-06-03T14:14:48.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": null
},
"company": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"userFacilityRoles": [
{
"id": 127,
"createdAt": "2020-06-03T04:40:20.000Z",
"updatedAt": "2021-11-09T17:23:31.000Z",
"creatorId": 1,
"updatorId": null,
"userId": 69,
"facilityId": 1,
"roleId": 4,
"role": {
"id": 4,
"name": "Administrador mantenimiento",
"description": "Administrador de una empresa de matenimiento",
"createdAt": "2020-06-03T23:51:17.000Z",
"updatedAt": "2020-06-19T09:24:23.000Z",
"creatorId": 1,
"updatorId": null
}
}
]
}
],
"meta": {
"totalItems": 61,
"itemCount": 2,
"itemsPerPage": 2,
"totalPages": 31,
"currentPage": 1
}
}
GET
One
https://{{host}}:{{port}}/api/users/{{userId}}?facilityId={{facilityId}}
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/users/{{userId}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 10,
"email": "serviciosgenerales4f1@empresa0cliente.com",
"name": "Servicios",
"surname": "Generales 9",
"mobile": "259070615",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T04:49:54.000Z",
"updatedAt": "2020-06-04T00:00:15.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 10,
"address": {
"id": 10,
"formattedAddress": "210 Dare Roads",
"postalCode": "38871-9147",
"city": "West Juanashire",
"state": "Ohio",
"country": "Zambia",
"latitude": "17.915500",
"longitude": "-30.655800",
"createdAt": "2020-06-03T20:16:10.000Z",
"updatedAt": "2020-06-19T09:24:21.000Z",
"creatorId": 1,
"updatorId": null
},
"company": {
"id": 1,
"cif": "B86142511",
"name": "Propiedad SL",
"createdAt": "2020-06-03T05:10:05.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 1,
"updatorId": 209,
"addressId": 103
},
"userFacilityRoles": []
}
POST
Create
https://{{host}}:{{port}}/api/users?facilityId={{facilityId}}
Creates a user.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "Servicios",
"surname": "Generales Nuevo",
"email": "serviciosgeneralesnuevo@imbi.com",
"password": "Password1_",
"companyId": 1,
"roleId": 1
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/users?facilityId={{facilityId}}
{
"name": "Servicios",
"surname": "Generales Nuevo",
"email": "serviciosgeneralesnuevo@imbi.com",
"password": "Password1_",
"companyId": 1,
"roleId": 1
}
PATCH
Edit
https://{{host}}:{{port}}/api/users/{{userId}}?facilityId={{facilityId}}
Updates the information of a user.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"email": "serviciosgenerales1f2@empresa0cliente.com",
"password": "Password1_",
"name": "Servicios",
"surname": "Generales 1",
"mobile": "902079017",
"roleId": 1,
"companyId": 1
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/users/{{userId}}?facilityId={{facilityId}}
{
"email": "serviciosgenerales1f2@empresa0cliente.com",
"password": "Password1_",
"name": "Servicios",
"surname": "Generales 1",
"mobile": "902079017",
"roleId": 1,
"companyId": 1
}
POST
Create
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/components/{{externalIdentifier}}?facilityId={{facilityId}}
Adds a component to a work order.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/components/{{externalIdentifier}}?facilityId={{facilityId}}
DELETE
Delete
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/components/{{componentId}}?facilityId={{facilityId}}
Delete a component from a work order.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
force
true
Boolean that indicates to delete the component and material related to it.
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/components/{{componentId}}?facilityId={{facilityId}}
POST
Create
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/materials?facilityId={{facilityId}}
Creates a material related to a workOrderComponentId relationship.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "Bombilla LED 2",
"quantity": 5,
"categoryId": 22,
"materialUnitId": 2,
"workOrderComponentsIds": [1, 2, 3]
}
Example Request
POST https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/materials?facilityId={{facilityId}}
{
"name": "Bombilla LED 2",
"quantity": 5,
"categoryId": 22,
"materialUnitId": 2,
"workOrderComponentsIds": [1, 2, 3]
}
PATCH
Edit
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/materials/{{materialId}}?facilityId={{facilityId}}
Updates the information of a material.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"name": "Bombilla LED2",
"quantity": 7,
"categoryId": 14,
"materialUnitId": 1,
"workOrderComponentsIds": [
1,
2
]
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/materials/{{materialId}}?facilityId={{facilityId}}
{
"name": "Bombilla LED2",
"quantity": 7,
"categoryId": 14,
"materialUnitId": 1,
"workOrderComponentsIds": [
1,
2
]
}
DELETE
Delete
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/materials/{{materialId}}?facilityId={{facilityId}}
Deletes a material.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
DELETE https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/materials/{{materialId}}?facilityId={{facilityId}}
GET
All
https://{{host}}:{{port}}/api/work-orders?page=1&limit=2
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
ids
[1496, 22]
Array of numbers to filter by workOrderId.
problemType
text
String to filter by subject of the problem type.
description
text
String to filter by description.
facilityName
text
String to filter by facility name.
companyName
text
String to filter by company name.
criticalityLevelIds
[]
Array of numbers to filter by criticalityLevelId.
workOrderStateIds
[]
Array of numbers to filter by workOrderStateId.
assignedUser
{{userId}}
Number to filter by userId assigned to the work order.
fromCreation
2020-06-28T22:00:00.000Z
Date in timezone format.
toCreation
2020-08-28T21:59:59.999Z
Date in timezone format.
fromInProgress
2020-04-30T22:00:00.000Z
Date in timezone format.
toInProgress
2020-08-31T21:00:00.000Z
Date in timezone format.
fromFinish
2020-08-31T21:00:00.000Z
Date in timezone format.
toFinish
2020-08-31T21:00:00.000Z
Date in timezone format.
fromClose
2020-08-31T21:00:00.000Z
Date in timezone format.
toClose
2020-08-31T21:00:00.000Z
Date in timezone format.
categoryName
text
String to filter by category name.
expired
false
Boolean to indicated if it does not finish on time.
fromStartedAt
2020-08-31T21:00:00.000Z
Date in timezone format.
toStartedAt
2020-08-31T21:00:00.000Z
Date in timezone format.
page
1
Number that is the page.
limit
2
Number of elements per page.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders?page=1&limit=2
Example Response
200 - OK
{
"items": [
{
"id": 22,
"description": "sdfsdfbsdfbgsdfbsd",
"photos": [],
"comment": null,
"workingTime": 135,
"workingTimeCost": "67.0000",
"createdAt": "2020-06-15T09:09:22.000Z",
"updatedAt": "2020-06-15T09:21:05.000Z",
"startedAt": "2020-06-15T09:15:43.000Z",
"assignedAt": "2020-06-15T09:21:05.000Z",
"blockedAt": null,
"finishedAt": null,
"closedAt": "2020-06-15T09:21:06.000Z",
"creatorId": 44,
"updatorId": 128,
"starterId": 44,
"assignerId": null,
"finisherId": null,
"closerId": 128,
"validatorId": null,
"problemTypeId": 101,
"criticalityLevelId": 1,
"incidenceId": 448,
"assignedCompanyId": 6,
"assignedUserId": 188,
"workOrderStateId": 5,
"categoryId": 1,
"parentWorkOrderId": null,
"criticalityLevel": {
"id": 1,
"name": "Urgente F1",
"time": 120,
"facilityId": 1
},
"parentWorkOrder": null,
"assignedCompany": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"problemType": {
"id": 101,
"text": "ELEC-CANALIZACIONES-OBTRUIDAS",
"facilityId": 1,
"categoryId": 1
},
"category": {
"id": 1,
"name": "ELECTRICIDAD",
"parentCategoryId": null
},
"creator": {
"id": 44,
"email": "serviciosgenerales@propiedad.com",
"name": "Fulano",
"surname": "Perez",
"mobile": "999666333",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T02:41:20.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 44,
"company": {
"id": 1,
"cif": "B86142511",
"name": "Propiedad SL",
"createdAt": "2020-06-03T05:10:05.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 1,
"updatorId": 209,
"addressId": 103
}
},
"assignedUser": {
"id": 188,
"email": "encargado@mantenimiento.com",
"name": "Encargado",
"surname": "Mantenimiento",
"mobile": "91929394",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T21:41:01.000Z",
"updatedAt": "2021-11-09T17:24:10.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"addressId": 188
}
},
{
"id": 1496,
"description": "Descripción generada automáticamente ",
"photos": null,
"comment": null,
"workingTime": 287,
"workingTimeCost": "16.9342",
"createdAt": "2019-10-10T04:48:30.000Z",
"updatedAt": "2019-10-18T01:48:30.000Z",
"startedAt": "2019-10-11T12:48:30.000Z",
"assignedAt": "2019-10-13T08:48:30.000Z",
"blockedAt": null,
"finishedAt": "2019-10-15T13:48:30.000Z",
"closedAt": "2019-10-18T01:48:30.000Z",
"creatorId": 44,
"updatorId": 124,
"starterId": 44,
"assignerId": 124,
"finisherId": 124,
"closerId": 124,
"validatorId": 71,
"problemTypeId": 9,
"criticalityLevelId": 3,
"incidenceId": 7912,
"assignedCompanyId": 6,
"assignedUserId": 124,
"workOrderStateId": 5,
"categoryId": 1,
"parentWorkOrderId": null,
"criticalityLevel": {
"id": 3,
"name": "Media F1",
"time": 1440,
"facilityId": 1
},
"parentWorkOrder": null,
"assignedCompany": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"problemType": {
"id": 9,
"text": "ELEC-CUADROS",
"facilityId": 1,
"categoryId": 1
},
"category": {
"id": 1,
"name": "ELECTRICIDAD",
"parentCategoryId": null
},
"creator": {
"id": 44,
"email": "serviciosgenerales@propiedad.com",
"name": "Fulano",
"surname": "Perez",
"mobile": "999666333",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T02:41:20.000Z",
"updatedAt": "2021-11-09T17:20:18.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 1,
"addressId": 44,
"company": {
"id": 1,
"cif": "B86142511",
"name": "Propiedad SL",
"createdAt": "2020-06-03T05:10:05.000Z",
"updatedAt": "2022-12-20T17:25:25.000Z",
"creatorId": 1,
"updatorId": 209,
"addressId": 103
}
},
"assignedUser": {
"id": 124,
"email": "adminmantenimiento1f1@empresa5mantenimiento.com",
"name": "Admin",
"surname": "Mantenimiento 3",
"mobile": "015710439",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T17:53:31.000Z",
"updatedAt": "2020-06-04T00:00:17.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"addressId": 124
}
}
],
"meta": {
"totalItems": 2,
"itemCount": 2,
"itemsPerPage": 2,
"totalPages": 1,
"currentPage": 1
}
}
GET
One
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}?facilityId={{facilityId}}
Gets information about a work order.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}?facilityId={{facilityId}}
Example Response
200 - OK
{
"id": 1496,
"description": "Descripción generada automáticamente ",
"photos": null,
"comment": null,
"workingTime": 287,
"workingTimeCost": "16.9342",
"createdAt": "2019-10-10T04:48:30.000Z",
"updatedAt": "2019-10-18T01:48:30.000Z",
"startedAt": "2019-10-11T12:48:30.000Z",
"assignedAt": "2019-10-13T08:48:30.000Z",
"blockedAt": null,
"finishedAt": "2019-10-15T13:48:30.000Z",
"closedAt": "2019-10-18T01:48:30.000Z",
"creatorId": 44,
"updatorId": 124,
"starterId": 44,
"assignerId": 124,
"finisherId": 124,
"closerId": 124,
"validatorId": 71,
"problemTypeId": 9,
"criticalityLevelId": 3,
"incidenceId": 7912,
"assignedCompanyId": 6,
"assignedUserId": 124,
"workOrderStateId": 5,
"categoryId": 1,
"parentWorkOrderId": null,
"assignedCompany": {
"id": 6,
"cif": "B94520951",
"name": "Mantenimiento 5 SL",
"createdAt": "2020-06-03T09:50:16.000Z",
"updatedAt": "2020-10-21T10:43:55.000Z",
"creatorId": 1,
"updatorId": 44,
"addressId": 108
},
"workOrderComponents": [
{
"id": 4564,
"createdAt": "2019-10-11T12:48:30.000Z",
"creatorId": 44,
"workOrderId": 1496,
"componentId": 534,
"component": {
"id": 534,
"name": "M_Codo - PVC - Serie 40 - DWV | Norma | 892490",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Uniones de tubería",
"externalIdentifier": "6139c66a-b8df-4f08-b89e-73da43a104f7-000d9e4a",
"serialNumber": "a104f7-d9e4a",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000D9E4A",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-01-28T10:42:45.000Z",
"updatedAt": "2020-10-13T11:20:31.000Z",
"creatorId": 3,
"spaceId": 52,
"typeId": 99,
"facilityId": 1
},
"workOrderMaterials": [
{
"id": 1916,
"quantity": 1,
"unitCost": "321.0901",
"createdAt": "2019-10-12T14:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 5
}
]
},
{
"id": 4565,
"createdAt": "2019-10-11T12:48:30.000Z",
"creatorId": 44,
"workOrderId": 1496,
"componentId": 916,
"component": {
"id": 916,
"name": "M_Te - Soldada - Genérica | Norma | 892602",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Uniones de tubería",
"externalIdentifier": "6139c66a-b8df-4f08-b89e-73da43a104f7-000d9eba",
"serialNumber": "a104f7-d9eba",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000D9EBA",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-01-28T10:42:45.000Z",
"updatedAt": "2020-10-13T11:20:30.000Z",
"creatorId": 3,
"spaceId": 52,
"typeId": 107,
"facilityId": 1
},
"workOrderMaterials": [
{
"id": 1917,
"quantity": 5,
"unitCost": "456.3893",
"createdAt": "2019-10-11T22:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 2
}
]
},
{
"id": 4566,
"createdAt": "2019-10-11T12:48:30.000Z",
"creatorId": 44,
"workOrderId": 1496,
"componentId": 1228,
"component": {
"id": 1228,
"name": "Montante rectangular | Montante rectangular - 5 x 10 cm | 610884",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Montantes de muro cortina",
"externalIdentifier": "3a250eef-19f5-43c1-981f-e4ee8eeafe48-00095244",
"serialNumber": "eafe48-95244",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "95244",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:20:34.000Z",
"creatorId": 2,
"spaceId": 42,
"typeId": 33,
"facilityId": 1
},
"workOrderMaterials": [
{
"id": 1918,
"quantity": 6,
"unitCost": "91.3680",
"createdAt": "2019-10-12T15:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 3
}
]
},
{
"id": 4567,
"createdAt": "2019-10-11T12:48:30.000Z",
"creatorId": 44,
"workOrderId": 1496,
"componentId": 2424,
"component": {
"id": 2424,
"name": "Silla-Apilable | Silla-Apilable | 477293",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Mobiliario",
"externalIdentifier": "41c2c467-bfa1-4b28-b6fa-2d797dde6341-0007486d",
"serialNumber": "de6341-7486d",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "0007486D",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:20:43.000Z",
"creatorId": 2,
"spaceId": 14,
"typeId": 27,
"facilityId": 1
},
"workOrderMaterials": [
{
"id": 1919,
"quantity": 3,
"unitCost": "24.1994",
"createdAt": "2019-10-13T03:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 4
}
]
},
{
"id": 4568,
"createdAt": "2019-10-11T12:48:30.000Z",
"creatorId": 44,
"workOrderId": 1496,
"componentId": 2634,
"component": {
"id": 2634,
"name": "Silla-Apilable | Silla-Apilable | 499745",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Mobiliario",
"externalIdentifier": "ae4962ce-b236-47fb-9b65-26c0034626de-0007a021",
"serialNumber": "4626de-7a021",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "0007A021",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-02-22T12:14:20.000Z",
"updatedAt": "2020-10-13T11:21:03.000Z",
"creatorId": 2,
"spaceId": 27,
"typeId": 27,
"facilityId": 1
},
"workOrderMaterials": [
{
"id": 1920,
"quantity": 1,
"unitCost": "265.6823",
"createdAt": "2019-10-12T10:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 4
}
]
},
{
"id": 4569,
"createdAt": "2019-10-11T12:48:30.000Z",
"creatorId": 44,
"workOrderId": 1496,
"componentId": 3022,
"component": {
"id": 3022,
"name": "Tipos de tubería | Idesie_Cobre | 892555",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Tuberías",
"externalIdentifier": "6139c66a-b8df-4f08-b89e-73da43a104f7-000d9e8b",
"serialNumber": "a104f7-d9e8b",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000D9E8B",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-01-28T10:42:45.000Z",
"updatedAt": "2020-10-13T11:20:29.000Z",
"creatorId": 3,
"spaceId": 52,
"typeId": 90,
"facilityId": 1
},
"workOrderMaterials": [
{
"id": 1921,
"quantity": 2,
"unitCost": "496.9941",
"createdAt": "2019-10-13T01:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 6
}
]
},
{
"id": 4570,
"createdAt": "2019-10-11T12:48:30.000Z",
"creatorId": 44,
"workOrderId": 1496,
"componentId": 3204,
"component": {
"id": 3204,
"name": "Tipos de tubería | Idesie_PVC | 892710",
"description": null,
"externalSystem": "Autodesk Revit 2019, Build: 20180216_1515(x64)",
"externalObject": "Tuberías",
"externalIdentifier": "8d36d14c-64d4-478a-b8f4-0cbd30d73e8f-000d9f26",
"serialNumber": "d73e8f-d9f26",
"installatedOn": "2020-02-02T00:00:00.000Z",
"warrantyStartOn": "2020-02-02T00:00:00.000Z",
"replacedOn": null,
"barcode": null,
"assetIdentifier": "000D9F26",
"area": null,
"length": null,
"coordBottomLeftX": null,
"coordBottomLeftY": null,
"coordBottomLeftZ": null,
"coordTopRightX": null,
"coordTopRightY": null,
"coordTopRightZ": null,
"createdAt": "2019-01-28T10:42:45.000Z",
"updatedAt": "2020-10-13T11:20:29.000Z",
"creatorId": 3,
"spaceId": 52,
"typeId": 91,
"facilityId": 1
},
"workOrderMaterials": [
{
"id": 1922,
"quantity": 5,
"unitCost": "813.4558",
"createdAt": "2019-10-13T15:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 1
}
]
}
],
"workOrderMaterials": [
{
"id": 1916,
"quantity": 1,
"unitCost": "321.0901",
"createdAt": "2019-10-12T14:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 5,
"material": {
"id": 13,
"name": "Cerradura",
"createdAt": "2020-06-15T09:19:15.000Z",
"creatorId": 188,
"categoryId": 2,
"category": {
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
}
}
},
{
"id": 1917,
"quantity": 5,
"unitCost": "456.3893",
"createdAt": "2019-10-11T22:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 2,
"material": {
"id": 13,
"name": "Cerradura",
"createdAt": "2020-06-15T09:19:15.000Z",
"creatorId": 188,
"categoryId": 2,
"category": {
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
}
}
},
{
"id": 1918,
"quantity": 6,
"unitCost": "91.3680",
"createdAt": "2019-10-12T15:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 3,
"material": {
"id": 13,
"name": "Cerradura",
"createdAt": "2020-06-15T09:19:15.000Z",
"creatorId": 188,
"categoryId": 2,
"category": {
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
}
}
},
{
"id": 1919,
"quantity": 3,
"unitCost": "24.1994",
"createdAt": "2019-10-13T03:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 4,
"material": {
"id": 13,
"name": "Cerradura",
"createdAt": "2020-06-15T09:19:15.000Z",
"creatorId": 188,
"categoryId": 2,
"category": {
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
}
}
},
{
"id": 1920,
"quantity": 1,
"unitCost": "265.6823",
"createdAt": "2019-10-12T10:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 4,
"material": {
"id": 13,
"name": "Cerradura",
"createdAt": "2020-06-15T09:19:15.000Z",
"creatorId": 188,
"categoryId": 2,
"category": {
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
}
}
},
{
"id": 1921,
"quantity": 2,
"unitCost": "496.9941",
"createdAt": "2019-10-13T01:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 6,
"material": {
"id": 13,
"name": "Cerradura",
"createdAt": "2020-06-15T09:19:15.000Z",
"creatorId": 188,
"categoryId": 2,
"category": {
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
}
}
},
{
"id": 1922,
"quantity": 5,
"unitCost": "813.4558",
"createdAt": "2019-10-13T15:48:30.000Z",
"updatedAt": "2020-06-28T15:49:31.000Z",
"creatorId": 203,
"updatorId": null,
"workOrderId": 1496,
"materialId": 13,
"materialUnitId": 1,
"material": {
"id": 13,
"name": "Cerradura",
"createdAt": "2020-06-15T09:19:15.000Z",
"creatorId": 188,
"categoryId": 2,
"category": {
"id": 2,
"name": "Cuadros",
"parentCategoryId": 1
}
}
}
],
"problemType": {
"id": 9,
"text": "ELEC-CUADROS",
"facilityId": 1,
"categoryId": 1
},
"criticalityLevel": {
"id": 3,
"name": "Media F1",
"time": 1440,
"facilityId": 1
},
"category": {
"id": 1,
"name": "ELECTRICIDAD",
"parentCategoryId": null
},
"parentWorkOrder": null,
"validator": {
"id": 71,
"email": "admin@cliente.com",
"name": "Admin",
"surname": "Cliente",
"mobile": "9988776655",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T00:38:24.000Z",
"updatedAt": "2021-11-09T17:21:44.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 9,
"addressId": 71
},
"assignedUser": {
"id": 124,
"email": "adminmantenimiento1f1@empresa5mantenimiento.com",
"name": "Admin",
"surname": "Mantenimiento 3",
"mobile": "015710439",
"photo": "https://lorempixel.com/200/200/people",
"isSuperAdmin": false,
"createdAt": "2020-06-03T17:53:31.000Z",
"updatedAt": "2020-06-04T00:00:17.000Z",
"creatorId": 1,
"updatorId": null,
"companyId": 6,
"addressId": 124
}
}
GET
All (Available Parents)
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/available-parents?facilityId={{facilityId}}
Gets the work orders that can be setting as previous.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
GET https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/available-parents?facilityId={{facilityId}}
PATCH
Edit
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}?facilityId={{facilityId}}
Updates the information of the work order.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
BODY raw
{
"problemTypeId": 108,
"description": "loremp ipsum dolor",
"assignedCompanyId": 6,
"categoryId": 17,
"criticalityLevelId": 8,
"parentWorkOrderId": null,
"assignedUserId": null,
"photos": [],
"workOrderMaterialsCosts": [],
"workingTime": null
}
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}?facilityId={{facilityId}}
{
"problemTypeId": 108,
"description": "loremp ipsum dolor",
"assignedCompanyId": 6,
"categoryId": 17,
"criticalityLevelId": 8,
"parentWorkOrderId": null,
"assignedUserId": null,
"photos": [],
"workOrderMaterialsCosts": [],
"workingTime": null
}
PATCH
Start
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/start?facilityId={{facilityId}}
Change the status of the work order from CREATED to IN_PROGRESS or BLOCKED (if it has a previous pending to finishes)
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/start?facilityId={{facilityId}}
PATCH
Finish
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/finish/{{email}}?facilityId={{facilityId}}
Finishes the work order with an email that represents the validator of the work order.
The email must be of a user rol 1, 2, 3, 6.
All components must have their materials, and workingTime cannot be null.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/finish/{{email}}?facilityId={{facilityId}}
PATCH
Close
https://{{host}}:{{port}}/api/work-orders/{{workOrderId}}/close?facilityId={{facilityId}}
Change the status of a work order to CLOSED.
PARAMS
facilityId
{{facilityId}}
Number that is the ID of the facility.
Example Request
PATCH https://api-dot-imbicloud.nw.r.appspot.com:80/api/work-orders/{{workOrderId}}/close?facilityId={{facilityId}}