GET /rest/bpm/wle/v1/team?name={string}[&snapshotId={string}][&branchId={string}]
snapshotId
or branchId
parameters.snapshotId
parameter is specified, that specific snapshot is used, and the branchId parameter is ignored.branchId
parameter is specified, the tip (current) snapshot of the specified branch (track) is used.Name | Value Type | Description |
---|---|---|
name | string | The name of the team.
|
Name | Value Type | Description |
---|---|---|
snapshotId | string | The identifier of the snapshot associated with the team. You must set one of the
snapshotId or branchId parameters. |
branchId | string | The identifier of the branch associated with the team. You must set one of the
snapshotId or branchId parameters. |
None
The default content type is application/json.
{ "status":"200", "data":{ "name":{"type": "string", "description": "The name of the team."}, "id":{"type": "string", "description": "The id of the team."}, "type":{"type": "string", "description": "The type of the team.", "enum": [ "Expression", "StandardMembers", "System", "TeamByService" ] }, "desc":{"type": "string", "description": "The description of the team."}, "groupId":{"type": "long", "description": "The id of the resolved user group."}, "managersTeamName":{"type": "string", "description": "The name of the associated managers team."}, "managersTeamId":{"type": "string", "description": "The id of the associated managers team."}, "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 team.", "enum": [ "belong", "notBelong" ] }, "participantName": {"type": "string", "description": "The name of the team specified in this participant rule."}, "snapshotId":{"type": "string", "description": "The ID of the snapshot associated with the team. Either 'snapshotId' or 'branchId' must be specified."}, "branchId":{"type": "string", "description": "The ID of the branch associated with the team. Either 'snapshotId' or 'branchId' must be specified."}, "ruleType":"Participant", "ParticipantId":{"type": "string", "description": "The ID of the team 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" } ] } } }, "teamByService":{"type": "[object]", "description": "It only applies when the type is TeamByService.", { [ { "serviceName":{"type": "string", "description": "The name of the service used to define the team."}, "serviceId":{"type": "string", "description": "The ID of the service."}, "serviceDescription":{"type": "string", "description": "The description of the service."} } ] } } }
{ "status": "200", "data": { "name": "teamUsers", "id": "24.20068bec-75e7-4b84-b10d-c80230d7af68", "type": "TeamByService", "desc": "a description", "richDesc": "", "groupId": 1055, "managersTeamName": "teamManagers", "managersTeamId": "24.a41430c9-50d4-4ac5-9eb6-ef181a1a01b2", "members": null, "orgExpression": null, "teamByService": { "serviceName": "usersSvc", "serviceId": "1.18254992-be73-449e-80a7-12941c799a25" } } }
<?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 team 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: Team (by Team Name) Resource