Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2023-06-23
Istanze

Istanze

URL Endpoint

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
Versione: v1
Categoria
Aggiornamento dati
Descrizione
Assegnare utenti a istanze quando si utilizzano istanze multiple di Adaptive Planning in una gerarchia padre-figlio.
Autorizzazioni necessarie per richiamare
Accesso come amministratore > Utenti
L'API Accesso utente a istanze multiple consente di recuperare e modificare le assegnazioni di istanze per un utente.

Verbi HTTPS supportati:

Verbo HTTP
Risorsa singola
Risorsa raccolta
Descrizione
GET
Non supportato
Supportato
Recupera tutte le assegnazioni di istanze degli utenti, inclusa l'assegnazione di istanze predefinite.
PATCH
Supportato
Non supportato
Aggiunge una nuova istanza all'assegnazione di istanze di un utente esistente.
PUT
Supportato
Non supportato
Aggiorna e sostituisce le istanze esistenti assegnate a un utente con i dati specificati nel corpo della richiesta.

GET

Richiesta:
/users/instances:
Recupera una raccolta di istanze assegnate agli utenti.
Recupera tutte le assegnazioni di istanze degli utenti, inclusa l'assegnazione di istanze predefinite. È possibile filtrare per instanceCode. L'impaginazione utilizza i valori predefiniti per il limite o l'offset se mancano questi parametri di query.
URI richiesta di esempio
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
Intestazione richiesta di esempio:
Accept-Language: en
Esempio di corpo richiesta
Parametri query
Nome
Descrizione
Obbligatorio
instanceCode
Identificatore univoco di un'istanza che definisce il contesto dell'istanza per recuperare l'elenco di utenti per tale istanza. Se non viene specificato un codice istanza, vengono recuperati tutti gli utenti dell'istanza predefinita del chiamante API.
N
limit
Il numero massimo di oggetti in una singola risposta. Il valore predefinito è 500. Il massimo è 500.
N
offset
Indice in base zero del primo utente in una raccolta di risposte. Il valore predefinito è 0.
Utilizzare l'offset con il parametro limit per controllare il paging di una raccolta di risposte.
N
Risposta di esempio
200
Risposta riuscita
Risposta di esempio
 

{
"links": {
   "next": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=10&limit=5",
   "previous": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=0&limit=5"
},
"total": 26,
"users": [
   {
       "userGuid": "111SampleUserGuid",
       "userName": "sampleuser1@company.com",
       "wid" : "14400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "222SampleUserGuid",
       "userName": "sampleuser2@company.com",
       "wid" : "31100000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "474C4F424F0000000000000001sampleGuid",
       "userName": "sampleuser3@company.com",
       "wid" : "34400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "111C4F424F0000000000000001sampleGuid",
       "userName": "sampleuser5@company.com",
       "wid" : "343400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "374C4F424F0000000000sampleGuid",
       "userName": "sampleuser4@company.com,
       ""wid" : "355000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany_Child1"
           },
           {
               "code": "sampleCompany_Child2"
           },
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   }
]
}

PATCH:

Richiesta:
users/instances?instanceCode={INSTANCECODE}:
Aggiorna parzialmente l'assegnazione dell'istanza di un utente esistente.
Aggiunge una nuova istanza all'assegnazione di istanze di un utente esistente. Se si specifica l'attributo predefinito per un'istanza, questo sostituisce l'assegnazione dell'istanza predefinita corrente dell'utente.
Specificare un ID utente nel parametro di query userIdentifier.
Nel corpo della richiesta, specificare un userIdentifier.
URI richiesta di esempio
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
Esempio di corpo richiesta
Esempio di corpo richiesta PATCH
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
Parametri query
Nome
Descrizione
Obbligatorio
instanceCode
Un codice di istanza che è più alto nella stessa gerarchia di istanze dell'istanza aggiunta per un utente esistente. Solo gli utenti con accesso all'istanza padre di livello superiore possono aggiungere istanze figlio.
N
userIdentifier
Un userIdentifier viene utilizzato per determinare l'utente univoco di Adaptive Planning. Valori possibili: userName, wid, userGuid.
S
Intestazione richiesta
Tipo contenuto
application/json
Autorizzazione
Base o basata su token
Parametri del carico utile
Nome
Descrizione
Obbligatorio
wid
L'ID Workday di un utente.
N
userName
Il nome utente (nome di accesso) di un utente.
N
userGuid
Identificatore utente univoco globale, assegnato dal sistema al momento della creazione dell'utente.
N
codice istanza
Un instanceCode dell'azienda da assegnare a un utente nel Payload.
S
predefinito
Il valore instanceCode predefinito assegnato a un utente nel Payload.
N

