Interfejs usług REST dla zasobów związanych z definicją BPD-Zasób grupy-Metoda PUT

Zaktualizuj przypisanie dla grupy, która została zdefiniowana w instalacji IBM Business Automation Workflow .

Przykładowe wywołanie metody

PUT /rest/bpm/wle/v1/group/{groupNameOrID}?action={string}&user={string}&group={string}[&parts={string}]

Użycie notatek

W przypadku zainstalowania poprawki zbiorczej 2016.09 produktu IBM BPM V8.5.7 dozwolone są tylko poprawne aktualizacje przypisania do grup. Poniższa lista zawiera opisy akceptowalnych i nieakceptowalnych aktualizacji według typu grupy. Grupa nadrzędna odnosi się do grupy, która jest aktualizowana. podgrupa odnosi się do zagnieżdżonej grupy, która jest dodawana do grupy nadrzędnej lub usuwana z niej.

Typ grupy nadrzędnej: grupa uprawnień
- Dodawanie użytkowników: niedozwolone
- Usuwanie użytkowników: niedozwolone
- Dodawanie podgrup: niedozwolone
- Usuń podgrupy: dozwolone
Typ grupy nadrzędnej: grupa uczestników
- Dodaj użytkowników: dozwolone
- Usuwanie użytkowników: dozwolone
- Dodawanie podgrup: dozwolone tylko dla grup zabezpieczeń i grup wewnętrznych
- Usuń podgrupy: dozwolone
Typ grupy nadrzędnej: grupa ad hoc
- Dodawanie użytkowników: niedozwolone
- Usuwanie użytkowników: niedozwolone
- Dodawanie podgrup: niedozwolone
- Usuń podgrupy: niedozwolone
Typ grupy nadrzędnej: grupa wewnętrzna
- Dodaj użytkowników: dozwolone
- Usuwanie użytkowników: dozwolone
- Dodawanie podgrup: dozwolone tylko dla grup zabezpieczeń i grup wewnętrznych
- Usuń podgrupy: dozwolone
Typ grupy nadrzędnej: grupa dynamiczna
- Dodawanie użytkowników: niedozwolone
- Usuwanie użytkowników: niedozwolone
- Dodawanie podgrup: niedozwolone
- Usuń podgrupy: niedozwolone

Parametry

Wymagane parametry

Nazwa Typ wartości Opis

działanie

łańcuch

Działanie, które ma zostać wykonane dla określonej grupy.

Wartość	Opis
addMember	Dodaje `user` lub `group` do członkostwa w określonej grupie.
removeMember	Usuwa `user` lub `group` z członkostwa w określonej grupie.

Użytkownik

łańcuch

Identyfikator użytkownika lub nazwę użytkownika, które mają zostać dodane do przypisania określonej grupy. Wymagany jest parametr user lub group .

Grupa

łańcuch

Identyfikator grupy lub nazwa grupy, która ma zostać dodana do członkostwa w określonej grupie. Wymagany jest parametr user lub group .

Parametry opcjonalne

Nazwa	Typ wartości	Opis
części	łańcuch	Części danych odpowiedzi, które mają zostać zwrócone. Można użyć następujących wartości: `members`, `all` (wartość domyślna) lub `none`.

Treść żądania

Brak

Treść odpowiedzi

Grupa-zaktualizowane szczegóły powiązane z grupą, która została zdefiniowana dla instalacji IBM Business Automation Workflow (grupa complexType).

Domyślny typ treści toapplication/json.

Typ MIME: application/json

Schemat

{"description": "Grupa", 
   "type":"object",
   "właściwości":
   {  
      "groupID": {"type": "integer",
         "description": "Identyfikator grupy grupy, która jest opisana przez ten obiekt."
      },
      "groupName": {"typ": "łańcuch",
         "description": "Nazwa grupy grupy, która jest opisana przez ten obiekt."
      },
      "displaylName": {"type": "string",
         "description": "Nazwa wyświetlana grupy, która jest opisana przez ten obiekt."
      },
      "description": {"typ": "łańcuch",
         "description": "Opis grupy powiązanej z tym obiektem."
      },
      "members": {"type": "[ łańcuch]",
      	"description": "Lista użytkowników, którzy są członkami grupy powiązanej z tym obiektem."
      },
      "managerGroupNazwa": {"type": "string",
         "description": "Nazwa grupy grupy menedżerów, która jest powiązana z tym obiektem."
      }
   }
}

Przykładowa treść

{
   "status": "200",
   "data": {
      "groupID": 3,
      "groupName": "tw_admins",
      "displayName": "tw_admins",
      "description": "Grupa dla osób z pełnym dostępem do zespołu Teamworks.",
      "members": [
         "tw_admin"
      ],
      "managerGroupNazwa": "mTeam_T_8d643861-ec74-4877-a18b-0728ad57033e.e0b4a6b9-12eb-4565-8857-831847d11ad9"
   }
}

Typ MIME: application/xml

Schemat

<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/usergroup"
	elementFormDefault= "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/usergroup"
	xmlns:data = "http://rest.bpm.ibm.com/v1/data/root" 
	xmlns:cmn = "http://rest.bpm.ibm.com/v1/data/common">

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />

    <!-- 
	 Ten typ reprezentuje użytkownika, który został zdefiniowany w instalacji produktu IBM BPM .
    -->
    <complexType name="User">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- Identyfikator liczbowy użytkownika -- >
		    < element name= "userID" type = "long " />

		    <! -- alfanumeryczna nazwa użytkownika powiązana z użytkownikiem -- >
		    < element name= "userName" type = "string " />

		    <! -- Pełna nazwa użytkownika -- >
		    < element name= "fullName" type="string " minOccurs= "0" />

		    <! -- To pole wskazuje, czy ten użytkownik jest dezaktywowany. -- >
		    < element name= "isDisabled" type = "boolean" />

		    <! -- nieużywane -- >
		    < element name= "primaryGroup" type="string " minOccurs= "0" />

		    <! -- nieużywane -- >
		    < element name= "emailAddress" type="string " minOccurs= "0" />

		    <! -- Lista preferencji użytkownika (atrybutów rozszerzonych) powiązanych z tym użytkownikiem -- >
		    < element name= "userPreferences" type="cmn :Map " minOccurs= "0" />

		    <! -- Lista preferencji użytkownika, którymi użytkownik może zarządzać -- >
		    < element name= "editableUserPreferences" type="string " minOccurs= "0" maxOccurs= "unbounded " />

		    <! -- Lista zadań (taskIds), nad którymi współpracuje użytkownik -- >
		    < element name= "tasksCollaboration" type="string " minOccurs= "0" maxOccurs= "unbounded " />

		    <! -- Lista grup, do których należy ten użytkownik -- >
		    < element name = "memberships "type="string" maxOccurs= "unbounded " minOccurs= "0" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!-- 
	 Ten typ reprezentuje użytkownika z obciążeniem zdefiniowanym w instalacji produktu IBM BPM .
    -->
    <complexType name= "TeamMember">
	<complexContent>
	    < extension base="tns: Użytkownik">
		<sequence>

		    <! -- Identyfikator liczbowy użytkownika -- >
		    < element name = "workload "type = "integer" />

		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <!-- 
	 Ten typ reprezentuje użytkownika z obciążeniem zdefiniowanym w instalacji produktu IBM BPM .
    -->
    <complexType name="Ekspert ">
	<complexContent>
	    < extension base="tns:TeamMember">
		<sequence>

		    <! -- TODO-co to jest -- >
		    < element name = "completed "type = "integer" />
		    
		    <! -- TODO-co to jest -- >
		    < element name= "avgHours" type = "double " />		    

		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <!-- 
     Ten typ reprezentuje tablicę Ekspertów
    -->
    <complexType name="Eksperty">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
	    		<! -- MOŻE ZAWIERAĆ -- >
		    	< element name="Experts "type="tns: Expert" minOccurs= "0 " maxOccurs= "unbounded" />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>	
    
   <!-- 
	 Ten typ reprezentuje listę użytkowników zaawansowanych z obciążeniem zdefiniowanym w instalacji produktu IBM BPM .
    -->
    <complexType name= "ExpertList">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- grupa użytkowników, których system identyfikuje jako ekspertów w zadaniu -- >
		    < element name= "systemIdentifiedUsers" type="tns: Expert " maxOccurs= "unbounded" minOccurs= "0 " />
		    
		    <! -- grupa użytkowników włączonych do grupy uczestników eksperckich zadań -- >
		    < element name= "expertParticipantGroupUsers" type="tns: Expert " maxOccurs= "unbounded" minOccurs= "0 " />	

		    <! -- grupa uczestników eksperckich zadań -- >
		    < element name= "expertParticipantGroupDetails" type="tns: Group " />

		</sequence>
	    </extension>
	</complexContent>
    </complexType>    
    
    <!-- 
	 Ten typ reprezentuje użytkownika, który został zdefiniowany w instalacji produktu IBM BPM .
    -->
    <complexType name= "UserPreferences">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- Nazwa wyświetlana użytkownika -- >
		    < element name= "displayName" type = "string " />

		    <! -- Opis roli głównej użytkownika -- >
		    < element name= "primaryRoleDescription" type="string " />

		    <! -- Adres e-mail zadania użytkownika -- >
		    < element name= "taskEmailAdres" type="string " />

		    <! -- Numer telefonu użytkownika -- >
		    < element name= "phoneNumber" type = "string " />
		    
		    <! -- Adres ulicy użytkownika -- >
		    < element name= "streetAddress" type = "string " />
		    
		    <! -- Miasto użytkownika -- >
		    < element name = "city "type = "string" />
		    
		    <! -- Stan użytkownika -- >
		    < element name = "state "type = "string" />
		    
  		    <! -- Kraj użytkownika -- >
		    < element name = "country "type = "string" />
		    
		    <! -- Kod pocztowy użytkownika-->
		    < element name= "postalCode" type = "string " />
		    
		    <! -- Obraz użytkownika -- >
		    < element name = "image "type = "łańcuch" />

		    <! -- Upłynęło ustawienie paska narzędzi użytkownika -- >
		    < element name= "toolbarCollapsed" type = "boolean" />			    		    		    
		</sequence>
	    </extension>
	</complexContent>
    </complexType>    

    <!--
	Ten typ reprezentuje grupę, która została zdefiniowana w instalacji produktu IBM BPM .
    -->
    <complexType name="Grupa">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- Identyfikator liczbowy grupy -- >
		    < element name= "groupID" type = "long " />

		    <! -- alfanumeryczna nazwa grupy -- >
		    < element name= "groupName" type = "string " />

		    <! -- Nazwa wyświetlana powiązana z grupą -- >
		    < element name= "displayName" type = "string " />

		    <! -- Opis powiązany z grupą -- >
		    < element name = "description "type = "łańcuch" />

		    <! -- Informacje, jeśli ta grupa jest logicznie usunięta -- >
		    < element name = "deleted "type =" boolean " />

		    <! -- Lista użytkowników, którzy są członkami tej grupy -- >
		    < element name = "members "type="string" maxOccurs= "unbounded " minOccurs= "0" />
		    
		    <! -- Nazwa alfanumeryczna grupy menedżerów -- >
		    < element name= "managerGroupName" type="string " minOccurs= "0" />		    
		</sequence>
	    </extension>
	</complexContent>
    </complexType>    
    
    <!-- 
	 Ten typ reprezentuje listę wszystkich użytkowników, którzy zostali zdefiniani w instalacji produktu IBM BPM .
    -->
    <complexType name= "UserList">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    < element name="users "type="tns: User" maxOccurs= "unbounded " minOccurs= "0" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!-- 
	 Ten typ reprezentuje listę grup użytkowników, które zostały zdefiniowane w instalacji produktu IBM BPM .
    -->
    <complexType name= "GroupList">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    < element name="groups "type="tns: Group" maxOccurs= "unbounded " minOccurs= "0" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
   	< element name="Użytkownik "type="tns: User" /> 
  	< element name= "TeamMember" type="tns:TeamMember" />
   	< element name="Expert "type="tns: Expert" />    	    
   	< element name="Experts "type="tns: Experts" />    	    
   	< element name= "UserPreferences" type="tns:UserPreferences" />
   	< element name="Group "type="tns: Group" />    	
   	< element name= "UserList" type="tns:UserList" />    	
   	< element name= "GroupList" type="tns:GroupList" />    	

