Skip to main content

Puntos de conexión de la suscripción

Puntos de conexión y parámetros de la suscripción

Para obtener más información sobre las relaciones entre objetos, ve a la sección Relaciones entre objetos.

Para obtener más información sobre las suscripciones, visita la página de ayuda Suscripciones (estudios).

Crear una nueva suscripción

Para crear una suscripción nueva, utiliza el punto de conexión POST {baseURL}/v3/subscriptions.

Nota

Este punto de conexión es solo para administradores (administradores de Server).

Parámetros

contract (cuerpo): para crear una nueva suscripción, se requiere el parámetro contract. Especifica los siguientes parámetros:

  • name (cadena): obligatorio. Introduce un nombre para la suscripción nueva.

  • canShareSchedule (booleano): obligatorio. Especifica si las programaciones compartidas se habilitarán en la suscripción que estás creando.

  • credentialId (cadena): obligatorio. Este parámetro se refiere al ID único de una credencial, asignado al usuario como predeterminado. Cuando no se especifica, el valor predeterminado es "".

curl -X 'POST' \
  'http://localhost/webapi/v3/subscriptions' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "New Studio",
  "canShareSchedule": true,
  "credentialId": ""
}'

  • 200: OK

  • 201: Created (creado)

    {
  "name": "string",
  "apiKey": "string",
  "apiSecret": "string",
  "active": true,
  "expirationDate": "string",
  "expDate": "2024-09-19T13:13:44.245Z",
  "dateUpdated": "2024-09-19T13:13:44.245Z",
  "apiEnabled": true,
  "canShareSchedules": true,
  "credentialId": "string",
  "credentials": [
    {
      "credentialId": "string",
      "id": "string"
    }
  ],
  "dataConnections": [
    {
      "dataConnectionId": "string",
      "id": "string"
    }
  ],
  "id": "string"
}

  • 400: BadRequest (mala solicitud)

  • 401: Unauthorized (sin autorización)

  • 404: NotFound (no encontrado)

Recuperar todas las suscripciones

Para recuperar detalles sobre todas las suscripciones, utiliza el punto de conexión GET {baseURL}/v3/subscriptions. Utiliza varios parámetros como filtro para buscar las suscripciones.

Nota

Este punto de conexión es solo para administradores (administradores de Server).

Parámetros

  • name (cadena): opcional. Para buscar una suscripción específica, introduce su nombre.

  • canShareSchedules (booleano): opcional. Selecciona si las programaciones compartidas están habilitadas para las suscripciones que estás buscando.

  • defaultWorkflowCredentialId (cadena): opcional. Introduce un ID de credencial de flujo de trabajo predeterminado para las suscripciones que estás buscando.

  • userCountGreaterThanEquals (int32): especifica cuántos usuarios deben estar en la suscripción que estás buscando, más o igual al número especificado.

  • workflowCountGreaterThanEquals (int32): especifica cuántos flujos de trabajo deben haber en la suscripción que estás buscando, más o igual al número especificado.

  • workflowCountLessThanEquals (int32): especifica cuántos flujos de trabajo debe haber en la suscripción que estás buscando, más o igual al número especificado.

curl -X 'GET' \
  'http://localhost/webapi/v3/subscriptions?userCountGreaterThanEquals=1&workflowCountGreaterThanEquals=3' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

    [
  {
    "userCount": 0,
    "workflowCount": 0,
    "id": "string",
    "name": "string",
    "credentialId": "string",
    "canShareSchedules": true
  }
]

  • 401: Unauthorized (sin autorización)

Buscar una suscripción específica

Para buscar una suscripción específica, utiliza el punto de conexión GET {baseURL}/v3/subscriptions/{subscriptionId}.

Nota

Este punto de conexión es solo para administradores (administradores de Server).

Parámetros

subscriptionsId (cadena): obligatorio. Ingresa un ID de suscripción para recuperar información sobre esta suscripción.

curl -X 'GET' \
  'http://localhost/webapi/v3/subscriptions/66ebd0896e52ae73b495106f' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

      "users": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "workflows": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "id": "string",
  "name": "string",
  "credentialId": "string",
  "canShareSchedules": true
}

  • 401: Unauthorized (sin autorización)

  • 404: NotFound (no encontrado)

Actualizar una suscripción existente

Para actualizar una suscripción existente, utiliza el punto de conexión PUT {baseURL}/v3/subscription/{subscriptionId}.

Nota

Este punto de conexión es solo para administradores (administradores de Server).

Parámetros

  • subscriptionId (cadena): obligatorio. Ingresa un ID de suscripción para actualizar a este usuario.

  • subscription (cuerpo): obligatorio. Para actualizar una suscripción, se requiere el parámetro updateContract. Especifica lo siguiente:

    • name (cadena): obligatorio. Introduce un nombre nuevo para la suscripción.

    • credentialId (cadena): obligatorio. Este parámetro se refiere al ID único de una credencial, asignado al usuario como predeterminado. Cuando no se especifica, el valor predeterminado es "".

    • canShareSchedules (booleano): obligatorio. Especifica si las programaciones compartidas se habilitarán en la suscripción que estás actualizando.

curl -X 'PUT' \
  'http://localhost/webapi/v3/subscriptions/66ebd0896e52ae73b495106f' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Doe'\''s Studio",
  "credentialId": "",
  "canShareSchedules": false
}'

  • 200: OK

    {
  "id": "string",
  "name": "string",
  "credentialId": "string",
  "canShareSchedules": true
}

  • 400: BadRequest (mala solicitud)

  • 401: Unauthorized (sin autorización)

  • 404: NotFound (no encontrado)

Eliminar una suscripción

Para eliminar una suscripción específica del sistema, utiliza el punto de conexión DELETE {baseURL}/v3/subscriptions/.

Nota

Este punto de conexión es solo para administradores (administradores de Server).

Parámetros

subscriptionId (cadena): obligatorio. Ingresa el ID de suscripción que deseas eliminar.

curl -X 'DELETE' \
  'http://localhost/webapi/v3/subscriptions?subscriptionId=66ec22e86e52ae73b49510a1' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

  • 400: BadRequest (mala solicitud)

  • 401: Unauthorized (sin autorización)

  • 404: NotFound (no encontrado)

Cambiar la suscripción de un usuario

Para mover un usuario (o varios usuarios) de una suscripción a otra, usa el punto de conexión PUT {baseURL}/v3/subscriptions/{subscriptionId}/users.

Nota

Este punto de conexión es solo para administradores (administradores de Server).

Parámetros

  • subscriptionId (cadena): obligatorio. Introduce un ID de suscripción existente al que desees trasladar al usuario.

  • contract (cuerpo):

    • userIds (cadena): introduce los ID de usuario que deseas trasladar bajo el subscriptionId especificado.

curl -X 'PUT' \
  'http://localhost/webapi/v3/subscriptions/66ffbb75125b93320a8bb5c7/users' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "userIds": [
    "66ffbb4b125b93320a8bb5bd"
  ]
}'

  • 200: OK

  • 400: BadRequest (mala solicitud)

  • 401: Unauthorized (sin autorización)

  • 404: NotFound (no encontrado)

Relaciones entre objetos

Si creas una suscripción, puedes utilizar los objetos creados de la siguiente manera:

Objeto creado: “subscriptionId” (por ejemplo, “subscriptionId”: “619158e57e607d0011ac3009”)

Puedes usarlo como:

Ejemplos de solicitudes de Postman

GET {baseURL}/v3/subscriptions/{subscriptionId}

Postman_subscriptions_get2.png

GET {baseURL}/v3/subscriptions

Postman_subscriptions_get.png

Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman.