IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/participantGroup/{participantGroupId}[?snapshotId={string}][&branchId={string}]
Name | Value Type | Description |
---|---|---|
snapshotId | string | The ID of the snapshot associated with the participant group. Either 'snapshotId' or 'branchId' must be specified.
|
branchId | string | The ID of the branch associated with the participant group. Either 'snapshotId' or 'branchId' must be specified.
|
None
The default content type is application/json.
{ "status":"200", "data":{ "name":{"type": "string", "description": "The name of the participant group."}, "type":{"type": "string", "description": "The type of the participant group.", "enum": [ "Expression", "StandardMembers", "System" ] }, "desc":{"type": "string", "description": "The description of the participant group."}, "members":{"type": "[object]", "description": "It only applies when the type is StandardMembers.", { [ { "name":{"type": "string", "description": "The name of the member."}, "type":{"type": "string", "description": "The type of the member, either 'User' or 'Group'."} } ] } }, "orgExpression": {"type": "{object}", "description": "It only applies when the type is Expression.", { "ruleSetOperator":{"type": "string", "description": "Indicates whether the users match all or any of the rules.", "enum": [ "all", "any" ] }, "rules":[ { "matchType":{"type": "string", "description": "Indicates whether the users belong to a participant group.", "enum": [ "belong", "notBelong" ] }, "participantName": {"type": "string", "description": "The name of the participant group specified in this participant rule."}, "snapshotId":{"type": "string", "description": "The ID of the snapshot associated with the participant group. Either 'snapshotId' or 'branchId' must be specified."}, "branchId":{"type": "string", "description": "The ID of the branch associated with the participant group. Either 'snapshotId' or 'branchId' must be specified."}, "ruleType":"Participant", "ParticipantId":{"type": "string", "description": "The ID of the participant group specified in this participant rule."} }, { "comparator":{"type": "string", "description": "Compares the attribute that the users have with the value in the rule.", "enum": [ "Equal", "LessThan", "GreaterThan", "NotEqual", "GreaterThanEqual", "LessThanEqual" ] }, "userAttributeName":{"type": "string", "description": "The name of the user attribute."} "userAttributeValue":{"type": "string", "description": "The value of the user attribute."} "userAttributeId":{"type": "string", "description": "The persistent object ID of the user attribute."} "snapshotId":{"type": "string", "description": "The ID of the snapshot associated with the user attribute. Either 'snapshotId' or 'branchId' must be specified."}, "branchId":{"type": "string", "description": "The ID of the branch associated with the user attribute. Either 'snapshotId' or 'branchId' must be specified."}, "ruleType":"UserAttribute" }, { "matchType":{"type": "string", "description": "Indicates whether the users match the expression.", "enum": [ "match", "notMatch" ] }, "value":{"type": "string", "description": "The value of the expression."} "ruleType":"Expression" } ] } } } }
{ "status":"200", "data":{ "name":"PG1", "type":"Expression", "desc":"description aaa", "members":null, "orgExpression":{ "ruleSetOperator":"all", "rules":[{ "matchType":"belong", "participantName":"GeneralManagers", "snapshotId":"2064.6de8746b-ce68-4dbc-ae97-fad12788b498", "branchId":null, "ruleType":"Participant", "ParticipantId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827" }, { "comparator":"Equal", "userAttributeName":"Primary Role", "userAttributeValue":"10", "userAttributeId":"51.749fb5c9-aa69-4fde-8328-ac6f7c4b6cd3", "snapshotId":"2064.74f9ea10-a351-4c42-ada5-b3dce7145330", "branchId":null, "ruleType":"UserAttribute" }, { "matchType":"match", "value":"test", "ruleType":"Expression" } ] } } }
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/participantgroup" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/participantgroup" xmlns:pref="http://rest.bpm.ibm.com/v1/data/root" xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common"> <import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common" /> <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" /> <simpleType name="ParticipantType"> <restriction base="string"> <enumeration value="StandardMembers" /> <enumeration value="Expression" /> <enumeration value="System" /> <enumeration value="TeamByService" /> </restriction> </simpleType> <simpleType name="RuleType"> <restriction base="string"> <enumeration value="Participant" /> <enumeration value="UserAttribute" /> <enumeration value="Expression" /> </restriction> </simpleType> <simpleType name="RuleSetOperator"> <restriction base="string"> <enumeration value="all" /> <enumeration value="any" /> </restriction> </simpleType> <simpleType name="CustomerRuleMatchType"> <restriction base="string"> <enumeration value="match" /> <enumeration value="notMatch" /> </restriction> </simpleType> <simpleType name="ParticipantRuleMatchType"> <restriction base="string"> <enumeration value="belong" /> <enumeration value="notBelong" /> </restriction> </simpleType> <simpleType name="Comparator"> <restriction base="string"> <enumeration value="Equal" /> <enumeration value="LessThan" /> <enumeration value="GreaterThan" /> <enumeration value="NotEqual" /> <enumeration value="GreaterThanEqual" /> <enumeration value="LessThanEqual" /> </restriction> </simpleType> <complexType name="Member"> <sequence> <element name="name" type="string" /> <element name="type" type="string" /> <element name="desc" type="string" /> </sequence> </complexType> <complexType name="OrgExprRule" abstract="true" > <sequence> <element name="ruleType" type="tns:RuleType" /> </sequence> </complexType> <complexType name="OrgExprParticipantRule"> <complexContent> <extension base="tns:OrgExprRule"> <sequence> <element name="matchType" type="tns:ParticipantRuleMatchType" /> <element name="participantName" type="string" /> <element name="ParticipantId" type="string" /> <choice> <element name="snapshotId" type="string" /> <element name="branchId" type="string" /> </choice> </sequence> </extension> </complexContent> </complexType> <complexType name="OrgExprUserAttrRule"> <complexContent> <extension base="tns:OrgExprRule"> <sequence> <element name="comparator" type="tns:Comparator" /> <element name="userAttributeName" type="string" /> <element name="userAttributeValue" type="string" /> <element name="userAttributeId" type="string" /> <choice> <element name="snapshotId" type="string" /> <element name="branchId" type="string" /> </choice> </sequence> </extension> </complexContent> </complexType> <complexType name="OrgExprCustomRule"> <complexContent> <extension base="tns:OrgExprRule"> <sequence> <element name="matchType" type="tns:CustomerRuleMatchType" /> <element name="value" type="string" /> </sequence> </extension> </complexContent> </complexType> <complexType name="OrgExpression"> <sequence> <element name="ruleSetOperator" type="tns:RuleSetOperator" /> <element name="rules" type="tns:OrgExprRule" maxOccurs="unbounded" /> </sequence> </complexType> <complexType name="RestParticipant"> <complexContent> <extension base="pref:Data"> <sequence> <element name="name" type="string" /> <element name="type" type="tns:ParticipantType" /> <element name="desc" type="string" /> <element name="richDesc" type="string" /> <choice> <element name="members" type="tns:Member" maxOccurs="unbounded" /> <element name="orgExpression" type="tns:OrgExpression" /> </choice> </sequence> </extension> </complexContent> </complexType> <complexType name="TeamByService"> <sequence> <element name="serviceName" type="string" /> <element name="serviceId" type="string" /> <element name="svcDescription" type="string" /> </sequence> </complexType> <complexType name="RestTeam"> <complexContent> <extension base="pref:Data"> <sequence> <element name="name" type="string" /> <element name="id" type="string" /> <element name="type" type="tns:ParticipantType" /> <element name="desc" type="string" /> <element name="richDesc" type="string" /> <element name="groupId" type="long" /> <element name="managersTeamName" type="string" /> <choice> <element name="members" type="tns:Member" maxOccurs="unbounded" /> <element name="orgExpression" type="tns:OrgExpression" /> <element name="teamByService" type="tns:TeamByService" /> </choice> </sequence> </extension> </complexContent> </complexType> </schema>
The default content type is application/json.
{ "description": "WLE Error Response", "type": "object", "properties": { "status": {"type": "string", "description": "The status of the previous API call." }, "exceptionType": {"type": "string", "description": "The classname associated with the exception." }, "errorNumber": {"type": "string", "description": "Message ID of the exception." }, "errorMessage": {"type": "string", "description": "Message text of the exception." }, "errorMessageParameters": {"type": ["string"], "optional": true, "description":"Message text parameters of the exception." }, "programmersDetails": {"type": "object", "optional": true, "description":"Additional exception details, for example, a stack trace." } } }
Code | Description |
---|---|
200 OK | Success completion. |
400 Bad Request | The parameters are not valid or they are missing. |
401 Unauthorized | The caller is not authorized for this request. |
404 Not Found | The participant group does not exist.
|
406 Not Acceptable | The requested content type or content encoding is not supported. |
500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
7.5.1
Parent Topic: Participant Group Resource