Integrationshandbücher › Webservice-API-Referenzhandbuch › Gültige Objekte › group-Objekt › put-Methode (group-Objekt)

put-Methode (group-Objekt)

Description

Beschreibung und gesamte Mitgliedschaft einer lokalen Gruppe ersetzen.

Syntax

/api/v2/group/put?group=group&description=description&principal=principal&vdc=controller-name 

Argument

Gruppe

Name der Gruppe

description

Eine URL-kodierte Eigentümerbeschreibung der Gruppe

principal

URL-kodierte Prinzipal-Liste mit "/" als Trennzeichen.

Zum Beispiel: local:user:api@3tera.com sollte z. B. als local%3Auser%3Aapi%403tera.com übergeben werden.

local:user:api@3tera.com /local:user:test@3tera.com sollte z. B. als local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com übergeben werden.

vdc

Name des virtuellen Rechenzentrums (Virtual Data Center), welches das Ziel darstellt

Transaktionsart

synchron

Anfragetyp

GET

Beispiele

Gesamte Beschreibung durch "API GROUP" und die Mitgliedschaft durch den einzelnen Prinzipal local:user:api@3tera.com für mygroup ersetzen

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&principal=local%3Auser%3Aapi%403tera.com&vdc=mygrid

Ersetzen Sie die gesamte Beschreibung durch "API GROUP" und die Mitgliedschaft durch die Prinzipale local:user:api@3tera.com und local:user:test@3tera.com für mygroup.

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&principal=local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com&vdc=mygrid

Beispielausgabe

JSON:

{
   "message": "",
} 

XML:

<message></message>

HTTP-Fehlercodes

400

Entität vdc mygrid nicht gefunden.
- Ein VDC-Name wurde angegeben, der in der WS_API-Anwendung nicht konfiguriert ist.

400.4

Erforderliche Argumente fehlen (group).

- Argument group=group nicht vorhanden.

Erforderliche Argumente fehlen (description).

- Argument description=description.

Erforderliche Argumente fehlen (principal).

- Argument principal=principal nicht vorhanden.

404.1

Entität nicht gefunden - Gruppe mygroup ist nicht vorhanden.

- Eine Gruppe wurde angegeben, die nicht auf mygrid vorhanden ist.

Entität nicht gefunden - Anwendungs-ACL kann nicht erstellt werden - ungültige Prinzipal-Daten - lokaler Prinzipal-Benutzer "test@3tera.com" ist nicht vorhanden.

- Ein ungültiger Prinzipal wurde angegeben.

Hinweis: Diese API ist verfügbar mit WS_API_r6-1.0.6-1 und höher.