Interfaz REST para recursos relacionados con BPD – Recurso de equipo (por nombre de equipo) – Método GET

Utilice este método para recuperar los detalles modelados de un equipo, que se identifica por su nombre.

Ejemplo de invocación de método

GET /rest/bpm/wle/v1/team?name={string}[&snapshotId={string}][&branchId={string}]

Parámetros

Nota: Para identificar la instantánea correcta que se va a utilizar, debe especificar uno de los parámetros snapshotId o branchId .
Se aplican las siguientes reglas de prioridad:
1) Si se especifica el parámetro snapshotId , se utiliza esa instantánea específica y se ignora el parámetro branchId .
2) Si se especifica el parámetro branchId , se utiliza la instantánea de sugerencia (actual) de la rama (pista) especificada.

Parámetros necesarios

Nombre	Tipo de valor	Descripción
Nombre	serie	El nombre del equipo.

Parámetros opcionales

Nombre	Tipo de valor	Descripción
snapshotId	serie	Identificador de la instantánea asociada con el equipo. Debe establecer uno de los parámetros `snapshotId` o `branchId` .
branchId	serie	Identificador de la rama asociada con el equipo. Debe establecer uno de los parámetros `snapshotId` o `branchId` .

Contenido de la solicitud

Ninguna

Contenido de respuesta

Los detalles modelados del equipo (RestTeam complexType).

El tipo de contenido predeterminado esapplication/json.

Tipo MIME: application/json

Esquema

{
    "status":"200",
    "datos": {
        "name":{"type": "string", "description": "The name of the team."},
        "id":{"type": "string", "description": "The id of the team."},
        "type": {"type": "string", "description": "El tipo del equipo.", 
            "enum":
        	[
        		"Expresión",
        		"StandardMembers",
				"Sistema",
			    "TeamByService"
        	]
        },
        "desc":{"type": "string", "description": "The description of the team."},
        "groupId":{"type": "long", "description": "The id of the resolved user group."},
        "managersTeamNombre":{"type": "string", "description": "The name of the associated managers team."},
        "managersTeamId":{"type": "string", "description": "The id of the associated managers team."},		
        "members": {"type": "[objeto]", "description": "Sólo se aplica cuando el tipo es StandardMembers.",         
          {
	     [
		{
              	  "name":{"type": "string", "description": "The name of the member."},
                  "type":{"type": "string", "description": "El tipo de miembro: 'User' o 'Group'."}
                }
             ]
           }         
         },
        "orgExpression": {"type": "{object}", "description": "Sólo se aplica cuando el tipo es Expression.",         
          {
            "OperadorruleSet": {"type": "string", "description": "Indica si los usuarios coinciden con todas o con alguna de las reglas.", 
        	"enum":
        	    [
        		"todos",
        		"cualquiera"
        	    ]
        	},
            "reglas": [
	                {
	                    "matchType": {"type": "string", "description": "Indica si los usuarios pertenecen a un equipo.", 
        			"enum":
		 		   [
				   	"belong",
				   	"notBelong"
				   ]
         		     },
	                    "participantName": {"type": "string", "description": "The name of the team specified in this participant rule."},
	                    "snapshotId":{"type": "string", "description": "El ID de la instantánea asociada con el equipo.
	                    			Se debe especificar 'snapshotId' o 'branchId'. "},
	                    "branchId":{"type": "string", "description": "El ID de la rama asociada con el equipo.
	                    			Se debe especificar 'snapshotId' o 'branchId'. "},
	                    "ruleType":"Participant",
	                    "ParticipantId":{"type": "string", "description": "The ID of the team specified in this participant rule."}
	                },
	                {
                    	    "comparator": {"type": "string", "description": "Compara el atributo que los usuarios tienen con el valor de la regla.", 
        			 "enum":
				    [
					"Equal",
					"LessThan",
					"GreaterThan",
					"NotEqual",
					"GreaterThanEqual",
					"LessThanEqual"
				    ]
	    		     },                  			
			    "userAttributeName":{"type": "string", "description": "El nombre del atributo de usuario."}
                            "userAttributeValue":{"type": "string", "description": "El valor del atributo de usuario."}
                            "userAttributeId":{"type": "string", "description": "El ID de objeto persistente del atributo de usuario."}
	                    "snapshotId":{"type": "string", "description": "El ID de la instantánea asociada con el atributo de usuario.
	                    			Se debe especificar 'snapshotId' o 'branchId'. "},
	                    "branchId":{"type": "string", "description": "El ID de la rama asociada con el atributo de usuario.
	                    			Se debe especificar 'snapshotId' o 'branchId'. "},
                            "ruleType":"UserAttribute"
	                },
	                {
                            "matchType": {"type": "string", "description": "Indica si los usuarios coinciden con la expresión.", 
        			"enum":
			  	   [
				   	"coincidencia",
				   	"notMatch"
				   ]
			     },
                    	     "value":{"type": "string", "description": "El valor de la expresión."}
                             "ruleType":"Expression"
	                }
                   ]
                }
            }
       },
       "teamByService": {"type": "[object]", "description": "Sólo se aplica cuando el tipo es 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."}
                }
            ]
          }         
       }
}

