[POST] Crear o actualizar agrupaciones de usuarios de cola de impresión
Este endpoint crea o actualiza las agrupaciones de usuarios 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 hay ningún usuario con el mismo Logon
y Domain
, se creará un nuevo usuario. Si ya hay un usuario registrado con el mismo Logon
y Domain
, pero con información diferente de Name
y/o Email
, se actualizará el usuario.
Llamada
POST /v1/groups/users
Cabecera (header)
Parámetro | Descripción | Tipo | Obligatorio |
---|---|---|---|
| Nombre del distribuidor. Para obtener esta información, consulte la documentación: Menús del portal. |
| Sí |
|
| Sí |
Cuerpo (body)
Parámetro | Descripción | Tipo | Obligatorio |
---|---|---|---|
| Nombre del cliente, tal y como está registrado en el portal NDD Orbix. |
| Sí |
| Lista de agrupaciones. |
| Sí |
| Nombre que identificará a la agrupación. |
| Sí |
| Breve descripción del objetivo de la agrupación. |
| No |
| Lista de usuarios. |
| Sí |
| Identificación de acceso del usuario. No utilice acentos, símbolos y espacios. |
| Sí |
| Dominio al que pertenece el usuario. No utilice acentos, símbolos y espacios. |
| Sí |
| Nombre completo del usuario. |
| No |
| Dirección de correo electrónico del usuario. Ejemplo: abc@abc.com. |
| No |
Ejemplo de solicitud
Crear o actualizar dos agrupaciones con dos usuarios cada una:
curl -L -X POST 'https://developer.nddorbix.com/printqueue-external-integration-api/v1/groups/users' \
-H 'Tenant: {tenant}' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"Client": "ABC",
"Groups": [
{
"GroupName": "Group 1",
"GroupDescription": "Group 1 description",
"Users": [
{
"Logon": "carlos.silva",
"Domain": "NDD",
"Name": "Carlos Silva",
"Email": "carlos.silva@ndd.tech"
},
{
"Logon": "joao.souza",
"Domain": "NDD",
"Name": "João Souza"
}
]
},
{
"GroupName": "Group 2",
"GroupDescription": "Group 2 description",
"Users": [
{
"Logon": "maria.oliveira",
"Domain": "NDD",
"Email": "maria.oliveira@ndd.tech"
},
{
"Logon": "joana.pereira",
"Domain": "NDD",
"Name": "Joana Pereira",
"Email": "joana.pereira@ndd.tech"
}
]
}
]
}'
En una única solicitud puede crear o actualizar hasta 5 agrupaciones con 1.000 usuarios 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:
[]
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:
[
{
"groupName": "GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest GroupTest",
"users": [
{
"user": "NDD//João Souza",
"errorMessage": "Logon is not valid."
}
],
"errorMessage": "Group Name is too long."
},
{
"groupName": "Group 2",
"users": [
{
"user": "NDD//joana.pereira",
"errorMessage": "E-mail is not valid."
}
],
"errorMessage": ""
}
]
La respuesta de código 400 indica que hubo un fallo al crear o actualizar todas las agrupaciones y devolverá el siguiente JSON:
{
"errors": {
"3400": [
"All groups are invalid."
]
},
"title": "BadRequest",
"status": 400,
"detail": "BusinessException",
"instance": "/v1/groups/users"
}