Home
Requisitos de hardware y software Collapse menú
Estructuras y componentes Collapse menú
Instalación Collapse menú
Licenciamiento ADM Collapse menú
Configuraciones Generales Collapse menú
Configuración ADM Collapse menú
Configuración Broker Collapse menú
Inventario Collapse menú
Software Collapse menú
Portal Autogestión Collapse menú
Políticas Collapse menú
Reglas Collapse menú
Reportes Collapse menú
Alertas Collapse menú
Utilitarios Collapse menú
Integración API ADM Collapse menú
Integración Intel EMA Collapse menú
Control remoto (Ambientes Cloud) Collapse menú
Adobe PDF

Descargar PDF
    Operaciones expuestas por ADM

    La sección de Operaciones expuestas por ADM se compone de los siguientes módulos:

    También puede ver esta informacion usando la url de la consola ejemplo: http://192.0.0.1/ADMAPI/DOCS/

    Distribución

    Obtener listado de proyecto de distribución

    Verbo: POST
    Url: {url}/distribution
    Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    search Valor por el cual se filtrará en la busqueda Texto no -
    orderField Campo por el cual se ordenará el listado Texto si creationDate,
    creatorUserName,
    desciption,
    lastExecutionDate,
    name, platform
    , type
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Texto si ASC,DESC
    pageSize Campo que indica la cantidad de resultados que se espera en la respuesta Entero si -
    pagines Campo que indica el número de resultado obtenido en consultas anteriores. Este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta del API:

    • Código: 200 – Successful - Respuesta:
    Campo Descripción Tipo
    creationDate Fecha de creación de la distribución Fecha
    creatorUserName Nombre del usuario que creó la distribución Texto
    description Descripción que se dio a la distribución Texto
    id Identificador de la distribución Entero
    lastExecutionDate Fecha de la última ejecución que se hizo de esta distribución Fecha
    name Nombre que se le asignó a la ejecución Texto
    packageCount Conteo de pauqetes que contiene la distribución Entero
    platform Tipo de plataforma en la que se creó la distribución Texto
    type Tipo de distribución agente o software Texto
    updateDate Fecha de actualizacion del proyecto Fecha
    • Código: 400 - Bad request - Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server - Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envían.
      • ValidationError si no se envía uno de los valores obligatorios.


    Software

    Obtener listado de software

    Verbo: POST
    Url: {url}/software
    Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    search Valor por el cual se filtrará en la busqueda Texto no -
    orderField Campo por el cual se ordenará el listado Texto si id,
    installations,
    IsInventory,
    manufacturer,
    manufacturerId,
    name
    , platform
    , version
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Texto si ASC,DESC
    pageSize Campo que indica la cantidad de resultados que se espera en la respuesta Entero si -
    pagines Campo que indica el número de resultado obtenido en consultas anteriores. Este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta APi:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    id Identificador de la distribución Entero
    installations Obtiene la cantidad de dispositivos donde se encuentra instalado Entero
    IsInventory Indica si es del inventario (True = si, False = no) Booleano
    manufacturer Nombre del fabricante del software Texto
    manufacturerId Identificador del fabricante del software dentro de ADM Entero
    name Nombre del software Texto
    platform Plataforma para la que fue creado el software Texto
    type Tipo de software Texto
    version Versión del software Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envían
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el listado de software del dispositivo

    Verbo: POST
    Url: {url}/device/{id}/software/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificación no -  
    Search Valor por el cual se filtrará en la busqueda Texto no -
    orderField Campo por el cual se ordenará el listado Texto si id,
    manufacturer,
    name,
    version
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Texto si ASC,DESC
    pageSize Campo que indica la cantidad de resultados que se espera en la respuesta Entero si -
    pageIndex Campo que indica el número de resultado obtenido en consultas anteriores. Este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    date Fecha del software Fecha
    manufacturer Nombre del fabricante del software Texto
    name Nombre del producto Texto
    type Tipo de software Texto
    uninstallString Comando de desinstalacion del software Texto
    version Versión del software Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios


    Dispositivos

    Obtiene el resumen del listado de dispositivos

    Verbo*: POST
    Url: {url}/device/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No -
    orderField Campo por el cual se ordenará el listado Texto Si name,
    userName,
    description,
    responsibleUserName
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text Si ASC, DESC
    pageSize Este campo indica la cantidad de resultados que se espera en la respuesta Entero si -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anteriores, este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: True
    Campo Descripción Tipo
    agentProfile Describe el prefil de agente que tiene asignado el dispositivo Texto
    agentVersion Describe la versión del perfil del agente Texto
    completeIpAddress Dirección IP del dispositivo Texto
    cpuCore Numero de núcelos de CPU Entero
    cpuLogic Numero de núcleos lógicos Entero
    creationDate Fecha de creación del dispositivo en ADM Texto
    daysSinceLastInventory Días desde que se hizo el último inventario del dispositivo Entero
    diskAviable Cantidad de disco disponible Numérico
    diskTotal Cantidad de tamaño del disco Numérico
    description Descripción que se le ha dado al dispositivo Texto
    discovery Informa si el dispositivo fue descubierto Boolean
    diskUsage Porcentaje de uso del disco duro Numérico
    domain Dominio al cual pertenece el dispositivo Texto
    id Identificador del dispositivo Entero
    ipRegistred Ip con la que fue registrado el dispositvo Texto
    ipAddress Listado de direcciones Ip asignadas al dispositivo Listado de texto
    lastInventory Fecha en la que se ejecutó el último inventario Fecha
    macAddress Listado de direcciones mac asignadas al dispositivo Listado de texto
    macAddressRegister Dirección mac registrada Alfanumérico
    maufacturer Fabricante del dispositivo Texto
    memoryUsage Porcentaje de uso de la memoria Numérico
    model Modelo del dispositivo Texto
    name Nombre del dispositivo Texto
    operatingSystem Sistema operativo del dispositivo Texto
    operatingSystemVersion Versión del sistema operativo instaldo en el dispositivo Texto
    responsibleUserEmail Correo electrónico del responsable del dispositivo Texto
    responsibleUserId Identificador del responsable del dispositivo Texto
    responsibleUserName Nombre del responsable del dispositivo Texto
    serial Serial de la máquina Texto
    status Estado del dispositivo Texto
    totalRam Total de memoria RAM del dispositivo Numérico
    type Tipo de dispositivo (PC, servidor, laptop) Texto
    userName Nombre del usuario en la máquina Texto
    vistualization Tipo de virtualización (Esxi55, HyperV2) Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene un listado de discos lógicos de un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/logicaldisk/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No -
    orderField Campo por el cual se ordenará el listado Texto Si driverType,
    fileSystem,
    mediaType,
    serial,
    unit,
    volumeName
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text Si ASC, DESC
    pageSize Este campo indica la cantidad de resultados que se espera en la respuesta Entero si -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anterioes, este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    driverType Tipo de unidad Texto
    fileSystem Tipo de sistema de archivos usado en esa unidad. Por ejemplo, FAT, FAT32, NTFS, CDFS Texto
    freeSpace Espacio de disco libre Numérico
    name Nombre de la unidad Texto
    usedSpace Espacio usado en disco Numérico
    volumenName Nombre del volumen de disco Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el listado de monitores del dispositivo

    Verbo: POST
    Url: {url}/device/{id}/display/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No Los valores por los cuales se pueden filtrar:
    - Fabricante
    - Modelo
    - Nombre
    - serial
    orderField Campo por el cual se ordenará el listado Texto Si manufacturer,
    model,
    name,
    version,
    serial
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text Si ASC, DESC
    pageSize Este campo indcia la cantidad de resultados que se espera en la respuesta Entero si -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anterioes, este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    date Fecha de fabricacion Fecha
    manufacturer Fabricante del monitor Texto
    model Modelo del monitor Texto
    name Nombre del monitor Texto
    version Obtiene o establece versión de la estructura EDID del monitor EDID=Extended display identification data Texto
    serial Serial del monitor Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el listado de adaptadores de red del dispositivo

    Verbo: POST
    Url: {url}/device/{id}/networkAdapter/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No Los valores por los cuales se pueden filtrar:
    - Nombre de adaptador
    orderField Campo por el cual se ordenará el listado Texto Si adapterName
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text Si ASC, DESC
    pageSize Este campo indcia la cantidad de resultados que se espera en la respuesta Entero si -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anterioes, este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    addressList Almacena las direcciones IP con sus respectivas mascaras de red que tiene una tarjeta de red Listado de texto
    description Descripción del adaptador de red Texto
    dhcpServer Dirección IP del servidor DHCP Texto
    dnsList Almacena las direcciones IP configuradas para el dns Texto
    gatewayList Almacena las direcciones IP configuradas para el Gateway Texto
    isDhcpEnable Indica si la IP de la estación fue establecida mediante un servidor DHCP Bool
    isLmHostsEnabled Si el LMHOSTS (LAN Manager Hosts) está habilitado o no Bool
    leaseExpires Fecha en la cual se vence la direccion IP obtenida por el servidor DHCP Fecha
    leaseObtained Fecha en la cual fue asignada la direccion IP obtenida por el servidor DHCP Fecha
    macAddress Número de identificacion MAC asociada a la tarjeta de red de la estación Texto
    maskList Almacena las máscaras de red que tiene una tarjeta de red Listado de Texto
    networkAdapterType Clasificación del adaptador de red (ethernet, Token ring, etc…) Texto
    Speed Velocidad de la tearjeta de red Numérico
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envían
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el listado de slot de memoria del dispositivo

    Verbo: POST
    Url: {url}/device/{id}/memory/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No Los valores por los cuales se pueden filtrar:
    - Serial,
    - Nombre,
    - Fabricante
    - Modelo
    orderField Campo por el cual se ordenará el listado Texto Si id,
    bank,
    fromFactor,
    handler,
    manufacturer,
    model,
    name,
    serial
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text Si ASC, DESC
    pageSize Este campo indcia la cantidad de resultados que se espera en la respuesta Entero si -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anterioes, este campo se usa en conjunto con pageSize para la paginación Entero si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    bank Banco de memoria Texto
    factor Factor de slot de memoria Texto
    handler Physical handle de la memoria Texto
    id Identificador del slot de memoria Numérico
    manufacturer Nombre del fabricante Texto
    model Modelo de la memoria Texto
    name Nombre de la ranura de memoria Texto
    serial Serial de la memoria Texto
    size Tamaño de memoria en el slot, si no existe una memoria asignada el valor será 0 Numérico
    speed Velocidad de la memoria Numérico
    type Tipo de memoria Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el listado de CD ROM del dispositivo

    Verbo: POST
    Url: {url}/device/{id}/cdrom/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No Los valores por los cuales se pueden filtrar:
    - Modelo
    orderField Campo por el cual se ordenará el listado Texto Si bustype,
    model,
    serial
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text No ASC, DESC
    pageSize Este campo indcia la cantidad de resultados que se espera en la respuesta Entero No -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anterioes, este campo se usa en conjunto con pageSize para la paginación Entero No -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    bus Tipo de bud del CD ROM Texto
    Feature Obtiene o establece unformación de las características de las unidas de CD ROM Listado Texto
    model Modelo de la unidad de CR ROM Texto
    name Nombre del monitor Texto
    Hardware Id Indentificador del hardware Texto
    serial Serial del CD ROM Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el listado de tarjetas madre del dispositivo

    Verbo: POST
    Url: {url}/device/{id}/boardSlot/list Parámetros para esta petición que se deben enviar en el cuerpo de la petición

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No Los valores por los cuales se pueden filtrar:
    - Nombre
    orderField Campo por el cual se ordenará el listado Texto Si slotld,
    name
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text No ASC, DESC
    pageSize Este campo indcia la cantidad de resultados que se espera en la respuesta Entero No -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anterioes, este campo se usa en conjunto con pageSize para la paginación Entero No -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    description Si el slot está en uso o está disponible Texto
    name Nombre del slot Texto
    slotld Identificador único del slot en board Texto
    type Tipo del slot Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el listado de impresoras del dispositivo

    Verbo: POST
    Url: {url}/device/{id}/printer/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición

    Campo Descripción Tipo Obligatorio Posibles valores
    updateDate Valor de fecha que se filtra la modificacion Fecha No -
    search Valor por el cual se filtrará en la búsqueda Texto No Los valores por los cuales se pueden filtrar:
    - Nombre del driver
    - Fabricante
    - Nombre de la impresora
    orderField Campo por el cual se ordenará el listado Texto Si id,
    driverName,
    printerName,
    manufacturer
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text No ASC, DESC
    pageSize Este campo indcia la cantidad de resultados que se espera en la respuesta Entero No -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anterioes, este campo se usa en conjunto con pageSize para la paginación Entero No -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    description Breve descripción de la impresora (si se registró en la configuración de la impresora) Texto
    name Nombre del controlador del periférico Texto
    manufacturer Fabricante de la impresora Texto
    port Puerto de comunicaciones al cual está conectada la impresora Texto
    printerName Nombre de la impresora Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios

    Eliminar los archivos de una extensión especifica en un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/extension/{extension}] Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    id Representa el identificador del dispositivo al cual se le van a eliminar los archivos Entero Si -
    extension Extensión del archivo que se quiere eliminar del dispositivo. Texto Si jpg, png, pdf, etc…

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest si la extensión es vacía. Si la ID del dispositivo no es mayor a 1
      • ValidationError si no se envía uno de los valores obligatorios

    Reiniciar un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/restart
    Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    id Representa el identificador del dispositivo en el cual se va a ejecutar la acción Entero Si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest Si la ID del dispositivo no es mayor a 1
      • ValidationError si no se envía uno de los valores obligatorios

    Enviar un mensaje a un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/message/{text}
    Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    id Representa el identificador del dispositivo en el cual se va a ejecutar la acción. Entero Si -
    text Mensaje que se quiere enviar al dispositivo. Texto Si hello world!

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest Si la ID del dispositivo no es mayor a 1. Si el mensaje es vacío o no se envía.
      • ValidationError si no se envía uno de los valores obligatorios

    Encender un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/wakeonlan
    Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    id Representa el identificador del dispositivo en el cual se va a ejecutar la acción. Entero Si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest Si la ID del dispositivo no es mayor a 1
      • ValidationError si no se envía uno de los valores obligatorios

    Apagar un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/shutdown
    Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    id Representa el identificador del dispositivo en el cual se va a ejecutar la acción. Entero Si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest Si la ID del dispositivo no es mayor a 1
      • ValidationError si no se envía uno de los valores obligatorios

    Desinstalar un software de un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/software/{softwareId}/uninstall Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    id Representa el identificador del dispositivo en el cual se va a ejecutar la acción. Entero Si -
    softwareId Representa el identificador del software que se quiere desinstalar. Entero Si -

    Parámetros para esta petición que se deben enviar en el cuerpo de la petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    unistallString Describe el comando para la desinstalación silenciosa Entero Si -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: true
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest Si la ID del dispositivo no es mayor a 1. Si no se envía la cadena de instalación
      • ValidationError si no se envía uno de los valores obligatorios

    Distribuir software/agente a un dispositivo

    Verbo: POST
    Url: {url}/device/{id}/distribution/{distributionId}
    Parámetros para esta petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    id Representa el identificador del dispositivo en el cual se va a ejecutar la acción. Entero Si -
    distributionId Representa el identificador de la distribución que se va a ejecutar. Entero Si -

    Parámetros para esta petición que se deben enviar en el cuerpo de la petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    executionName Nombre que se le va dar a la ejecución. Si no se envía, el nombre será la fecha en que se crea la ejecución. Texto No -

    Respuesta del API:

    • Código: 200 – Successful Respuesta: el siguiente es el cuerpo de la respuesta, donde se encuentra la ID de la ejecución
    Campo Descripción Tipo
    id Identificador de la ejecución creada Entero
    setupProjectId Identificador del proyecto de distribución enviado Entero
    executionName Nombre de la ejecución creada Texto
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest Si la ID del dispositivo no es mayor a 1. Si la ID de la distribución no es mayor a 0
      • ValidationError si no se envía uno de los valores obligatorios

    Obtiene el resumen del listado de procesadores

    Verbo: POST
    Url: {url}/device/{id}/processor/list
    Parámetros para esta petición que se deben enviar en el cuerpo de la petición:

    Campo Descripción Tipo Obligatorio Posibles valores
    search Valor por el cual se filtrará en la búsqueda Texto No Modelo
    Fabricante
    Familia
    orderField Campo por el cual se ordenará el listado Texto Si coreCount
    family
    features
    frequency
    logicalProcessors
    manufacturer
    model
    serial
    socket
    speed
    orderType Campo que indica el tipo de ordenamiento, ascendente o descendente Text Si ASC, DESC
    pageSize Este campo indica la cantidad de resultados que se espera en la respuesta Entero No -
    pageIndex Este campo indica el número de resultado que hemos obtenido en consultas anteriores, este campo se usa en conjunto con pageSize para la paginación Entero No -

    Respuesta API:

    • Código: 200 – Successful Respuesta: true
    Campo Descripción Tipo
    totalItems Cantidad de procesadores del dispositivo Entero
    content EL objeto de respuesta Arreglo
    coreCount Cantidad de núcleos Entero
    family Familia del procesador Texto
    features Características del procesador Texto
    frequency Velocidad del procesador Entero
    label Etiqueta del socket Texto
    logicalProcessors Cantidad de procesadores lógicos Entero
    manufacturer Fabricante del procesador Texto
    model Modelo del procesador Texto
    serial Serial del procesador Texto
    socket Identificación del socket del procesador Texto
    speed Velocidad máxima del procesador Entero
    • Código: 400 - Bad request Respuesta: Mensaje con descripción del error
    • Código: 401- Error: Unauthorized Respuesta: Se ha denegado la autorización
    • Código: 500 - Internal Error Server Respuesta: Mensaje con descripción del error
      • BadRequest los parámetros de búsqueda no se envía
      • ValidationError si no se envía uno de los valores obligatorios