SOAP API - createWorkListView

Request

Uses the createWorkListViewelement (from the WorkListService schema)

Parameter notes

Owner (Optional): The resourceID of the owner of this work view. You can get the resourceID from a lookupUser operation. If omitted, the ID of the resource calling the createWorkListView API is used.
Public (Optional): whether the work view can be viewed by all TIBCO ActiveMatrix BPM users. If true then it is public. If omitted, the value is false.
getAllocatedItems (Optional): Boolean value specifying the type of work items to be included by default in this work list view - allocated (true) or offered (false). Note that:
- You can override this setting on a specific getWorkListItemsForView request by using the getAllocatedItems parameter in that request.
- You cannot use this parameter if you specify resourcesRequired = ALL, or an entityID of type RESOURCE.
entityID or resourcesRequired (both Optional): Use these parameters to define whose work list will be included in this work list view. Use one of the following:
- entityID = GUID, to retrieve the work list for the specified organizational entity.
- resourcesRequired = ALL, to retrieve the work list for every user (that is, every existing organizational entity of type RESOURCE).
- resourcesRequired = MINE, to retrieve the work list of the user executing the particular call. (This is the default behavior if you omit both the entityID and resourcesRequired parameters.)
  Note: The calling user must have the necessary privileges to be able to access the specified work list.
orderFilterCriteria (Optional): Specification of sort/filter criteria to be applied to the work item list. See Sort Filter Expression Syntax for more information.
authors (Optional): Array of XmlModelEntityId objects for entities (GROUPS, POSITIONS, ORGUNITS and RESOURCES) who are allowed to edit the view.
users (Optional): Array of XmlModelEntityId objects for resources who are allowed to use the view.

customData (Optional): A string attribute used to provide any custom data to be to stored with the work list view. Can be used to store any data that you want to associate with your work list view. For example, if you are using a custom client, you may want to specify which work item columns to display when using this work list view. If storing XML data, the value should be wrapped in a CDATA section.
Note: If you are using the API with TIBCO Openspace you must not use the customData parameter. This is because TIBCO Openspace uses customData to store any of its data that is associated with the work list view. For example, the work item columns to display.

Response

Returns a createWorkListViewResponseelement (from the WorkListService schema)

Example

Request:

soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.brm.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:createWorkListView name="test" >
      </api:createWorkListView>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <createWorkListViewResponse workListViewID="13" xmlns="http://api.brm.n2.tibco.com"/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request	Uses the createWorkListViewelement (from the WorkListService schema)
Parameter notes	Owner (Optional): The resourceID of the owner of this work view. You can get the resourceID from a lookupUser operation. If omitted, the ID of the resource calling the createWorkListView API is used. Public (Optional): whether the work view can be viewed by all TIBCO ActiveMatrix BPM users. If true then it is public. If omitted, the value is false. getAllocatedItems (Optional): Boolean value specifying the type of work items to be included by default in this work list view - allocated (true) or offered (false). Note that: You can override this setting on a specific getWorkListItemsForView request by using the getAllocatedItems parameter in that request. You cannot use this parameter if you specify resourcesRequired = ALL, or an entityID of type RESOURCE. entityID or resourcesRequired (both Optional): Use these parameters to define whose work list will be included in this work list view. Use one of the following: entityID = GUID, to retrieve the work list for the specified organizational entity. resourcesRequired = ALL, to retrieve the work list for every user (that is, every existing organizational entity of type RESOURCE). resourcesRequired = MINE, to retrieve the work list of the user executing the particular call. (This is the default behavior if you omit both the entityID and resourcesRequired parameters.) Note: The calling user must have the necessary privileges to be able to access the specified work list. orderFilterCriteria (Optional): Specification of sort/filter criteria to be applied to the work item list. See Sort Filter Expression Syntax for more information. authors (Optional): Array of XmlModelEntityId objects for entities (GROUPS, POSITIONS, ORGUNITS and RESOURCES) who are allowed to edit the view. users (Optional): Array of XmlModelEntityId objects for resources who are allowed to use the view.
	customData (Optional): A string attribute used to provide any custom data to be to stored with the work list view. Can be used to store any data that you want to associate with your work list view. For example, if you are using a custom client, you may want to specify which work item columns to display when using this work list view. If storing XML data, the value should be wrapped in a CDATA section. Note: If you are using the API with TIBCO Openspace you must not use the customData parameter. This is because TIBCO Openspace uses customData to store any of its data that is associated with the work list view. For example, the work item columns to display.
Response	Returns a createWorkListViewResponseelement (from the WorkListService schema)
Example	Request: soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.brm.n2.tibco.com"> <soapenv:Header/> <soapenv:Body> <api:createWorkListView name="test" > </api:createWorkListView> </soapenv:Body> </soapenv:Envelope>
Example	Response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <createWorkListViewResponse workListViewID="13" xmlns="http://api.brm.n2.tibco.com"/> </SOAP-ENV:Body> </SOAP-ENV:Envelope>