Contenido de ejemplo

{
	"status":"200",
	"datos": {
		"name": "teamUsers",
		"id": "24.20068bec-75e7-4b84-b10d-c80230d7af68",
		"type": "TeamByService",
		"desc": "una descripción",
		"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"
		}
	}
}

Tipo MIME: application/xml

Esquema

<?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="Expresión " />
			< enumeration value="Sistema " />
			< enumeration value= "ServicioTeamBy" />			
		</restriction>
	</simpleType>	

	
	<simpleType name= "RuleType">
		<restriction base="string">
			< enumeration value="Participante " />
			< enumeration value= "UserAttribute" />
			< enumeration value="Expresión " />
		</restriction>
	</simpleType>	
	
	<simpleType name= "RuleSetOperador">
		<restriction base="string">
			< enumeration value = "all " />
			< enumeration value = "any " />
		</restriction>
	</simpleType>

	<simpleType name= "CustomerRuleMatchType">
		<restriction base="string">
			< enumeration value = "coincidencia " />
			< enumeration value= "notMatch" />
		</restriction>
	</simpleType>
	
	<simpleType name= "ParticipantRuleMatchType">
		<restriction base="string">
			< enumeration value = "pertenecer" />
			< enumeration value= "notBelong" />
		</restriction>
	</simpleType>	

	<simpleType name="Comparador">
		<restriction base="string">
			< enumeration value="Igual " />
			< enumeration value= "LessThan" />
			< enumeration value= "GreaterThan" />
			< enumeration value= "NotEqual" />
			< enumeration value= "GreaterThanIgual" />
			< enumeration value= "LessThanIgual" />
		</restriction>
	</simpleType>

	<complexType name="Miembro">
		<sequence>
			< element name = "name "type = "string" />
			< element name = "type "type = "string" />
			< element name = "desc "type = "string" />
		</sequence>
	</complexType>

	<complexType name= "OrgExprRegla" abstract="true " >
		<sequence>
			< element name= "ruleType" type="tns:RuleType" />
		</sequence>
	</complexType>

	<complexType name= "OrgExprParticipantRule">
		<complexContent>
			Regla < extension base="tns:OrgExpr">
				<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= " ReglaOrgExprUserAttr">
		<complexContent>
			Regla < extension base="tns:OrgExpr">
				<sequence>
					< element name="comparator "type="tns: Comparator" />
					< element name= "userAttributeName" type="string " />
					< element name= "userAttributeValue" type="serie " />
					< 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>
			Regla < extension base="tns:OrgExpr">
				<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: OperadorRuleSet" />
			< 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 = "serie " />
					<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 = "serie " />
		</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 = "serie " />
					< element name= "groupId" type = "long " />
					< element name= "managersTeamName" type="serie " />
					<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>

Contenido de respuesta de error

Información de error detallada.

El tipo de contenido predeterminado esapplication/json.

Tipo MIME: application/json

Esquema

{"description": "Respuesta de error WLE", 
   "type": "object",
   "propiedades":
   {"status": {"type": "serie",
         "description": "El estado de la llamada de API anterior."
      },
      "exceptionType": {"type": "string",
         "description": "El nombre de clase asociado con la excepción."
      },
      "errorNumber": {"type": "string",
         "description": "ID de mensaje de la excepción."
      },
      "errorMessage": {"type": "string",
         "description": Texto de mensaje de la excepción."
      },
      Parámetros de "errorMessage": {"type": ["string"], "opcional": true,
         "description": "Parámetros de texto de mensaje de la excepción."
      },
      "programmersDetails": {"type": "object", "opcional": true,
         "description": "Detalles de excepción adicionales, por ejemplo, un rastreo de pila."
      }
   }
}

Códigos de estado

El método devuelve uno de los siguientes códigos de estado:

Código	Descripción
200 OK (Correcto)	Finalización con éxito.
400 Solicitud incorrecta	Parámetros no válidos o no especificados.
401 No autorizado	El llamante no está autorizado para esta solicitud.
404 No encontrado	El equipo no existe.
406 No aceptable	No se da soporte al tipo de contenido solicitado o a la codificación del contenido.
500 Error interno del servidor	Se ha producido un problema grave, se proporcionan los detalles del programador.

Disponible a partir de

7.5.1

Tema padre: Recurso de equipo (por nombre de equipo)