spaces /{space-id}
Utilizzare questa risorsa per richiamare le informazioni su uno spazio specifico.
Riepilogo del metodo
| Metodo HTTP | Percorso | Descrizione |
|---|---|---|
| GET | /bwl/spaces/{space-id} | Richiama informazioni su uno specifico spazio. È necessario avere accesso a questo spazio. |
GET /spaces/{space-id}
- Descrizione
- Utilizzare questo metodo per restituire dettagli di uno specifico spazio.
- Informazioni risorsa
Requisiti Descrizione Formato della risposta JSON Richiede l'autenticazione Vero Supporta le credenziali client OAuth 2 Sì, utilizzando un ID servizio utente contenente la categoria di creazione report della risorsa utente
- Parametri
Nome Ubicazione Descrizione Obbligatorio Tipo X-IBM-API-Version Intestazione La versione di questa API. Quando si esegue una programmazione sull'API, è OBBLIGATORIO includere questa versione. In caso contrario viene utilizzata la versione più recente dell'API, che potrebbe però essere incompatibile con le versioni precedenti. Il valore corrente è
1.0.0.No La stringa X-On-Behalf-Of Intestazione Il contesto utente. Il valore deve essere un nome utente nell'account. L'utente deve disporre dell'autorizzazione per eseguire l'azione nell'account e nello spazio parent specificato, se presente. Obbligatorio se vengono utilizzate le credenziali OAuth dell'ID servizio. Non richiesto quando si utilizza la credenziale OAuth dell'ID servizio utente. La stringa space-id Percorso L'identificativo dello spazio da richiamare. Vero La stringa archived-state Interroga Filtra le risorse utente child restituite in base allo stato archiviato della risorsa utente. Se non specificato, viene utilizzato active.I valori consentiti sono
all,activeearchived.No La stringa include-subspaces Interroga Indica se includere i dettagli degli spazi secondari nella risposta. No Booleano published-state Interroga Filtra le risorse utente child restituite in base allo stato pubblicato della risorsa utente. Le politiche child e gli spazi child non vengono influenzati da questo filtro. Se non specificato, viene utilizzato all.I valori consentiti sono
all,publishedeunpublished.No La stringa
- Risposta
- Input di esempio
- Ottenere i dettagli di uno specifico spazio:
- Utilizzando le credenziali client OAuth 2:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/bwl/spaces/1310cb?include-subspaces=true"
- Utilizzando le credenziali client OAuth 2:
- Output di esempio
- Ottenere i dettagli di uno specifico spazio:
{ "name": "My Space", "id": "1310cb", "tags": [ "demo", "space-details-api" ], "description": "Space Details API Example Output", "goals": [ { "description": "Goal 1", "weight": "high" }, { "description": "Goal 2", "weight": "medium" }, { "description": "Goal 3", "weight": "low" } ], "users": [ { "participant": { "name": "Edith Editor", "id": "50023", "type": "user" }, "permissions": { "blueprint-processes": true, "automate-processes": true, "compose-decisions": true, "author-policies": true, "manage-and-edit": true } }, { "participant": { "type": "all-editors" }, "permissions": { "blueprint-processes": true, "automate-processes": true, "compose-decisions": true, "author-policies": true, "manage-and-edit": false } }, { "participant": { "type": "all-contributors" }, "permissions": { "blueprint-processes": false, "automate-processes": true, "compose-decisions": false, "author-policies": false, "manage-and-edit": false } }, { "participant": { "type": "all-community" }, "permissions": { "blueprint-processes": false, "automate-processes": false, "compose-decisions": false, "author-policies": false, "manage-and-edit": false } }, { "participant": { "name": "My Custom Group", "id": "1310d7", "type": "user-group" }, "permissions": { "blueprint-processes": true, "automate-processes": true, "compose-decisions": false, "author-policies": true, "manage-and-edit": false } } ], "subspaces": [ { "name": "My Subspace", "id": "131934", "tags": [ "child-of-root-space", "subspace" ], "goals": [ { "description": "Subspace goal 1", "weight": "low" }, { "description": "Subspace goal 2", "weight": "medium" }, { "description": "Subspace goal 3", "weight": "high" } ], "users": [ { "participant": { "name": "Edith Editor", "id": "50023", "type": "user" }, "permissions": { "blueprint-processes": true, "automate-processes": true, "compose-decisions": true, "author-policies": true, "manage-and-edit": true } }, { "participant": { "type": "all-editors" }, "permissions": { "blueprint-processes": true, "automate-processes": true, "compose-decisions": true, "author-policies": true, "manage-and-edit": false } }, { "participant": { "type": "all-contributors" }, "permissions": { "blueprint-processes": false, "automate-processes": true, "compose-decisions": false, "author-policies": false, "manage-and-edit": false } }, { "participant": { "type": "all-community" }, "permissions": { "blueprint-processes": false, "automate-processes": false, "compose-decisions": false, "author-policies": false, "manage-and-edit": false } } ], "space-ids": [ "1310cb" ], "space-names": [ "My Space" ], "archived-state": "active", "last-modified-date": "2017-01-13T04:34:47.073+0000", "last-modified-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "created-date": "2017-01-12T22:29:51.106+0000", "created-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" } } ], "blueprints": [ { "id": "1310dc", "name": "My Blueprint", "type": "blueprint", "tags": [ "lambda" ], "space-ids": [ "1310cb" ], "space-names": [ "My Space" ], "archived-state": "active", "published-state": "unpublished", "last-modified-date": "2017-01-12T22:32:57.146+0000", "last-modified-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "created-date": "2017-01-12T22:29:51.106+0000", "created-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" } } ], "decisions": [ { "id": "1c002a", "name": "My Published Decision", "type": "decision", "current-name": "My Published Decision", "space-ids": [ "1310cb" ], "space-names": [ "My Space" ], "archived-state": "active", "published-state": "published", "last-modified-date": "2017-01-13T20:34:15.237+0000", "last-modified-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "created-date": "2017-01-12T22:29:51.106+0000", "created-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "published-date": "2017-01-13T20:34:15.237+0000", "published-snapshot-name": "v1", "published-snapshot-date": "2017-01-13T20:34:11.362+0000" } ], "policies": [ { "id": "1a001d", "name": "My Archived Policy", "type": "policy", "tags": [ "archived" ], "space-ids": [ "1310cb" ], "space-names": [ "My Space" ], "archived-state": "archived", "last-modified-date": "2017-01-13T15:10:55.676+0000", "last-modified-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "created-date": "2017-01-12T22:29:51.106+0000", "created-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" } } ], "archived-state": "active", "last-modified-date": "2017-01-15T00:21:55.841+0000", "process-apps": [ { "id": "131902", "name": "My Process App", "type": "process-app", "space-ids": [ "1310cb" ], "space-names": [ "My Space" ], "archived-state": "active", "published-state": "unpublished", "last-modified-date": "2017-01-12T22:34:02.175+0000", "last-modified-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "created-date": "2017-01-12T22:29:51.106+0000", "created-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" } } ] }
- Messaggi di risposta
Codice HTTP Motivo 200 La richiesta è stata completata correttamente.
400 Si è verificato un errore durante l'elaborazione della richiesta. I parametri richiesti non sono presenti o contengono valori non validi.
401 Questo utente non ha superato l'autenticazione. Questa risposta può essere restituita per i seguenti motivi:- Sono stati forniti un nome utente o una password non validi.
- Questo utente appartiene a più account e un account non è stato specificato nella richiesta.
403 L'accesso è vietato poiché non si dispone di autorizzazioni sufficienti per lo spazio specificato.
404 Il parametro space - id identifica uno spazio che non esiste in questo account.
Per ulteriori informazioni, consultare le specifiche di OpenAPI.