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

Retrieve information about users of a global team if current user is manager of the team defined in the IBM Business Automation Workflow installation.

Sample method invocation

GET /rest/bpm/wle/v1/globalTeamUsers/{globalTeamId}[?size={integer}][&from={string}]

Parameters

Optional parameters

Name	Value Type	Description
size	integer	The optional parameter 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.
from	string	The optional parameter specifies a username as offset with which user the list of users starts. If the user does not exist in the system then the list starts alphabetically beyond the specified parameter.

Request content

None

Response content

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

The default content type is application/json.

MIME type: application/json

Schema

{"description":"GlobalTeamUsers",
   "type": "object",
   "properties":
   { "users":
     [
        {
             "userId": {"type":"string",
                 "description":"The ID of the user that is described by this object."
              },
              "userName": {"type":"string",
                 "description":"The name of the user that is described by this object."
              },
             "fullName":{"type":"string",
                 "description":"The fullname of the user that is described by this object."
              },
              "email":{"type":"string",
                 "description":"The email of the user that is described by this object."
              },
              "phoneNumber":{"type":"string",
                 "description":"The phoneNumber of the user that is described by this object."
              },
              "jobTitle":{"type":"string",
                 "description":"The job title of the user that is described by this object."
              }
         }
      ]
   }
}

Example content

{
   "status":"200",
   "data":{
      "users":[
        {
          "userId":1,
          "userName":"user1",
          "fullName":"user1 name",
          "phoneNumer":"098 555555",
          "jobTitle":"Manager",
          "emailAddress":"user1@web.de"
        },
        {
           "userId":1003,
           "userName":"user2",
           "fullName":"test user2",
           "phoneNumer":"078 5555",
           "jobTitle":"Developer",
           "emailAddress":"user2@web.com"
        }
      ]
   }
}

MIME type: application/xml

Schema

<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/globalteamuser"
        elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:tns="http://rest.bpm.ibm.com/v1/data/globalteamuser"
        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 BPM Team.
    -->
    <complexType name="GlobalTeamUser">
    <complexContent>
        <extension base="pref:Data">
        <sequence>

            <!-- The numeric ID of the user -->
            <element name="userId" type="long" />

            <!-- The alphanumeric user name associated with the user -->
            <element name="userName" type="string" />

            <!-- The user's full name -->
            <element name="fullName" type="string" minOccurs="0" />

            <!-- The user's phone number. -->
            <element name="phoneNumer" type="string" minOccurs="0" />

            <!-- The user's job title. -->
            <element name="jobTitle" type="string" minOccurs="0" />

            <!-- The user's email address. -->
            <element name="emailAddress" type="string" minOccurs="0" />
        </sequence>
        </extension>
    </complexContent>
    </complexType>

    <!-- 
        A list of global team users. 
    -->
    <complexType name="GlobalTeamUserList">
        <complexContent>
            <extension base="pref:Data">
                <sequence>
                    <element name="users" type="tns:GlobalTeamUser" minOccurs="0" maxOccurs="unbounded"/>
                </sequence>
            </extension>
        </complexContent>
    </complexType> 
   	<element name="GlobalTeamUser" type="tns:GlobalTeamUser" />
   	<element name="GlobalTeamUserList" type="tns:GlobalTeamUserList" />

</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'>
    <users>
      <userId>1034</userId>
      <userName>user1</userName>
      <fullName>user name</fullName>
      <phoneNumer>56983 9493</phoneNumer>
      <jobTitle>Manager</jobTitle>
      <email>user1@web.de</email>
    </users>
    <users>
      <userId>630</userId>
      <userName>user2</userName>
      <fullName>user2 name</fullName>
      <phoneNumer>064 4423</phoneNumer>
      <jobTitle>Developer</jobTitle>
      <email>user2@web.com</email>
    </users>
  </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: GlobalTeamUser Resource