Skip to main content
Skip table of contents

[POST] Crear o actualizar agrupaciones de ordenadores de cola de impresión

Este endpoint crea o actualiza las agrupaciones de ordenadores de la cola de impresión.

Si no hay ninguna agrupación con el mismo GroupName, se creará una nueva agrupación. Si ya existe una agrupación registrada con el mismo GroupName, pero con información GroupDescription diferente, se actualizará la agrupación.

Si no existe ningún ordenador con el mismo Hostname, se creará un nuevo ordenador y se vinculará automáticamente a la agrupación.

Llamada

POST /v1/groups/computers

Cabecera (header)

Parámetro

Descripción

Tipo

Obligatorio

Tenant

Nombre del distribuidor.

Para obtener esta información, consulte la documentación: Menús del portal.

string

Authorization

Token de autenticación obtenido.

string

Cuerpo (body)

Parámetro

Descripción

Tipo

Obligatorio

Client

Nombre del cliente, tal y como está registrado en el portal NDD Orbix.

string

Groups

Lista de agrupaciones.

array

GroupName

Nombre que identificará a la agrupación.

string

GroupDescription

Breve descripción del objetivo de la agrupación.

string

No

Computers

Lista de ordenadores.

array

Hostname

Nombre del ordenador.

No utilice acentos, símbolos (excepto guiones) y espacios.

string

Ejemplo de solicitud

Crear o actualizar dos agrupaciones con tres ordenadores cada una:

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"
                }
            ]
        }
    ]
}'

En una única solicitud puede crear o actualizar hasta 5 agrupaciones con 1.000 ordenadores cada una.

Para crear o actualizar más de 5 agrupaciones, realice más de una solicitud.

Ejemplo de respuesta

El código de respuesta 201 indica que:

  • todas las agrupaciones han sido creadas o actualizadas correctamente y devolverá el siguiente JSON:

CODE
[]

o

  • se ha producido un fallo parcial en la creación o actualización de algunas agrupaciones y devolverá el motivo del fallo en JSON:

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": ""
    }
]

La respuesta de código 400 indica que hubo un fallo al crear o actualizar todas las agrupaciones y devolverá el siguiente 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.