Getting started with the REST API

Volver al principio

La API REST es el corazÛn de todas las interacciones program·ticas con HP Device as a Service Proactive Management con TechPulse (de ahÌ el nombre Proactive Management). Proactive Management proporciona dos tipos de API REST: API HP TechPulse Analytics y API HP Incident Integration.

  • La API HP TechPulse Analytics proporciona analÌtica significativa sobre la planificaciÛn, optimizaciÛn de costos y capacidades de gestiÛn de servicios de los dispositivos registrados en Proactive Management.
  • La API HP Incident Integration proporciona gestiÛn de incidentes para Proactive Management. 

 

 

Autenticar solicitudes de API

 

HP reconoce que la privacidad es un derecho humano fundamental, asÌ como tambiÈn la importancia de la privacidad, seguridad y protecciÛn de los datos de nuestros clientes y socios en todo el mundo. Independientemente de si usted es nuestro cliente o socio, puede contar en HP para la protecciÛn de sus datos a travÈs de todas nuestras operaciones. Para que sus aplicaciones accedan a las API de Proactive Management, deben autenticarse.  Proactive Management aprovecha el protocolo est·ndar de la industria OAuth 2.0 para otorgar el acceso, debido a su simplicidad y facilidad de implementaciÛn.

Lea nuestra secciÛn Autenticar con OAuth 2.0 para obtener una explicaciÛn detallada sobre cÛmo autenticar su aplicaciÛn e interactuar exitosamente con Proactive Management. 

 

 

Formatos de datos

Solicitar datos de las API

Todas las API REST regresan la informaciÛn solicitada en formato de datos JSON.

 
POST https://daas.api.hp.com/analytics/v1/reports/hwinv/details/type/grid
 
Respuesta de ejemplo

{
"totalResults": 10,
"startIndex": 0,
"itemsPerPage": 0,
"resources": [
{
"companyId": "12345",
"deviceType": "Notebook",
"dateListMonth": "Apr 2018",
"deviceCount": 10,
"dataAsOfDate": "04/03/2018",
"counterId": 69362,
"companyName": "company-name",
...
}
]
}
 

 

 

Entender la limitaciÛn de solicitudes

 

Todas las solicitudes de API REST son limitadas para evitar el abuso y garantizar la estabilidad.  El n˙mero exacto de llamadas que su aplicaciÛn puede hacer por dÌa varÌa con base en el tipo de solicitud que hace.  Encontrar· esta informaciÛn junto con la documentaciÛn para cada llamada de API especÌfica. La API de Proactive Management tiene una limitaciÛn de nivel de aplicaciÛn implementada y permite ˙nicamente cierto n˙mero total de llamadas que su aplicaciÛn puede hacer en un dÌa. Tenga en cuenta que para el propÛsito de la limitaciÛn de solicitudes, el "dÌa" del servidor de la API se define como el periodo de veinticuatro horas comenzando en la medianoche UTC y finalizando en la medianoche del siguiente dÌa.

 

 

Manejar grandes conjuntos de datos usando respuestas paginadas

 

Al hacer llamadas que regresan un gran n˙mero de resultados como una lista, con frecuencia ser· benÈfico paginar el conjunto de resultados.  Al solicitar subconjuntos m·s pequeÒos de datos, obtendr· una respuesta mucho m·s r·pida que cuando solicita el conjunto de datos completo y potencialmente de gran tamaÒo.

En llamadas que soportan el paginado del conjunto de resultados, pase los siguientes par·metros para controlar el tamaÒo y el punto de inicio de la p·gina:

Par·metros de paginado

Nombre
DescripciÛn
startIndex
Un entero indicando el Ìndice basado en 1 del resultado de la primera consulta.
count
Un entero indicando el n˙mero m·ximo deseado de resultados de consulta por p·gina.

 

Para paginar a travÈs de los resultados, comience con un valor de inicio de 0 y un valor de conteo de N.  Para obtener la siguiente p·gina, establezca el valor de inicio para N, mientras que el valor de conteo permanece igual.  Las p·ginas siguientes iniciar·n en 2N, 3N, 4N...

 

Habr· paginado todos los resultados cuando su start valor + valor de conteo >= el valor de "totalResults" en el conjunto de resultados.

Por ejemplo:

 

POST https://daas.api.hp.com/analytics/v1/reports/hwinv/details/type/grid?startIndex=20&count=10
 
Respuesta de ejemplo

{
"totalResults": 345,
"startIndex": 20,
"itemsPerPage": 10,
"resources": [
]
}
 

 

 

Control de datos de cambio

 

HP TechPulse Analytics

Solicitar datos despuÈs de una fecha especÌfica

 

Ejemplo - Lista de dispositivos registrados despuÈs de 2019-01-08
Solicitud de HTTP
POST /analytics/v1/reports//hwinv/details/type/grid?count=100&attributes=resources.deviceId,resources.counterId, totalResults HTTP/1.1
Host: daas.api.hp.com
Contenido-Tipo: application/json
AutorizaciÛn: Token de acceso del portador
Cuerpo: 
{
"filter": "datelistMonth gt \"2019-01-08T11:59:05Z\""
}


Respuesta de HTTP
{
"totalResults": 366,
"resources": [
{
"counterId": 14436,
"deviceId": "12345"
},
... // 366 registros
]
}

 

Solicitar datos entre fechas especÌficas

 

Ejemplo - Lista de dispositivos registrados entre 2019-01-08 y 2019-01-09
Solicitud de HTTP
POST /analytics/v1/reports//hwinv/details/type/grid?count=100&attributes=resources.deviceId,resources.counterId, totalResults HTTP/1.1
Host: daas.api.hp.com
Contenido-Tipo: application/json
AutorizaciÛn: Token de acceso del portador
Cuerpo: 
{
"filter": "datelistMonth gt \"2019-01-08T11:59:05Z\" and datelistMonth gt \"2019-01-09T11:59:05Z\" "
}


Respuesta de HTTP
{
"totalResults": 126,
"resources": [
{
"counterId": 68944,
"deviceId": "12345"
},
... // 126 registros
]
}
 
A continuaciÛn, algunos casos de uso del control de datos de cambio
 
Nombre del informe
Caso de uso
Ejemplo de filtro
Inventario de hardware
Dispositivos registrados tras una fecha especÌfica
Cuerpo: { "filter": "datelistMonth gt \"2019-01-08T11:59:05Z\"" }

 

HP TechPulse Incident Integration

Solicitar datos despuÈs de una fecha especÌfica

 

Ejemplo - Lista de incidentes creados despuÈs de 2019-03-05 00:00:00
Solicitud de HTTP
POST/analytics/v1/incidents/1.2/tenants/{tenantId}/incidents?filter=createdAt ge "2019-03-05 00:00:00"&startIndex=0&count=10 HTTP/1.1
Host: daas.api.hp.com
Contenido-Tipo: application/json
AutorizaciÛn: Token de acceso del portador
Cuerpo: 
{
    Carga solicitada: {tenantIds: []}
}


Respuesta de HTTP
{"totalResults":38,"startIndex":0,"itemsPerPage":10,
"resources":[
    {
        "id":123456,
        "guid":"XYZA-123456",
        "displayId":"456789",
        "createdAt":1551857130279,
        "updatedAt":1551857130292,
        "occuredAt":1551744000000,
        "description":"Se ha detectado poco espacio disponible para el disco (sn de disco, modelo de disco) en el dispositivo nombre-de-dispositivo con el usuario nombre-de-usuario, Usuario con sesiÛn iniciada= nombre-de-usuario. La cantidad de disco consumida es de 91-100 %. Si el disco tiene poco espacio disponible puede afectarse la estabilidad del sistema, la instalaciÛn de actualizaciones y el rendimiento. Sistema operativo del dispositivo: Windows 10.",
        "title":"Poco espacio en disco duro",
        "deviceId":"XYZ-12345678",
        "type":{"name":"HW_HEALTH","value":"Hardware Health"},
        "subtype":{"name":"HDD_STORAGE_FULL","value":"HDD Storage Capacity Full"},
        "os":"Windows10",
        "tenantId":"abcdef12-3456-789g-hi0j-k11l121314lm",
        "userId":"abcdef12-3456-789g-hi0j-k11l121314lm",
        "sourceId":"123456",
        "sourceLocation":"predalerts",
        "priority":{"name":"CRITICAL","value":"Critical"},
        "status":{"name":"NEW","value":"New"},
        "lastAssigeeUpdatedAt":0,
        "lastStatusUpdatedAt":1551857130279,
        "metadata":"{\"metaDataName\":\"SerialNumber\",\"metaDataProperty\":\"enabled\",\"metaDataValue\":\"device-sn\",\"metaDataUnit\":null}",
        "measureId":"123",
        "companyDetails":
            {
                "id":456,
                "tenantId":"abcdef12-3456-789g-hi0j-k11l121314lm",
                "companyName":"company-name",
                "isDeleted":false
            },
        "userDetails":
            {
                "id":789,
                "userId":"abcdef12-3456-789g-hi0j-k11l121314lm",
                "userName":"user-name",
                "emailId":"user-name@hp.com",
                "isDeleted":false
            },
        "deviceDetails":
            {
                "id":284,
                "deviceId":"abcdef12-3456-789g-hi0j-k11l121314lm",
                "deviceName":"device-name",
                "serialNumber":"device-sn",
                "deviceModel":"device-model",
                "deviceManufacturer":"HP",
                "isDeleted":false
            },
        "isDeleted":false
    },
.....
]}

 

Solicitar datos entre fechas especÌficas

 

Ejemplo - Lista de incidentes actualizados entre 2019-01-08 y 2019-03-15
Solicitud de HTTP
POST /analytics/v1/incidents/1.2/tenants/{tenantId}/incidents?filter=updatedAt ge "2019-01-08 00:00:00"&updatedAt le "2019-03-15 23:59:59"&startIndex=0&count=10 HTTP/1.1
Host: daas.api.hp.com
Contenido-Tipo: application/json
AutorizaciÛn: Token de acceso del portador
Cuerpo: 
{
  {tenantIds: []}
}


Respuesta de HTTP
{"totalResults":38,"startIndex":0,"itemsPerPage":10,
"resources":[
    {
        "id":123456,
        "guid":"XYZA-123456",
        "displayId":"456789",
        "createdAt":1551857130279,
        "updatedAt":1551857130292,
        "occuredAt":1551744000000,
        "description":"Se ha detectado poco espacio disponible para el disco (sn de disco, modelo de disco) en el dispositivo nombre-de-dispositivo con el usuario nombre-de-usuario, Usuario con sesiÛn iniciada= nombre-de-usuario. La cantidad de disco consumida es de 91-100 %. Si el disco tiene poco espacio disponible puede afectarse la estabilidad del sistema, la instalaciÛn de actualizaciones y el rendimiento. Sistema operativo del dispositivo: Windows 10.",
        "title":"Poco espacio en disco duro",
        "deviceId":"XYZ-12345678",
        "type":{"name":"HW_HEALTH","value":"Hardware Health"},
        "subtype":{"name":"HDD_STORAGE_FULL","value":"HDD Storage Capacity Full"},
        "os":"Windows10",
        "tenantId":"abcdef12-3456-789g-hi0j-k11l121314lm",
        "userId":"abcdef12-3456-789g-hi0j-k11l121314lm",
        "sourceId":"123456",
        "sourceLocation":"predalerts",
        "priority":{"name":"CRITICAL","value":"Critical"},
        "status":{"name":"NEW","value":"New"},
        "lastAssigeeUpdatedAt":0,
        "lastStatusUpdatedAt":1551857130279,
        "metadata":"{\"metaDataName\":\"SerialNumber\",\"metaDataProperty\":\"enabled\",\"metaDataValue\":\"device-sn\",\"metaDataUnit\":null}",
        "measureId":"123",
        "companyDetails":
            {
                "id":456,
                "tenantId":"abcdef12-3456-789g-hi0j-k11l121314lm",
                "companyName":"company-name",
                "isDeleted":false
            },
        "userDetails":
            {
                "id":789,
                "userId":"abcdef12-3456-789g-hi0j-k11l121314lm",
                "userName":"user-name",
                "emailId":"user-name@hp.com",
                "isDeleted":false
            },
        "deviceDetails":
            {
                "id":284,
                "deviceId":"abcdef12-3456-789g-hi0j-k11l121314lm",
                "deviceName":"device-name",
                "serialNumber":"device-sn",
                "deviceModel":"device-model",
                "deviceManufacturer":"HP",
                "isDeleted":false
            },
        "isDeleted":false
    },
.....
]}