automation-suite
2023.10
true
Guía de la API de Automation Suite
Last updated 20 de ago. de 2024

Asignar licencias a una organización

Como administrador de host, puedes usar el punto final para asignar licencias a una organización en función del ID de la organización.

Importante: para asignar licencias a organizaciones y tenants, debe autenticarse con las credenciales de host.

Punto final de API

PUT https://{yourDomain}/lrm/api/host/{hostAccountID}/organization/{organizationId}/license

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Nota: para obtener el {access_token}, asegúrese de autenticarse mediante el método ROPC descrito aquí.

Parámetros de ruta

Parámetros de ruta

Tipo de datos

Descripción

hostAccountID

(obligatorio)

Cadena

El ID de la cuenta de host que asigna las licencias.

ADVERTENCIA:
Usar siempre el valor predeterminado: feb0dd79-85b6-483b-b297-0e49a1aa5b7d

organizationId

(obligatorio)

Cadena

El ID de la organización a la que desea asignar licencias.

Solicitar cuerpo

El cuerpo de la solicitud contiene la matriz de códigos de licencia para varios productos y su cantidad correspondiente.

{
    "productQuantities": 
        [
          { "code": "string", "quantity": 0 } 
        ]
}{
    "productQuantities": 
        [
          { "code": "string", "quantity": 0 } 
        ]
}
Nota:
  • Para ver los códigos de licencia disponibles que puedes utilizar en el cuerpo de la solicitud, consulta Códigos de licencia.
  • Puede asignar tantas licencias como haya adquirido la organización.

Respuesta

200 OK

Devuelve las licencias asignadas.

404

La licencia de host no existe o el marcador de característica para los flujos locales está desactivado.

409

La asignación de licencia no está permitida porque supera la cantidad de licencias de host.

Solicitud de ejemplo

Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.

  • Tu {baseURL} es: https://tom-jones-server.com
  • Tu {access_token} es: 1234 (para consideraciones de longitud)
  • Tu {hostAccountId} es: j0ne5
  • El {organizationId} que necesita asignación de licencia es: y-y-y-delilah
  • Desea asignar licencias de productos a la organización anterior de la siguiente manera:

La llamada debe ser similar a lo que mostramos a continuación (cURL):

curl --location --request POST 'https://tom-jones-server.com/lrm/api/host/j0ne5/organization/y-y-y-delilah/license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productQuantities": 
        [
          { "code": "UNATT", "quantity": 2 },
          { "code": "AIG", "quantity": 1 },
          { "code": "TAUNATT", "quantity": 3 }      
        ]
}'curl --location --request POST 'https://tom-jones-server.com/lrm/api/host/j0ne5/organization/y-y-y-delilah/license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productQuantities": 
        [
          { "code": "UNATT", "quantity": 2 },
          { "code": "AIG", "quantity": 1 },
          { "code": "TAUNATT", "quantity": 3 }      
        ]
}'

Este es el cuerpo de respuesta para una asignación de licencia exitosa:

{
  "accountId": "y-y-y-delilah",
  "bundleCode": "string",
  "endDate": 0,
  "gracePeriod": 0,
  "licenseCode": "string",
  "licenseStatus": "string",
  "products": [
    {
      "code": "string",
      "quantity": 0,
      "type": "string",
      "features": [
        {
          "code": "string",
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "templates": [
    {
      "productCode": "string",
      "products": [
        {
          "code": "string",
          "type": "string"
        }
      ]
    }
  ],
  "startDate": 0,
  "subscriptionCode": "string",
  "subscriptionPlan": "string",
  "payload": "string",
  "type": "string",
  "parentLicenseCode": "string"
}{
  "accountId": "y-y-y-delilah",
  "bundleCode": "string",
  "endDate": 0,
  "gracePeriod": 0,
  "licenseCode": "string",
  "licenseStatus": "string",
  "products": [
    {
      "code": "string",
      "quantity": 0,
      "type": "string",
      "features": [
        {
          "code": "string",
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "templates": [
    {
      "productCode": "string",
      "products": [
        {
          "code": "string",
          "type": "string"
        }
      ]
    }
  ],
  "startDate": 0,
  "subscriptionCode": "string",
  "subscriptionPlan": "string",
  "payload": "string",
  "type": "string",
  "parentLicenseCode": "string"
}
  • Punto final de API
  • Solicitar encabezados.
  • Parámetros de ruta
  • Solicitar cuerpo
  • Respuesta
  • 200 OK
  • 404
  • 409
  • Solicitud de ejemplo

¿Te ha resultado útil esta página?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Uipath Logo White
Confianza y seguridad
© 2005-2024 UiPath. Todos los derechos reservados.