REST interface for BPD-related resources - ManagedGlobalTeam Resource - GET Method

Retrieve information about global teams the user manages that have been defined to the IBM Business Automation Workflow installation.

Sample method invocation

GET /rest/bpm/wle/v1/managedGlobalTeams[?filter={string}][&size={integer}][&globalTeamIds={string}]

Parameters

Optional parameters

Name	Value Type	Description
filter	string	Filters the managed global teams and includes only team names that match the specified filter condition. The filter is case insensitive. By default, the method returns all the mananged global teams to which the user has access. Example: "hiring*" returns all the teams whose name begins with "hiring".
size	integer	Specifies the maximum number of entities to be returned. If this number is not specified, the default size 100 defined for the query is used instead. The limit is 999.
globalTeamIds	string	The optional parameter globalTeamIds takes a list of teams. The call returns a (possibly empty) list of the subset of those teams that the user is a manager of.

Request content

None

Response content

ManagedGlobalTeamList - a list of zero or more teams that have been defined to the IBM Business Automation Workflow installation (ManagedGlobalTeamList complexType).

The default content type is application/json.

MIME type: application/json

Schema

{"description":"ManagedGlobalTeams",
   "type": "object",
   "properties":
   { "teams":
     [
        {
             "teamId": {"type":"string",
                 "description":"The ID of the team that is described by this object."
              },
              "teamName": {"type":"string",
                 "description":"The name of the team that is described by this object."
              },
              "teamDescription": {"type":"string",
                 "description":"The description of the team that is described by this object."
              },
             "processAppName":{"type":"string",
                 "description":"The process application name that owns this object."
              },
             "processAppId":{"type":"string",
                 "description":"The process application id that owns this object."
              }
         }
      ]
   }
}

Example content

{
   "status":"200",
   "data":{
      "teams":[
         {
            "teamId":"24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
            "teamName":"Human Resources",
            "teamDescription": "People in the human resources department.",            
            "processAppName":"Hiring Sample",
            "processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
         },
         {
            "teamId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
            "teamName":"GeneralManagers",
            "teamDescription": "People who have authority to approve new positions.",
            "processAppName":"Hiring Sample",
            "processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
         },
         {
            "teamId":"24.cd97937f-06ab-43cc-8067-17dea489fdb3",
            "teamName":"HiringManagers",
            "teamDescription": "People who have a department that needs a new position or have an existing position that needs to be filled.",
            "processAppName":"Hiring Sample",
            "processAppId":"2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
         }
      ]
   }
}

MIME type: application/xml

Schema

<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/managedglobalteam"
        elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:tns="http://rest.bpm.ibm.com/v1/data/managedglobalteam"
        xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
        xmlns:common="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"/>


    <!-- 
     This type represents an team definition that represents a Managed Global Team.
    -->
    <complexType name="ManagedGlobalTeam">
        <complexContent>
            <extension base="pref:Data"> 
                <sequence>
                    <!-- 
                    The ID of the team.
                    This field is mandatory. 
                    -->
                    <element name="teamId" type="string" />
                    <!-- 
                    The display name of the team. 
                    This field is mandatory. 
                    -->
                    <element name="teamName" type="string" />
                    <!-- 
                    The description of the team. 
                    This field is mandatory. 
                    -->
                    <element name="teamDescription" type="string" />
                    <!-- 
                    The display name of the process application. 
                    This field is mandatory. 
                    -->
                    <element name="processAppName" type="string" />
                    <!-- 
                    The id of the process application. 
                    This field is mandatory. 
                    -->
                    <element name="processAppId" type="string" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>

    <!-- 
        A list of team definitions. 
    -->
    <complexType name="ManagedGlobalTeamList">
        <complexContent>
            <extension base="pref:Data">
                <sequence>
                    <element name="teams" type="tns:ManagedGlobalTeam" minOccurs="0" maxOccurs="unbounded"/>
                </sequence>
            </extension>
        </complexContent>
    </complexType>

   	<element name="ManagedGlobalTeam" type="tns:ManagedGlobalTeam" />
   	<element name="ManagedGlobalTeamList" type="tns:ManagedGlobalTeamList" />

</schema>

Example content

<?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/team' xsi:type='ug:TeamDefinitions'>
    <teams>
      <teamId>24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e</teamId>
      <teamName>Human Resources</teamName>
      <teamDescription>People in the human resources department.</teamDescription>
      <processAppName>Hiring Sample</processAppName>
      <processAppId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</processAppId>
    </teams>
    <teams>
      <teamId>24.eb30156e-52c8-4ec5-9be6-02290d02f827</teamId>
      <teamName>GeneralManagers</teamName>
      <teamDescription>People who have authority to approve new positions.</teamDescription>
      <processAppName>Hiring Sample</processAppName>
      <processAppId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</processAppId>
    </teams>
    <teams>
      <teamId>24.cd97937f-06ab-43cc-8067-17dea489fdb3</teamId>
      <teamName>HiringManagers</teamName>
      <teamDescription>People who have a department that needs a new position or have an existing position that needs to be filled.</teamDescription>
      <processAppName>Hiring Sample</processAppName>
      <processAppId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</processAppId>
    </teams>
  </data>
</bpm:ResponseData>

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json

Schema

{  "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."
      }
   }
}

MIME type: application/xml

Schema

<?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" />
    
    <!--
	This type represents an error response.
    -->    
    <element name="RestRuntimeException">
	<complexType>
	    <sequence>
		<element name="status" type="string"/>
		<element name="Data" type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 This type contains detailed error information associated with an exception.
    -->
    <complexType name="ExceptionData">
	<sequence>
	    <element name="status" type="string"/>

	    <!-- This specifies the java class name of the exception -->
	    <element name="exceptionType" type="string"/>

	    <!-- The message ID of the error message -->
	    <element name="errorNumber" type="string" minOccurs="0"/>

	    <!-- The complete error message -->
	    <element name="errorMessage" type="string"/>

	    <!-- The list of strings inserted into the error message -->
	    <element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/>

	    <!-- 
		 The stacktrace associated with the exception.
		 Note that this will be omitted unless the "server-stacktrace-enabled" property
		 is enabled in the server's 100Custom.xml file.
	    -->     
	    <element name="programmersDetails" type="string"></element>
	    
	    <!-- Prior responses.  Set if a bulk command was used -->
	    <element name="responses" type="dat:BulkCommandResponses" 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>

Status codes

The method returns one of the following status codes:

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.
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.

Available since

20.0.0.2

Parent Topic: ManagedGlobalTeam Resource