Skip to main content

Endpoint di iscrizione

Endpoint e parametri di iscrizione

Per ulteriori informazioni sulle relazioni tra oggetti, consulta la sezione Relazioni tra oggetti.

Per ulteriori informazioni sulle iscrizioni, consulta la pagina di assistenza Iscrizioni (Studio).

Creazione di una nuova iscrizione

Per creare una nuova pianificazione, utilizza l'endpoint POST {baseURL}/v3/subscriptions.

Nota

Questo endpoint è solo per gli Amministratori (amministratori del server).

Parametri

contract(corpo): il parametro contract è obbligatorio per creare una nuova iscrizione. Specifica i seguenti parametri:

  • name (stringa): obbligatorio. Immetti un nome per la nuova iscrizione.

  • CanShareSchedule (booleano): obbligatorio. Specifica se le pianificazioni condivise saranno abilitate per l'iscrizione che stai creando.

  • credentialId(stringa): obbligatorio. Questo parametro si riferisce all'ID univoco di una credenziale assegnato all'utente per impostazione predefinita. In assenza di una specifica, il valore predefinito è "".

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

Esempio di risposta

  • 200: OK

  • 201: Created

    {
  "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

  • 401: Unauthorized

  • 404: NotFound

Recupero di tutte le iscrizioni

Per ottenere informazioni su tutte le iscrizioni, utilizza l'endpoint GET {baseURL}/v3/subscriptions. Utilizza vari parametri come filtro per la ricerca delle iscrizioni.

Nota

Questo endpoint è solo per gli Amministratori (amministratori del server).

Parametri

  • name (stringa): opzionale. Per cercare un'iscrizione specifica, immetti il nome della stessa.

  • canShareSchedules (booleano): opzionale. Seleziona se le pianificazioni condivise sono abilitate per le iscrizioni che stai cercando.

  • defaultWorkflowCredentialId (stringa): opzionale. Immetti un ID credenziale flusso di lavoro predefinito per le iscrizioni che stai cercando.

  • userCountGreaterThanEquals (int32): specifica il numero di utenti che devono essere presenti nell'iscrizione che stai cercando, maggiore o uguale al numero specificato.

  • workflowCountGreaterThanEquals (int32): specifica il numero di flussi di lavoro che devono essere presenti nell'iscrizione desiderata, maggiore o uguale al numero specificato.

  • workflowCountLessThanEquals (int32): specifica il numero di flussi di lavoro che devono essere presenti nell'iscrizione desiderata, minore o uguale al numero specificato.

Esempio di richiesta: cURL

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

Esempio di risposta

  • 200: OK

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

  • 401: Unauthorized

Ricerca di un'iscrizione specifica

Per cercare un'iscrizione specifica, utilizza l'endpoint GET {baseURL}/v3/subscriptions/{subscriptionId}.

Nota

Questo endpoint è solo per gli Amministratori (amministratori del server).

Parametri

subscriptionsId (stringa): obbligatorio. Immetti l'ID di un'iscrizione di cui desideri recuperare le informazioni.

Esempio di richiesta: cURL

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

Esempio di risposta

  • 200: OK

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

  • 401: Unauthorized

  • 404: NotFound

Aggiornamento di un'iscrizione esistente

Per aggiornare un'iscrizione esistente, utilizza l'endpoint PUT {baseURL}/v3/subscription/{subscriptionId}.

Nota

Questo endpoint è solo per gli Amministratori (amministratori del server).

Parametri

  • subscriptionId (stringa): obbligatorio. Immetti l'ID di un'iscrizione affinché venga aggiornata.

  • subscription (corpo): obbligatorio. Il parametro updateContract è obbligatorio per aggiornare un'iscrizione. Specifica quanto segue:

    • name (stringa): obbligatorio. Immetti un nuovo nome per l'iscrizione.

    • credentialId(stringa): obbligatorio. Questo parametro si riferisce all'ID univoco di una credenziale assegnato all'utente per impostazione predefinita. In assenza di una specifica, il valore predefinito è "".

    • canShareSchedules (booleano): obbligatorio. Specifica se le pianificazioni condivise saranno abilitate per l'iscrizione che stai aggiornando.

Esempio di richiesta: 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
}'

Esempio di risposta

  • 200: OK

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

  • 400: BadRequest

  • 401: Unauthorized

  • 404: NotFound

Eliminazione di un'iscrizione

Per eliminare un utente specifico dal sistema, utilizza l'endpoint DELETE {baseURL}/v3/subscriptions/.

Nota

Questo endpoint è solo per gli Amministratori (amministratori del server).

Parametri

subscriptionId (stringa): obbligatorio. Immetti l'ID dell'iscrizione che desideri eliminare.

Esempio di richiesta: cURL

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

Esempio di risposta

  • 200: OK

  • 400: BadRequest

  • 401: Unauthorized

  • 404: NotFound

Modifica dell'iscrizione di un utente

Per spostare un utente (o più utenti) da un'iscrizione a un'altra, utilizza l'endpoint PUT {baseURL}/v3/subscriptions/{subscriptionId}/Users.

Nota

Questo endpoint è solo per gli Amministratori (amministratori del server).

Parametri

  • subscriptionId (stringa): obbligatorio. Immetti un ID iscrizione esistente a cui desideri spostare l'utente.

  • contract (corpo):

    • userIds (stringa): inserisci gli ID utente che vuoi spostare sotto l'ID iscrizione specificato.

Esempio di richiesta: 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"
  ]
}'

Esempio di risposta

  • 200: OK

  • 400: BadRequest

  • 401: Unauthorized

  • 404: NotFound

Relazioni tra oggetti

Se stai creando un'iscrizione, puoi utilizzare gli oggetti creati nel modo seguente:

Oggetto creato: "subscriptionId" (ad esempio, "subscriptionId": "619158e57e607d0011ac3009")

Puoi utilizzarlo come:

Esempi di richiesta Postman

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

Postman_subscriptions_get2.png

GET {baseURL}/v3/subscriptions

Postman_subscriptions_get.png

Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman.

In questa sezione: