Getting started with the REST API

Voltar para o inÌcio

A API REST È o coraÁ„o de todas as interaÁıes program·ticas com a Gest„o proativa de dispositivo HP como um serviÁo com TechPulse (doravante referida como Gest„o proativa). A Gest„o proativa oferece dois tipos de APIs REST: API HP TechPulse Analytics e API de integraÁ„o de incidentes HP.

  • A API HP TechPulse Analytics oferece an·lises amplas sobre otimizaÁ„o de planejamento e custo e capacidades de gest„o de serviÁo de dispositivos inscritos na Gest„o proativa.
  • A API de integraÁ„o de incidentes HP oferece gest„o de incidentes para incidentes com a Gest„o proativa. 

 

 

AutenticaÁ„o de solicitaÁıes de API

 

A HP reconhece que a privacidade È um direito humano fundamental e a import‚ncia da privacidade, da seguranÁa e da proteÁ„o dos dados de nossos clientes e parceiros em todo o mundo. Seja vocÍ um cliente ou parceiro, saiba que pode contar com a HP para a proteÁ„o de seus dados em todas as nossas operaÁıes. Para que seus aplicativos acessem as APIs de Gest„o proativa, eles precisam estar autenticados.  A Gest„o proativa utiliza o protocolo OAuth 2.0 , que È padr„o na ind˙stria, para concess„o de acesso, graÁas ‡ sua simplicidade e facilidade de implementaÁ„o.

Leia nossa seÁ„o AutenticaÁ„o com OAuth 2.0 para um guia detalhado de como autenticar seu aplicativo e interagir corretamente com as APIs REST da Gest„o proativa. 

 

 

Formatos de dados

SolicitaÁ„o de dados das APIs

Todas as APIs REST retornam informaÁıes solicitadas no formato de dados JSON.

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

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

 

 

Como entender a aceleraÁ„o de solicitaÁıes

 

Todas as solicitaÁıes de API REST s„o aceleradas para evitar abusos e garantir estabilidade.  O n˙mero exato de chamadas que seu aplicativo pode fazer por dia varia com base no tipo de solicitaÁ„o que vocÍ est· fazendo.  VocÍ encontrar· essas informaÁıes juntamente com a documentaÁ„o para cada chamada API especÌfica. A API de Gest„o proativa possui um acelerador de nÌvel de aplicativo e oferece um certo n˙mero total de aplicativos que seu aplicativo pode fazer por dia. Observe que, para fins de aceleraÁ„o de solicitaÁıes, o "dia" do servidor da API È definido como o perÌodo de vinte e quatro horas que comeÁa ‡ meia-noite, fuso UTC, e termina na meia-noite do dia seguinte.

 

 

Processar grandes conjuntos de dados usando respostas paginadas

 

Ao fazer chamadas que retornam um grande n˙mero de resultados como uma lista, muitas vezes È benÈfico paginar o conjunto de resultados.  Ao solicitar subconjuntos menores de dados, vocÍ receber· uma resposta mais rapidamente do que ao solicitar um conjunto de dados inteiro e potencialmente grande.

Em chamadas com suporte para paginaÁ„o do conjunto de resultados, passe os seguintes par‚metros para controlar o tamanho e o ponto de partida da p·gina:

Par‚metros de paginaÁ„o

Nome
DescriÁ„o
startIndex
Um n˙mero inteiro indicando o Ìndice de 1 base do primeiro resultado da consulta.
contagem
Um n˙mero inteiro indicando o n˙mero m·ximo desejado de resultados de consulta por p·gina.

 

Para paginar os resultados, comece com um valor inicial de 0 e um valor de contagem de N. Para obter a prÛxima p·gina, defina o valor inicial para N, enquanto o valor da contagem permanece o mesmo.  As p·ginas subsequentes comeÁar„o em 2N, 3N, 4N...

 

VocÍ ter· chamado todos os resultados assim que o seu valor inicial + valor de contagem >= o valor de "totalResults" no conjunto de resultados.

Por exemplo:

 

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

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

 

 

Alterar o controle de dados

 

HP TechPulse Analytics

SolicitaÁ„o de dados apÛs data-hora especÌfica

 

Exemplo - Lista de dispositivos inscritos apÛs 08/01/2019
SolicitaÁ„o 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
Content-Type: application/json
AutorizaÁ„o: Token de acesso do portador
Body: 
{
"filter": "datelistMonth gt \"2019-01-08T11:59:05Z\""
}


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

 

SolicitaÁ„o dados entre data-hora especÌfica

 

Exemplo - Lista de dispositivos inscritos entre 08/01/2019 e 09/01/2019
SolicitaÁ„o 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
Content-Type: application/json
AutorizaÁ„o: Token de acesso do portador
Body: 
{
"filter": "datelistMonth gt \"2019-01-08T11:59:05Z\" and datelistMonth gt \"2019-01-09T11:59:05Z\" "
}


Resposta de HTTP
{
"totalResults": 126,
"resources": [
{
"counterId": 68944,
"deviceId": "12345"
},
... // 126 registros
]
}
 
Abaixo alguns casos de uso do controle de dados de mudanÁa
 
Nome do relatÛrio
Caso de uso
Exemplo de filtro
Invent·rio de hardware
Dispositivos inscritos apÛs data-hora especÌfica
Body: { "filter": "datelistMonth gt \"2019-01-08T11:59:05Z\"" }

 

IntegraÁ„o de incidente HP TechPulse

SolicitaÁ„o de dados apÛs data-hora especÌfica

 

Exemplo - Lista de incidentes criados apÛs 00:00:00 de 05/03/2019
SolicitaÁ„o 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
Content-Type: application/json
AutorizaÁ„o: Token de acesso do portador
Body: 
{
    Solicitar carga ˙til: {tenantIds: []}
}


Resposta de HTTP
{"totalResults":38,"startIndex":0,"itemsPerPage":10,
"resources":[
    {
        "id":123456,
        "guid":"XYZA-123456",
        "displayId":"456789",
        "createdAt":1551857130279,
        "updatedAt":1551857130292,
        "occuredAt":1551744000000,
        "description":"Baixo espaÁo em disco detectado no disco (disk-sn, disk-model) no dispositivo device-name com usu·rio user-name, registrado= user-name. O espaÁo em disco consumido È de 91-100%. Pouco espaÁo em disco pode afetar a estabilidade do sistema, instalaÁ„o de atualizaÁıes e desempenho. Sistema operacional do dispositivo: Windows 10.",
        "title":"Hard drive low disk space",
        "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
    },
.....
]}

 

SolicitaÁ„o de dados entre data-hora especÌfica

 

Exemplo - Lista de incidentes atualizados entre 08/01/2019 e 15/03/2019
SolicitaÁ„o 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
Content-Type: application/json
AutorizaÁ„o: Token de acesso do portador
Body: 
{
  {tenantIds: []}
}


Resposta de HTTP
{"totalResults":38,"startIndex":0,"itemsPerPage":10,
"resources":[
    {
        "id":123456,
        "guid":"XYZA-123456",
        "displayId":"456789",
        "createdAt":1551857130279,
        "updatedAt":1551857130292,
        "occuredAt":1551744000000,
        "description":"Baixo espaÁo em disco detectado no disco (disk-sn, disk-model) no dispositivo device-name com usu·rio user-name, registrado= user-name. O espaÁo em disco consumido È de 91-100%. Pouco espaÁo em disco pode afetar a estabilidade do sistema, instalaÁ„o de atualizaÁıes e desempenho. Sistema operacional do dispositivo: Windows 10.",
        "title":"Hard drive low disk space",
        "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
    },
.....
]}