Skip to main content
Skip table of contents

[GET] Buscar todos os softwares cadastrados

Este endpoint busca todos os softwares cadastrados no provedor, incluindo detalhes sobre o software, seu tipo de licença e os computadores vinculados.

Chamada

GET /v1/softwares

Cabeçalho (header)

Parâmetro

Descrição

Tipo

Obrigatório

Tenant

Nome do provedor.

Para obter essa informação, acesse a documentação: Menus do portal.

string

Sim

Authorization

Token de autenticação obtido.

string

Sim

Consulta (query)

Parâmetro

Descrição

Tipo

Obrigatório

$count

Retorna o número total de itens correspondentes à consulta.

boolean

Não

$skip

Pula as primeiras n linhas dos resultados.

integer

Não

$top

Retorna apenas as primeiras n linhas dos resultados.

integer

Não

$select

Seleciona apenas os campos especificados nos resultados.

string

Não

$orderby

Ordena os resultados com base em um ou mais campos.

string

Não

$filter

Filtra resultados com base em uma condição.

string

Não

$pagesize

Retorna o número de registros permitidos por página.

  • Valor aplicado por padrão em todas as chamadas: 500.

  • Limite máximo: 500.

integer

Não

Para mais informações sobre os filtros e a paginação, consulte Filtros de busca e Paginação.

Exemplo de requisição

Buscar a lista de todos os softwares do provedor:

CODE
curl -L -X GET 'https://developer.nddorbix.com/software-external-integration-api/v1/softwares' \
-H 'Tenant: {tenant}' \
-H 'Authorization: Bearer {token}'

Exemplo de resposta

A resposta de código 200 indica que a busca foi realizada com sucesso e retornará o JSON com os dados buscados:

CODE
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Software",
    "publisher": "Manufacturer",
    "permission": true,
    "category": "Software Development",
    "organization": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "Organization"
    },
    "softwares": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": "1.0.0",
        "installDate": "2025-02-18T11:14:26.230Z",
        "isLicensed": true,
        "licenseExpirationDate": "2025-02-18T11:14:26.230Z",
        "licenseKey": "123456789",
        "computer": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "Computer"
        }
      }
    ],
    "license": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": 0,
      "isUniqueLicense": true,
      "amount": 0
    }
  }
]
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.