Skip to main content

Lettura di una singola connessione

API per recuperare i dati di una specifica connessione dato il suo ID

[GET] /api/v3/connections/manager

Header

Gli header richiesti dalla chiamata sono gli header standard di TSDigital.

Il Content-Type deve essere application/json

Path Parameters

  • connectionId: identificativo univoco della connessione da leggere

Risposte

L'operazione è avvenuta con successo se e solo se il codice HTTP della risposta è 200. Ogni altro codice di risposta indica uno stato di errore.

HTTP 202

L'operazione è avvenuta con successo e il processo di creazione è stato preso in carico.

Body della risposta:

{
  "id": "string",
  "managerId": "string",
  "managedId": "string",
  "managerDescription": "string",
  "managedDescription": "string",
  "connections": [
    {
      "id": "string",
      "status": {
        "active": true,
        "activatedAt": "2020-09-10T13:49:33.092Z",
        "activatedBy": "string",
        "createdAt": "2020-09-10T13:49:33.092Z",
        "createdBy": "string",
        "modifiedAt": "2020-09-10T13:49:33.092Z",
        "modifiedBy": "string",
        "deleted": true,
        "deletedAt": "2020-09-10T13:49:33.092Z",
        "deletedBy": "string",
        "status": "string",
        "certificationStatus": "string"
      },
      "appId": "string",
      "featureCode": "string",
      "permission": "string",
      "approvalType": "string",
      "serviceId": "string"
    }
  ]
}
  • id: identificativo univoco della connessione
  • managerId: identificativo dell'item gestore della connessione
  • managedId: identificativo dell'item gestito nella connessione
  • managerDescription: ragione sociale dell'item gestore
  • managedDescription: ragione sociale dell'item gestito
  • connections: array contenente tutte le connessioni relative alla coppia gestore/gestita
    • id: identificativo univoco della connessione
    • status: informazioni sullo stato della connessione
      • active: se true, la connessione è attiva ed utilizzabile
      • activatedAt: data ed ora di attivazione della connessione espressa come stringa
      • activatedBy: identificativo dell'utenza che ha creato la connessione
      • createdAt: data ed ora di creazione della connessione espressa come stringa
      • createdBy: identificativo dell'utenza che ha creato la connessione
      • modifiedAt: data ed ora di ultima modifica della connessione, espressa come stringa
      • modifiedBy: identificativo dell'utenza che ha modificato la connessione
      • deleted: se true, la connessione è stata eliminata e non è più utilizzabile
      • deletedAt: data di cancellazione della connessione, espressa come stringa
      • deletedBy: identificativo dell'utenza che ha effettuato la cancellazione
      • status: stato attuale della connessione
      • certificationStatus: stato di certificazione della connessione
    • appId: identificativo dell'applicazione a cui fa riferimento la connessione
    • featureCode: identificativo della feature dell'applicazione a cui fa riferimento la connessione. Se l'applicazione non ha multiple feature, il campo è null
    • permission: stringa che identifica il livello di permessi che la connessione fornisce al gestore. Valori possibili: READ, READ_WRITE
    • serviceId: identificativo del servizio al quale fa riferimento la connessione

HTTP 400

Uno o più parametri forniti nella richiesta sono errati, o mancano dei parametri obbligatori.

HTTP 401

Il token autorizzativo è scaduto, invalido o non è stato specificato.

HTTP 403

Il token autorizzativo fornito è valido, ma l'utente non ha i permessi necessari a creare una connessione per il gestore specificato. 

HTTP 500

Il server ha riscontrato un errore inaspettato nella creazione della richiesta di connessione

HTTP 502

Il server ha riscontrato un errore inaspettato nel comunicare con un servizio dal quale dipende per poter completare il processo (ad esempio, il servizio di auth non risulta essere disponibile)

Tutte le risposte d'errore condividono il seguente formato per il body di risposta:

{
  "code": "string",
  "message": "string",
  "status": "string",
  "subErrors": [
    {}
  ],
  "timestamp": "dd-MM-yyyy HH:mm:ss"
}
  • code: corrisponde al codice d'errore HTTP ritornato (es: 409)
  • message: messaggio d'errore (es: Impossibile creare una connessione gia' esistente)
  • status: descrizione a parole del codice d'errore HTTP (es: Conflict)
  • subErrors: eventuali errori innestati in quello ritornato
  • timestamp: data ed ora di ritorno dell'errore
Back to top