Skip to main content

Pontos de extremidade de assinatura

Pontos de extremidade e parâmetros de assinatura

Para saber mais sobre as relações de objetos, vá para a seção Relações de objetos.

Para obter mais informações sobre assinaturas, visite a página de ajuda Assinaturas (estúdios).

Criar uma nova assinatura

Para criar uma nova assinatura, use o ponto de extremidade POST {baseURL}/v3/subscriptions.

Nota

Esse ponto de extremidade é apenas para administradores do Server.

Parâmetros

contract (corpo): para criar uma nova assinatura, o parâmetro "contract" é obrigatório. Especifique os seguintes parâmetros:

  • name (cadeia de caracteres (string)): obrigatório. Insira um nome para a nova assinatura.

  • canShareSchedule (booleano): obrigatório. Especifique se os agendamentos compartilhados estarão habilitados na assinatura que você está criando.

  • credentialId (cadeia de caracteres (string)): obrigatório. Este parâmetro refere-se ao ID exclusivo de uma credencial que é atribuído ao usuário como padrão. Quando não especificado, o padrão é "".

Exemplo de solicitação: cURL

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

Exemplo de resposta

  • 200: OK

  • 201: Created (201: Criado)

    {
  "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 (400: Solicitação incorreta)

  • 401: Unauthorized (401: Não autorizado)

  • 404: NotFound (404: Não encontrado)

Recuperar todas as assinaturas

Para recuperar detalhes sobre todas as assinaturas, use o ponto de extremidade GET {baseURL}/v3/subscriptions. Use vários parâmetros como um filtro para pesquisar as assinaturas.

Nota

Esse ponto de extremidade é apenas para administradores do Server.

Parâmetros

  • name (cadeia de caracteres): opcional. Para procurar uma assinatura específica, insira o nome dela.

  • canShareSchedules (booleano): opcional. Selecione se os agendamentos compartilhados estão habilitados nas assinaturas que você procura.

  • defaultWorkflowCredentialId (cadeia de caracteres (string)): opcional. Insira um ID de credencial de fluxo de trabalho padrão para as assinaturas que você procura.

  • userCountGreaterThanEquals (int32): especifique quantos usuários devem estar incluídos na assinatura que você procura, superior ou igual ao número especificado.

  • workflowCountGreaterThanEquals (int32): especifique quantos fluxos de trabalho devem estar incluídos na assinatura que você procura, superior ou igual ao número especificado.

  • workflowCountLessThanEquals (int32): especifique quantos usuários devem estar incluídos na assinatura que você procura, inferior ou igual ao número especificado.

Exemplo de solicitação: cURL

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

Exemplo de resposta

  • 200: OK

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

  • 401: Unauthorized (401: Não autorizado)

Procurar uma assinatura específica

Para procurar uma assinatura específica, use o ponto de extremidade GET {baseURL}/v3/subscriptions/{subscriptionId}.

Nota

Esse ponto de extremidade é apenas para administradores do Server.

Parâmetros

subscriptionsId (cadeia de caracteres (string)): obrigatório. Insira o ID da assinatura para recuperar as informações sobre ela.

Exemplo de solicitação: cURL

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

Exemplo de resposta

  • 200: OK

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

  • 401: Unauthorized (401: Não autorizado)

  • 404: NotFound (404: Não encontrado)

Atualizar uma assinatura existente

Para atualizar uma assinatura existente, use o ponto de extremidade PUT {baseURL}/v3/subscription/{subscriptionId}.

Nota

Esse ponto de extremidade é apenas para administradores do Server.

Parâmetros

  • subscriptionId (cadeia de caracteres (string)): obrigatório. Insira o ID da assinatura para que ela seja atualizada.

  • subscription (corpo): obrigatório. Para atualizar uma assinatura, o parâmetro updateContract é obrigatório. Especifique o seguinte:

    • name (cadeia de caracteres): obrigatório. Insira um novo nome para a assinatura.

    • credentialId (cadeia de caracteres (string)): obrigatório. Este parâmetro refere-se ao ID exclusivo de uma credencial que é atribuído ao usuário como padrão. Quando não especificado, o padrão é "".

    • canShareSchedules (booleano): obrigatório. Especifique se os agendamentos compartilhados estarão habilitados na assinatura que você está atualizando.

Exemplo de solicitação: cURL

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

Exemplo de resposta

  • 200: OK

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

  • 400: BadRequest (400: Solicitação incorreta)

  • 401: Unauthorized (401: Não autorizado)

  • 404: NotFound (404: Não encontrado)

Excluir uma assinatura

Para excluir uma assinatura específica do sistema, use o ponto de extremidade DELETE {baseURL}/v3/subscriptions.

Nota

Esse ponto de extremidade é apenas para administradores do Server.

Parâmetros

subscriptionId (cadeia de caracteres (string)): obrigatório. Insira o ID da assinatura que você deseja excluir.

Exemplo de solicitação: cURL

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

Exemplo de resposta

  • 200: OK

  • 400: BadRequest (400: Solicitação incorreta)

  • 401: Unauthorized (401: Não autorizado)

  • 404: NotFound (404: Não encontrado)

Alterar a assinatura de um usuário

Para mover um ou vários usuários de uma assinatura para outra, use o ponto de extremidade PUT {baseURL}/v3/subscriptions/{subscriptionId}/users.

Nota

Esse ponto de extremidade é apenas para administradores do Server.

Parâmetros

  • subscriptionId (cadeia de caracteres (string)): obrigatório. Insira o ID da assinatura existente para a qual você deseja mover o usuário.

  • contract (corpo):

    • userIds (cadeia de caracteres (string)): insira os ID de usuário que você deseja mover para o subscriptionId especificado.

Exemplo de solicitação: cURL

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

Exemplo de resposta

  • 200: OK

  • 400: BadRequest (400: Solicitação incorreta)

  • 401: Unauthorized (401: Não autorizado)

  • 404: NotFound (404: Não encontrado)

Relações de objetos

Se estiver criando uma assinatura, você poderá usar objetos criados da seguinte maneira:

Objeto criado: "subscriptionId" (por exemplo, "subscriptionId": "619158e57e607d0011ac3009")

Você pode usá-lo como:

Exemplos de solicitações Postman

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

Postman_subscriptions_get2.png

GET {baseURL}/v3/subscriptions

Postman_subscriptions_get.png

Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman.

Nesta secção: