IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/users[?filter={string}][&maxresult={integer}][&assignTaskidFilter={string}][&collabTaskidFilter={string}][&includeTaskExperts={boolean}][&sort={boolean}][&includeInternalMemberships={boolean}][&namesonly={boolean}][&parts={string}][&refreshUser={boolean}]
Name | Value Type | Description |
---|---|---|
filter | string | A simple regular expression to be used to filter the list of users returned. Example: "tw_*" will return all users whose names begin with "tw_".
|
maxresult | integer | The maximum number of users to return. If filter is defined and no maxresult is specified, the list will default to a maximum of 20, based on the 00Static.xml 'user-list-limit-from-external-security-provider' setting.
|
assignTaskidFilter | string | A task id. If defined, only users the task can be reassigned to will be included in the list of users returned.
|
collabTaskidFilter | string | A task id. If defined, only users able to collaborate on the task will be included in the list of users returned.
|
includeTaskExperts | boolean | If false, calls using collabTaskId will not include experts of the task in the list of users returned. Defaults to true.
|
sort | boolean | Whether to sort the list of users by full name. Defaults to true.
|
includeInternalMemberships | boolean | If true, includes in the returned list of memberships the internal group membership names that the user belongs to. Defaults to true.
|
namesonly | boolean | Whether data other than user name and full name should be returned. Defaults to false.
|
parts | string | A string indicating which parts of the response data should be returned. Valid values are "memberships", "all" (the default), or "none".
|
refreshUser | boolean | Refreshes fullname and group memberships of users before retriving them. Only members of the group, that are referred by the action policy "ACTION_REFRESH_USER", can use this function.
|
None
The default content type is application/json.
{ "description": "UserList", "type": "object", "properties": { "users": [ { "userID": {"type": "integer", "description": "The user ID of the user that is described by this object." }, "userName": {"type": "string", "description": "The user name of the user that is described by this object.", }, "fullName": {"type": "string", "description": "The full name of the user that is described by this object.", }, "isDisabled": {"type": "boolean", "description": "States whether this user is disabled. This field is set to false and cannot be changed." }, "primaryGroup": {"type": "string", "description": "The primary group associated with this user." }, "emailAddress": {"type": "string", "description": "The email address associated with this user." }, "userPreferences": [ { "key" : { "type": "string", "description": "The key associated with the user preference." }, "value" : { "type": "string", "description": "They value associated with the user preference." } } ], "memberships": {"type": "[string]", "description": "List of groups in which the user is a member." } } ] } }
{ "status":"200", "data":{ "users":[ { "userID":8, "userName":"bpmAuthor", "fullName":"Internal Author user", "isDisabled":false, "primaryGroup":null, "emailAddress":null, "userPreferences":{ }, "memberships":[ "tw_authors", "tw_allusers", "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", "All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f", "Process Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf", "Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf", ] }, { "userID":1, "userName":"tw_admin", "fullName":"Internal TW Admin user", "isDisabled":false, "primaryGroup":null, "emailAddress":null, "userPreferences":{ "Locale":"en" }, "memberships":[ "Debug", "tw_admins", "tw_authors", "tw_portal_admins", "tw_process_owners", "tw_allusers", "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", "All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", ] }, { "userID":2, "userName":"tw_author", "fullName":"Internal TW Author user", "isDisabled":false, "primaryGroup":null, "emailAddress":null, "userPreferences":{ }, "memberships":[ "tw_authors", "tw_allusers", "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", "All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f", "Process Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf", "Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf", ] }, { "userID":6, "userName":"tw_portal_admin", "fullName":"Internal TW Portal Admin user", "isDisabled":false, "primaryGroup":null, "emailAddress":null, "userPreferences":{ }, "memberships":[ "tw_portal_admins", "tw_allusers", ] }, { "userID":7, "userName":"tw_runtime_server", "fullName":"Internal Runtime user", "isDisabled":false, "primaryGroup":null, "emailAddress":null, "userPreferences":{ }, "memberships":[ ] }, { "userID":3, "userName":"tw_user", "fullName":"Internal TW User", "isDisabled":false, "primaryGroup":null, "emailAddress":null, "userPreferences":{ "Locale":"en" }, "memberships":[ "tw_allusers", "TWSecurityProviderUsers" ] }, { "userID":4, "userName":"tw_webservice", "fullName":"Anonymous WebService User", "isDisabled":false, "primaryGroup":null, "emailAddress":null, "userPreferences":{ }, "memberships":[ "tw_allusers", "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", "All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426", "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f", ] } ] } }
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/usergroup" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/usergroup" xmlns:data="http://rest.bpm.ibm.com/v1/data/root" xmlns:cmn="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 a user that has been defined to the IBM BPM installation. --> <complexType name="User"> <complexContent> <extension base="data: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" /> <!-- This field indicates whether or not this user is disabled. This field is set to false and cannot be changed. --> <element name="isDisabled" type="boolean" /> <!-- The timestamp when the user last logged in, This field cannot be changed. --> <element name="lastLoginDate" type="dateTime" /> <!-- not used --> <element name="primaryGroup" type="string" minOccurs="0" /> <!-- not used --> <element name="emailAddress" type="string" minOccurs="0" /> <!-- A list of user preferences (extended attributes) associated with this user --> <element name="userPreferences" type="cmn:Map" minOccurs="0" /> <!-- A list of Tasks (taskIds) that the user is collaborating on --> <element name="tasksCollaboration" type="string" minOccurs="0" maxOccurs="unbounded" /> <!-- A list of groups to which this user belongs --> <element name="memberships" type="string" maxOccurs="unbounded" minOccurs="0" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a user with a workload defined to the IBM BPM installation. --> <complexType name="TeamMember"> <complexContent> <extension base="tns:User"> <sequence> <!-- The numeric ID of the user --> <element name="workload" type="integer" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a user with a workload defined to the IBM BPM installation. --> <complexType name="Expert"> <complexContent> <extension base="tns:TeamMember"> <sequence> <!-- TODO what is this --> <element name="completed" type="integer" /> <!-- TODO what is this --> <element name="avgHours" type="double" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents an array of Experts --> <complexType name="Experts"> <complexContent> <extension base="data:Data"> <sequence> <!-- MAY CONTAIN --> <element name="Experts" type="tns:Expert" minOccurs="0" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a list of expert users with a workload defined to the IBM BPM installation. --> <complexType name="ExpertList"> <complexContent> <extension base="data:Data"> <sequence> <!--group of users the system identifies as experts on a task --> <element name="systemIdentifiedUsers" type="tns:Expert" maxOccurs="unbounded" minOccurs="0" /> <!--group of users included in the the task expert participant group --> <element name="expertParticipantGroupUsers" type="tns:Expert" maxOccurs="unbounded" minOccurs="0" /> <!--task expert participant group --> <element name="expertParticipantGroupDetails" type="tns:Group" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a user that has been defined to the IBM BPM installation. --> <complexType name="UserPreferences"> <complexContent> <extension base="data:Data"> <sequence> <!-- The user's display name --> <element name="displayName" type="string" /> <!-- The user's "Primary Role Description --> <element name="primaryRoleDescription" type="string" /> <!-- The user's Task Email Address --> <element name="taskEmailAddress" type="string" /> <!-- The user's Phone Number --> <element name="phoneNumber" type="string" /> <!-- The user's Street Address --> <element name="streetAddress" type="string" /> <!-- The user's City --> <element name="city" type="string" /> <!-- The user's State --> <element name="state" type="string" /> <!-- The user's Country --> <element name="country" type="string" /> <!-- The user's Postal Code--> <element name="postalCode" type="string" /> <!-- The user's Image --> <element name="image" type="string" /> <!-- The user's Toolbar Collapsed setting --> <element name="toolbarCollapsed" type="boolean" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a group that has been defined to the IBM BPM installation. --> <complexType name="Group"> <complexContent> <extension base="data:Data"> <sequence> <!-- The numeric ID of the group --> <element name="groupID" type="long" /> <!-- The alphanumeric name of the group --> <element name="groupName" type="string" /> <!-- The display name associated with the group --> <element name="displayName" type="string" /> <!-- The description associated with the group --> <element name="description" type="string" /> <!-- The list of users that are members of this group --> <element name="members" type="string" maxOccurs="unbounded" minOccurs="0" /> <!-- The alphanumeric name of the manager group --> <element name="managerGroupName" type="string" minOccurs="0" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a list of zero or more users that have been defined to the IBM BPM installation. --> <complexType name="UserList"> <complexContent> <extension base="data:Data"> <sequence> <element name="users" type="tns:User" maxOccurs="unbounded" minOccurs="0" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a list of zero or more user groups that have been defined to the IBM BPM installation. --> <complexType name="GroupList"> <complexContent> <extension base="data:Data"> <sequence> <element name="groups" type="tns:Group" maxOccurs="unbounded" minOccurs="0" /> </sequence> </extension> </complexContent> </complexType> <element name="User" type="tns:User" /> <element name="TeamMember" type="tns:TeamMember" /> <element name="Expert" type="tns:Expert" /> <element name="Experts" type="tns:Experts" /> <element name="UserPreferences" type="tns:UserPreferences" /> <element name="Group" type="tns:Group" /> <element name="UserList" type="tns:UserList" /> <element name="GroupList" type="tns:GroupList" /> </schema>
<?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/usergroup' xsi:type='ug:UserList'> <users> <userID>8</userID> <userName>bpmAuthor</userName> <fullName>Internal Author user</fullName> <isDisabled>false</isDisabled> <userPreferences /> <memberships>tw_authors</memberships> <memberships>tw_allusers</memberships> </users> <users> <userID>1</userID> <userName>tw_admin</userName> <fullName>Internal TW Admin user</fullName> <isDisabled>false</isDisabled> <userPreferences> <item key='Locale'> <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>en</value> </item> </userPreferences> <memberships>Debug</memberships> <memberships>tw_admins</memberships> <memberships>tw_authors</memberships> <memberships>tw_portal_admins</memberships> <memberships>tw_process_owners</memberships> <memberships>tw_allusers</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> <memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f</memberships> </users> <users> <userID>2</userID> <userName>tw_author</userName> <fullName>Internal TW Author user</fullName> <isDisabled>false</isDisabled> <userPreferences /> <memberships>tw_authors</memberships> <memberships>tw_allusers</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> <memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> </users> <users> <userID>6</userID> <userName>tw_portal_admin</userName> <fullName>Internal TW Portal Admin user</fullName> <isDisabled>false</isDisabled> <userPreferences /> <memberships>tw_portal_admins</memberships> <memberships>tw_allusers</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> <memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f</memberships> <memberships>Process Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships> <memberships>Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships> </users> <users> <userID>7</userID> <userName>tw_runtime_server</userName> <fullName>Internal Runtime user</fullName> <isDisabled>false</isDisabled> <userPreferences /> </users> <users> <userID>3</userID> <userName>tw_user</userName> <fullName>Internal TW User</fullName> <isDisabled>false</isDisabled> <userPreferences> <item key='Locale'> <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>en</value> </item> </userPreferences> <memberships>tw_allusers</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> <memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f</memberships> <memberships>Process Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships> <memberships>Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships> <memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships> <memberships>TWSecurityProviderUsers</memberships> </users> <users> <userID>4</userID> <userName>tw_webservice</userName> <fullName>Anonymous WebService User</fullName> <isDisabled>false</isDisabled> <userPreferences /> <memberships>tw_allusers</memberships> </users> </data> </bpm:ResponseData>
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." } } }
<?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> </sequence> </complexType> </schema>
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. |
7.5.0
Parent Topic: Users Resource