</schema>

Przykładowa treść

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< bpm:ResponseData xmlns:bpm = 'http://rest.bpm.ibm.com/v1/data' >
  <status>200</status>
  < data xmlns:xsi = 'http://www.w3.org/2001/XMLSchema-instance' xmlns:ug = 'http://rest.bpm.ibm.com/v1/data/usergroup' xsi:type= 'ug :Group' >
    <groupID>3</groupID>
    <groupName> tw_admins </groupName>
    <displayName> tw_admins </displayName>
    < description> Group for people with full access to Teamworks. < /description>
    < members> tw_admin < /members>
    <managerGroupName>mTeam_T_8d643861-ec74-4877-a18b-0728ad57033e.e0b4a6b9-12eb-4565-8857-831847d11ad9</managerGroupName>
  < /data>
< /bpm:ResponseData>

Typ MIME: application/x-javascript

Treść odpowiedzi o błędzie

Szczegółowe informacje o błędzie

Domyślny typ treści toapplication/json.

Typ MIME: application/json

Schemat

{"description": "Odpowiedź na błąd WLE", 
   "type":"object",
   "właściwości":
   {"status": {"typ": "łańcuch",
         "description": "Status poprzedniego wywołania funkcji API."
      },
      "exceptionType": {"typ": "łańcuch",
         "description": "Nazwa klasy powiązana z wyjątkiem."
      },
      "errorNumber": {"typ": "łańcuch",
         "description": "Identyfikator komunikatu wyjątku."
      },
      "errorMessage": {"type": "string",
         "description": "Tekst komunikatu wyjątku."
      },
      "errorMessageParametry": {"type": [ "string"], "optional": true,
         "description": "Parametry tekstu komunikatu wyjątku."
      },
      "programmersDetails": {"type": "obiekt", "opcjonalny": true,
         "description": "Dodatkowe szczegóły wyjątku, na przykład stos wywołań."
      }
   }
}