PUT:

Richiesta:
users/instances
:
aggiorna e sostituisce le istanze esistenti assegnate a un utente
Aggiorna un'istanza esistente assegnata a un utente con lo userIdentifier specificato. Sostituisce le istanze assegnate all'utente con i dati specificati nel corpo della richiesta.
  • Se l'assegnazione di un'istanza non fa parte delle istanze esistenti assegnate a un utente, aggiunge l'istanza.
  • Se l'assegnazione di un'istanza non fa parte del corpo della richiesta, l'accesso all'istanza viene rimosso se esisteva in precedenza.
  • Specificare un ID utente nel parametro di query userIdentifier.
  • Specificare un codice istanza nel parametro di query instanceCode, se necessario.
  • Un ID utente nel parametro di query userIdentifier.
  • Nel corpo della richiesta, specificare i seguenti campi obbligatori: <userIdentifier> (Username, WID o userGUID). <userIdentifier> è il valore specificato nel parametro di query userIdentifier.
  • Se si specifica l'attributo predefinito per un'istanza, sostituisce l'istanza predefinita corrente per l'utente.
URI richiesta di esempio
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
Esempio di corpo richiesta
Esempio di corpo richiesta PUT 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
Parametri query
Nome
Descrizione
Obbligatorio
instanceCode
Un codice di istanza che è più alto nella stessa gerarchia di istanze dell'istanza aggiunta per un utente esistente. Solo gli utenti con accesso all'istanza padre di livello superiore possono aggiungere istanze figlio.
N
userIdentifier
Un userIdentifier viene utilizzato per determinare l'utente univoco di Adaptive Planning. Valori possibili: userName, wid, userGuid.
S
Intestazione richiesta
Tipo contenuto
application/json
Autorizzazione
Base o basata su token
Parametri del carico utile
Nome
Descrizione
Obbligatorio
wid
L'ID Workday di un utente.
N
userName
Il nome utente (nome di accesso) di un utente.
N
userGuid
Identificatore utente univoco globale, assegnato dal sistema al momento della creazione dell'utente.
N
codice istanza
Un instanceCode dell'azienda da assegnare a un utente nel Payload.
S
predefinito
Il valore instanceCode predefinito assegnato a un utente nel Payload.
N
Risposte
Risposte
Elenco dei codici di stato supportati:
200
Risposta riuscita.
Esempio di risposta
Esempio 200 Risposta PATCH riuscita
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
Errore interno del server
Esempio: se Utente non valido.
Risposta di esempio 500
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
Esempio: if non valido instanceCode
Risposta di esempio 500
 

{
  "userName": "user@samplecompany.com",
  "instances": [
      {
          "status": {
              "errorMessage": "SampleOtherCompany not in SampleCompany network. API Caller: APICaller@samplecompany.com  not authorized to assign user: user@samplecompany.com to Instance: SampleOtherCompany "
          },
          "code": "SampleCompany",
          "default": true
      },
      {
          "code": "SAMPLECOMPANY_CHILD2"
      }
  ]
}
405
Risorsa o operazione non valida
403
L'utente non dispone di autorizzazioni sufficienti
404
Risorsa non trovata.