Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2024-03-08
Gruppi

Gruppi

Endpoint URL

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
Versione: v1
Categoria
Recupero dei metadati
Descrizione
Restituisce l'elenco completo di tutti i gruppi definiti per l'istanza specificata. Sono inclusi i gruppi definiti a livello globale nell'intera istanza e i gruppi definiti dagli utenti.
Autorizzazioni necessarie per richiamare
Accesso come amministratore > Utenti
Parametri obbligatori su richiesta
Credenziali

VERBI HTTP supportati

HTTP Verb
Risorsa singola
Risorsa raccolta
Descrizione
GET
Supportato
Supportato
Recupera i gruppi dalla pianificazione.

GET:

Richiesta:
/groups/{groupId}
Recupera l'elenco di tutti i gruppi e dei relativi utenti/membri definiti per l'istanza specificata.
URI richiesta di esempio:
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
Intestazione richiesta di esempio:
Accept-Language: en
Esempio di corpo richiesta
Parametri query
Nome
Descrizione
Obbligatorio
groupId
L'ID del gruppo che si desidera restituire singolarmente
N
includeUsers
Per determinare se restituire o meno gli utenti dei gruppi chiamati. Per impostazione predefinita, l'opzione Includi utenti è attiva.
N
limit
Il numero massimo di oggetti in una singola risposta.
N
offset
Per mostrare un determinato numero di gruppi per pagina. Se sono presenti più gruppi del limite, i gruppi aggiuntivi passeranno alla pagina successiva. Per accedere a una determinata pagina, è necessario specificare il valore di offset.
N
instanceCode
Per impostazione predefinita, restituirà l'istanza predefinita assegnata all'utente. Specificando un valore, è possibile chiamare le istanze a cui l'utente ha accesso, comprese le istanze padre/figlio.
N
Risposta di esempio
Risposta di esempio
 
{
   "links": {
       "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
       "previous": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
   },
   "total": 3,
   "groups": [
       {
           "id": 2,
           "name": "Admins",
           "groupType": "NATIVE",
           "users": [
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test@email.com"
               },
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test2@email.com"
               },
           ]
       },
       {
           "id": 1,
           "name": "Corporate and Operations",
           "groupType": "NATIVE",
           "users": []
       },
       {
           "id": 3,
           "name": "Ops and Admins",
           "groupType": "NATIVE",
           "users": [],
           "groups": [
               {
                   "id": 2,
                   "name": "Admins",
                   "groupType": "NATIVE"
               },
               {
                   "id": 1,
                   "name": "Corporate and Operations",
                   "groupType": "NATIVE"
               }
           ]
       }
   ]
}
Elemento di risposta
Nome tag
risposta
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
totale
S
Numero totale di gruppi
3
gruppi
S
Informazioni sul gruppo di tutti i gruppi o di quelli specificati. Se un gruppo si trova all'interno di un altro gruppo, vengono visualizzati anche i gruppi associati al gruppo indicato.
{
"id": 1,
"name": "Corporate and Operations",
"groupType": "NATIVE",
"users": []
}
groupType
S
Mostra il tipo di gruppo.
Esterna
ID
S
ID associato del gruppo
1
nome
S
Nome del gruppo.
"Amministratori"
utenti
N
Se includeUsers = true o includeUsers è il valore predefinito, viene fornito con il guid, il wid e il nome utente dell'utente. in caso contrario non viene restituito.
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
collegamenti
N
Quando vengono forniti limiti e/o scostamenti ed è necessario un mezzo per passare a pagine diverse di gruppi, è possibile utilizzare i collegamenti per spostarsi avanti e indietro.
"links": {
"next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
"previous": "HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
}
successivo
N
Se viene specificato un limite ed è disponibile una pagina successiva, "links" viene visualizzato con "next".
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
precedente
N
Se viene specificato limite e scostamento e ci si trova nel mezzo in cui sono disponibili una pagina precedente e una successiva, "precedente" è disponibile.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
Contenuto dell'elemento
Informazioni relative agli elementi indicati.
Risposte di errore
Errori
Causa
Specificare valori di parametro validi per limite e spostamento.
input non valido per i valori limite/offset
GroupAPI: per getGroupByGroupId, gruppo non trovato per il codice istanza: {TENANT}
groupId non esiste per il codice istanza
Non si dispone di tutte le autorizzazioni per eseguire questa API: Manage Global User Groups.
le credenziali utente non dispongono delle autorizzazioni appropriate per richiamare la chiamata API
Credenziali non valide
ad esempio le credenziali utilizzate non sono corrette
HTTP 404 non trovato
Il parametro groupId non è valido