Typ MIME: application/xml

Schemat

<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/exception"
	elementFormDefault= "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/exception"
	xmlns:dat = "http://rest.bpm.ibm.com/v1/data/root">

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    
    <!--
	Ten typ reprezentuje odpowiedź na błąd.
    -->    
    < element name= "RestRuntimeException">
	<complexType>
	    <sequence>
		< element name = "status "type="string" />
		< element name="Data " type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 Ten typ zawiera szczegółowe informacje o błędach powiązane z wyjątkiem.
    -->
    <complexType name= "ExceptionData">
	<sequence>
	    < element name = "status "type="string" />

	    <! -- Ta opcja określa nazwę klasy języka Java dla wyjątku -- >
	    < element name= "exceptionType" type="string " />

	    <! -- Identyfikator komunikatu o błędzie -- >
	    < element name= "errorNumber" type="string " minOccurs= "0" />

	    <! -- kompletny komunikat o błędzie -- >
	    < element name= "errorMessage" type="string " />

	    <! -- Lista łańcuchów wstawionych do komunikatu o błędzie -- >
	    < element name= "errorMessageParameters" type="string " minOccurs= "0" maxOccurs= "unbounded " />

	    <!-- 
		 Stos wywołań powiązany z wyjątkiem.
		 Należy pamiętać, że zostanie pominięta, chyba że właściwość "server-stacktrace-enabled"
		 jest włączona w pliku 100Custom.xml serwera.
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- Wcześniejsze odpowiedzi.  Ustaw, jeśli użyto komendy masowej -- >
	    < element name = "responses "type="dat:BulkCommandOdpowiedzi" minOccurs= "0"> < /element>

            < element name= "errorData" type="tns:ErrorData" minOccurs= "0" />
	</sequence>
    </complexType>

    <complexType name= "ErrorData">
        <sequence>
            < element name = "code "type = "string" />
            < element name = "data "type="string" minOccurs= "0 " />
        </sequence>
    </complexType>
    
</schema>

Typ MIME: application/x-javascript

Kody statusu

Metoda zwraca jeden z następujących kodów statusu:

Kod	Opis
200 OK	Zakończenie powiodło się.
400 Błędne żądanie	Parametry są niepoprawne lub nie są one poprawne.
401 Unauthorized	Program wywołujący nie jest autoryzowany dla tego żądania.
406 Nieakceptowalne	Żądany typ treści lub kodowanie treści nie jest obsługiwane.
500 Wewnętrzny błąd serwera	Wystąpił poważny problem. Szczegółowe informacje o programiście są dostępne.

Dostępne od

8.5.0.1

Temat Nadrzędny: Zasób Grupy