Skip to main content
Skip table of contents

[POST] Criar ou atualizar agrupamentos de computadores de filas de impressão

Este endpoint cria ou atualiza agrupamentos de computadores de filas de impressão.

Caso não exista nenhum agrupamento com o mesmo GroupName, um novo agrupamento será criado. Se já houver um agrupamento cadastrado com o mesmo GroupName, mas com informações diferentes de GroupDescription, o agrupamento será atualizado.

Caso não exista nenhum computador com o mesmo Hostname, um novo computador será criado e vinculado automaticamente ao agrupamento. 

Chamada

POST /v1/groups/computers

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

Corpo (body)

Parâmetro

Descrição

Tipo

Obrigatório

Client

Nome do cliente, conforme cadastrado no portal NDD Orbix.

string

Sim

Groups

Lista de agrupamentos.

array

Sim

GroupName

Nome que identificará o agrupamento.

string

Sim

GroupDescription

Breve descrição sobre o objetivo do agrupamento.

string

Não

Computers

Lista de computadores.

array

Sim

Hostname

Nome do computador.

Não utilize acentos, símbolos (exceto hífen) e espaços.

string

Sim

Exemplo de requisição

Criar ou atualizar dois agrupamentos com três computadores cada:

CODE
curl -L -X POST 'http://developer.nddorbix.com/printqueue-external-integration-api/v1/groups/computers' \
-H 'Tenant: {tenant}' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
    "Client": "ABC",
    "Groups": [
        {
            "GroupName": "Group 1",
            "GroupDescription" : "Group 1 description",
            "Computers": [
                {
                    "Hostname": "PC-001"
                },
                {
                    "Hostname": "LAPTOP002"
                },
                {
                    "Hostname": "SERVER003"
                }
            ]
        },
        {
            "GroupName": "Group 2",
            "GroupDescription" : "Group 2 description",
            "Computers": [
                {
                    "Hostname": "PC-004"
                },
                {
                    "Hostname": "LAPTOP005"
                },
                {
                    "Hostname": "SERVER006"
                }
            ]
        }
    ]
}'

Em uma mesma requisição, é possível criar ou atualizar até 5 agrupamentos com 1.000 computadores cada.

Para a criação ou atualização de mais de 5 agrupamentos, realize mais de uma requisição.

Exemplo de resposta

A resposta de código 201 indica que:

  • todos os agrupamentos foram criados ou atualizados com sucesso e retornará o seguinte JSON:

CODE
[]

ou

  • houve falha parcial na criação ou atualização de alguns agrupamentos, e retornará, em JSON, o motivo da falha:

CODE
[
    {
        "groupName": "GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest",
        "computers": [
            {
                "hostName": "PC@001",
                "errorMessage": "The hostname cannot contain special characters."
            }
        ],
        "errorMessage": "Group Name is too long."
    },
    {
        "groupName": "Group 2",
        "computers": [
            {
                "hostName": "SERVER#003",
                "errorMessage": "The hostname cannot contain special characters."
            }
        ],
        "errorMessage": ""
    }
]

A resposta de código 400 indica que houve falha na criação ou atualização de todos os agrupamentos e retornará o seguinte JSON:

CODE
{
    "errors": {
        "3400": [
            "All groups are invalid."
        ]
    },
    "title": "BadRequest",
    "status": 400,
    "detail": "BusinessException",
    "instance": "/v1/groups/computers"
}
JavaScript errors detected

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

If this problem persists, please contact our support.