GET /rest/bpm/wle/v1/searches/tasks/{idOrName}无
无
缺省内容类型为application/json.
{
"title":"Saved Search Definition",
"description": " 已保存的搜索定义 JSON。 这是检索搜索时返回的 JSON ，以及保存或更新搜索时用于有效内容的 JSON。" ，
"type":"object",
"properties": {
"id": {
"type":"string",
"description":"The ID of the saved search definition. 将始终返回此字段。 作为有效内容的一部分提供时: 创建: 创建已保存的搜索定义时，应省略标识。 更新: 此字段是可选的，如果提供了此字段，那么标识必须与正在更新的已保存搜索定义的标识匹配。 特别执行: 如果此字段是可选的，并且如果提供了此字段，那么将忽略此字段。" ，
"required": false
},
"name": {
"type":"string",
"description":"The name of the saved search definition. 将始终返回此字段。 作为有效内容的一部分提供时，根据方法的不同，需求会有所不同。" ，
"required": false
},
"所有者": {
"type":"string",
"description":"The owner of the saved search definition. 将始终返回此字段。 如果未提供，那么它将缺省为当前用户。 已保存搜索的所有者始终有权处理他们拥有的已保存搜索。 注: 在 8570 之前定义的共享保存的搜索将不会保存所有者。 共享的已保存搜索 (包括由其他用户拥有或没有已保存所有者的搜索) 可由已保存的搜索管理员创建，更新和删除。"。
"required": false
},
"组织": {
"type":"string",
"description":"A string that indicates how the search results are organized. 该值设置为 "byTask" 或 "byInstance"。 缺省值 (如果未提供给 "byTask")。" ，
"enum":[
"byTask",
"byInstance"
],
"required": false
},
"shared": {
"type":"boolean",
"description": " 指示是否共享已保存的搜索。 缺省值 (如果未提供为 false) " ，
"required": false
},
"teams": {
"type":"array",
"description": "The team that the Saved Search is shared with. 如果已保存的搜索是共享的，那么空团队数组指示共享的已保存搜索是与所有人全局共享的。 The array can optionally include one team to share the Saved Search with. teamId 必须是用户是其成员或管理者的团队。 保存的搜索管理员可以与任何团队共享。 在未来发行版中可能支持与多个团队共享。" ，
"required":false,
"properties": {
"teamId": {"type": "string",
"description": "The team id."
},
"teamName": {"type": "string",
"description": " 团队名称。 在返回的 JSON 中使用，如果包含为有效内容的一部分，那么会将其忽略。"
},
"processAppName": {"type": "string",
"description": " 定义/建模团队的流程应用程序。 在返回的 JSON 中使用，如果包含为有效内容的一部分，那么会将其忽略。"
}
}
},
"size": {
"type":"integer",
"description": " 要检索的项的预定义大小。 缺省值 (如果未提供给系统配置中设置的值)。" ，
"required": false
},
"交互": {
"type":"string",
"description": " 用于将不同任务类别 (可用于声明的任务，已声明的任务，已完成的任务等) 作为目标的过滤器。 缺省值 (如果未提供给 "all")。" ，
"enum":[
"claimed",
"可用" ，
"claimed_and_available" ，
"Completed",
"全部"
],
"required": false
},
"fields": {
"type":"string",
"description": "执行已保存的搜索时要返回的字段的列表。" ，
"required": false
},
"aliases": {
"type":"array",
"description": "已保存搜索的业务数据字段的别名。" ，
"required":false,
"properties": {
"field": {"type": "string",
"description": "别名所针对的业务数据字段。"
},
"alias": {"type": "string" ，
"description": "字段的别名。"
}
}
},
"sort": {
"type":"array",
"description": "已保存的搜索定义的排序顺序。" ，
"required":false,
"properties": {
"field": {"type": "string",
"description": "The field to sort on."
},
"order": {"type": "string",
"description": "要排序的顺序。" ，
"enum":[
"ASC",
"desc"
]
}
}
},
"conditions": {
"type":"array",
"description": "表示已保存的搜索定义的条件。" ，
"required":false,
"properties": {
"field": {"type": "string",
"description": "The field the condition is based on."
},
"operator": {"type": "string",
"description": "The operation to perform. 存在有效值的集合列表。" ，
"enum":[
"EQUALS",
"NotEquals",
"StartsWith",
"包含" ，
"GreaterThan",
"LessThan",
"FullText搜索"
]
},
"value": {"type": "string",
"description": "The value of the condition."
}
}
}
}
}
{
"status": "200",
"data": {
"id": "1052" ，
"name": "MySaved搜索" ，
"交互": "claimed_and_available" ，
"fields": [
"taskDueDate",
"taskId",
"taskSubject",
"taskStatus",
"taskPriority",
"taskIsAtRisk",
"taskAtRiskTime",
"taskClosedDate",
"taskActivity名称" ，
"taskActivity类型" ，
"assignedTo用户" ，
"assignedToUserFullName" ，
"assignedToRoleDisplay名称" ，
"instanceName",
"instanceId",
"instanceStatus",
"instanceProcess应用程序" ，
"instanceSnapshot",
"instanceCaseProcessType位置" ，
"instanceCaseStageStatus",
"solutionTargetObjectStoreSymbolicName",
"bpdName",
"department",
"gmApproval",
"hiringManager",
"位置" ，
"caseIdentifier",
"caseType标识"
],
"aliases": [
{
"field": "bpdName" ，
"alias": "特定于客户的别名"
}
],
"排序": [
{
"field": "taskDueDate" ，
"order": "ASC"
}
],
"条件": [
{
"field": "taskDueDate" ，
"operator": "LessThan" ，
"value": "2016-03-02T05:00:00.000Z"
}
],
"organization": "byTask" ，
"size": 25 ，
"shared" :true ，
"teams":[
{
"teamId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"teamName":"GeneralManagers",
"processAppName":"Hiring Sample"
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/savedsearchdefinition"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/savedsearchdefinition"
xmlns:common="http://rest.bpm.ibm.com/v1/data/common"
xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root">
<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"/>
<!--
已保存的搜索定义。 这是检索搜索时返回的格式。
以及在保存或更新搜索时用于有效内容的格式。
-->
<complexType name="SavedSearchDefinition">
<complexContent>
<extension base="pref:Data">
<sequence>
<!--
The ID of the saved search definition.
将始终返回此字段。 作为有效内容的一部分提供时:
创建: 创建已保存的搜索定义时，标识应该为空。
更新: 可选，如果提供了标识，那么该标识必须与正在更新的已保存搜索定义的标识匹配。
特别执行: 此字段是可选的，如果提供了此字段，那么将忽略此字段。"
-->
<element name="id" type="string" />
<!--
" 已保存的搜索定义的名称。
将始终返回此字段。 作为有效内容的一部分提供时:
创建: 必需且必须遵循名称验证规则。
更新: 可选 (如果为重命名目的提供) 必须遵循名称验证规则
特别执行: 此字段是可选的，如果提供了此字段，那么将忽略此字段。"
-->
<element name="name" type="string" />
<!--
The owner of the saved search definition.
创建: 如果未设置值，那么当前登录的用户将在保存时设置为所有者。
更新: 应用缺省规则。 (8570 之前没有所有者)
-->
<element name="owner" type="string" nillable="true"/>
<!--
A string that indicates how the search results are organized.
The value is set to either "byTask" or "byInstance". 缺省值 (如果未提供)。
-->
<element name="organization" type="string" />
<!-- Indicates whether the saved search is shared. 缺省值 (如果未提供)。 -->
<element name="shared" type="boolean" />
<!-- Indicates if the saved search is shared with a team or global -->
<element name="teams" type="tns:SavedSearchDefnTeam" minOccurs="0" maxOccurs="unbounded"/>
<!-- The pre-predefined size of items to be retrieved. -->
<element name="size" type="integer" nillable="true" />
<!--
用于将不同任务类别的不同 "已保存的搜索" 作为目标的过滤器
(团队任务，已声明的任务，已关闭的任务等)。
-->
<element name="interaction" type="string" nillable="true"/>
<!-- fields or columns -->
<element name="fields" type="string" minOccurs="0" maxOccurs="unbounded"/>
<!-- business data aliases -->
<element name="aliases" type="tns:SavedSearchDefnAlias" minOccurs="0" maxOccurs="unbounded"/>
<!-- sort order -->
<element name="sort" type="tns:SavedSearchDefnSort" minOccurs="0" maxOccurs="3"/>
<!-- search condition -->
<element name="conditions" type="tns:SavedSearchDefnCondition" minOccurs="0" maxOccurs="2"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents the meta data of a saved search definition that is returned in list of definitions.
-->
<complexType name="SavedSearchDefinitionMetadata">
<complexContent>
<extension base="pref:Data">
<sequence>
<!--
The ID of the saved search definition.
If a value is not set, a new saved search definition is created upon save.
-->
<element name="id" type="string" />
<!--
The name of the saved search definition.
-->
<element name="name" type="string" />
<!--
The owner of the saved search definition.
-->
<element name="owner" type="string" nillable="true"/>
<!--
A string that indicates how the search results are organized.
The value is set to either "byTask" or "byInstance".
-->
<element name="organization" type="string" />
<!-- Indicates whether the saved search is shared -->
<element name="shared" type="boolean" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
A list of saved search definitions.
-->
<complexType name="SavedSearchDefinitions">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="definitions" type="tns:SavedSearchDefinitionMetadata" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- This type represents the sort order of a saved search definition. -->
<complexType name="SavedSearchDefnSort">
<sequence>
<!-- The field to sort on. -->
<element name="field" type="string" />
<!-- This will be set to "DESC" or "ASC". -->
<element name="order" type="string" />
</sequence>
</complexType>
<!-- This type represents the aliases for business data fields of a saved search. -->
<complexType name="SavedSearchDefnAlias">
<sequence>
<!-- The business data field the alias is for. -->
<element name="field" type="string" />
<!-- The alias for the field. -->
<element name="alias" type="string" />
</sequence>
</complexType>
<!-- This type represents the conditions of a saved search definition. -->
<complexType name="SavedSearchDefnCondition">
<sequence>
<!-- The field the condition is based on. -->
<element name="field" type="string" />
<!-- The operation to perform. 存在有效值的集合列表。 -->
<element name="operator" type="string" />
<!-- The value of the condition ". -->
<element name="value" type="string" />
<!-- choice>
<element name="value" type="string" />
<element name="values" type="string" minOccurs="0" maxOccurs="unbounded"/>
</choice-->
</sequence>
</complexType>
<!-- This type represents the teams that are authorized or can execute a shared saved search definition. -->
<complexType name="SavedSearchDefnTeam">
<sequence>
<!-- The team id. -->
<element name="teamId" type="string" />
<!-- The team name. -->
<element name="teamName" type="string" />
<!-- The process app where the team was defined / modeled". -->
<element name="processAppName" type="string" />
</sequence>
</complexType>
<!--
This type represents individual meta data of the type requested that can be used in a saved or adhoc search definition.
It is used to get a list of fields and meta data about those fields. It is filtered by type of meta data requested.
This type is also used for simple enumerations, in which case type and full_text_searchable will be null.
-->
<complexType name="SearchDefinitionMetaData">
<sequence>
<!-- The field name. -->
<element name="name" type="string" />
<!-- The field's type with the type being one of the following: String , Date, Time, Integer, Decimal, Boolean. -->
<element name="type" type="string" />
<!-- The symbolic name of the case property, null for non case property -->
<element name="symbolicName" type="string" />
<!-- Indicate whether the alias is for case level property or activity level property -->
<element name="caseContext" type="string" />
<!-- The attribute to indicate if this field may be used in a full text search. -->
<element name="full_text_searchable" type="boolean" maxOccurs="1" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="SearchDefinitionMetaDataWithOrigins">
<complexContent>
<extension base="tns:SearchDefinitionMetaData">
<sequence>
<element name="origins" type="tns:BusinessDataAliasOrigin" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="SearchDefinitionMetaDataWithId">
<complexContent>
<extension base="tns:SearchDefinitionMetaData">
<sequence>
<element name="id" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="BusinessDataAliasOrigin">
<sequence>
<element name="type" type="string" />
<element name="projectShortName" type="string" />
<element name="branchName" type="string" />
<element name="snapshotName" type="string" nillable="true" />
<element name="snapshotAcronym" type="string" />
<element name="snapshotId" type="string" nillable="true" />
<element name="processName" type="string" />
</sequence>
</complexType>
<!--
A list of meta data filtered by type that can be used in a saved or adhoc search definition
It is filtered by type of meta data requested and the elements returned are determined by the type of meta data requested.
-->
<complexType name="SearchDefintionMetaDataResultsByType">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="result" type="tns:SearchDefinitionMetaData" minOccurs="0" maxOccurs="unbounded"/>
<element name="caseResult" type="tns:SearchDefinitionMetaData" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
A list of action policies or available actions a user has based on the Saved Search Definition.
-->
<complexType name="SavedSearchDefinitionUsersAvailableActions">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="actions" type="string" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
此类型描述批量 savedSearch相关操作期间失败的操作。
-->
<complexType name="FailedOperations">
<sequence>
<!-- The saved search ID -->
<element name="savedSearchId" type="string" />
<!-- The error message prefix associated with the error -->
<element name="errorNumber" type="string" />
<!-- The error message associated with the error -->
<element name="errorMessage" type="string" />
</sequence>
</complexType>
<!--
此类型用于返回对多个已保存的搜索执行批量操作的结果。
-->
<complexType name="SavedSearchBulkOperation">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- A list of zero or more failed operations -->
<element name="failedOperations" type="tns:FailedOperations" minOccurs="0" maxOccurs="unbounded" />
<!-- A list of zero or more saved search definitions -->
<element name="definitions" type="tns:SavedSearchDefinition" minOccurs="0" maxOccurs="unbounded" />
<!-- Counts the saved searches on which the requested action was applied successfully. -->
<element name="succeeded" type="int" minOccurs="0" maxOccurs="1"/>
<!-- Counts the saved searches on which the requested action was applied unsuccessfully. -->
<element name="failed" type="int" minOccurs="0" maxOccurs="1"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data" xmlns:ex="http://rest.bpm.ibm.com/v1/data/exception" xmlns:soc="http://rest.bpm.ibm.com/v1/data/social" xmlns:sys="http://rest.bpm.ibm.com/v1/data/system" xmlns:ug="http://rest.bpm.ibm.com/v1/data/usergroup">
<status>200</status>
<data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/savedSearchDefinition" xsi:type="ns8:SavedSearchDefinition">
<id>1052</id>
<name>SavedSearchDefinition_Example</name>
<owner>ownerUserName</owner>
<organization>byInstance</organization>
<shared>true</shared>
<teams>
<teamId>24.da7e4d23-78cb-4483-98ed-b9c238308a03</teamId>
<teamName>All Users</teamName>
<processAppName>System Data</processAppName>
</teams>
<size>1000</size>
<interaction>all</interaction>
<fields>instanceName</fields>
<fields>taskSubject</fields>
<fields>taskStatus</fields>
<fields>taskDueDate</fields>
<fields>taskPriority</fields>
<fields>taskClosedDate</fields>
<fields>taskReceivedDate</fields>
<fields>bpdName</fields>
<aliases>
<field>bpdName</field>
<alias>Customer Specific Alias</alias>
</aliases>
<sort>
<field>instanceName</field>
<order>ASC</order>
</sort>
<sort>
<field>taskStatus</field>
<order>ASC</order>
</sort>
<conditions>
<field>taskStatus</field>
<operator>EQUAL</operator>
<value>Received</value>
</conditions>
</data>
</bpm:ResponseData>
缺省内容类型为application/json.
{"description": "WLE 错误响应" ，
"type": "object",
"properties":
{"status": {"type": "string" ，
"description": "先前 API 调用的状态。"
},
"exceptionType": {"type": "string" ，
"description": "与异常关联的类名。"
},
"errorNumber": {"type": "string",
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string",
"description": "Message text of the exception."
},
"errorMessage参数": {"type": ["string"] ， "optional": true ，
"description": "异常的消息文本参数。"
},
"programmersDetails": {"type": "object" ， "optional": true ，
"description": "其他异常详细信息，例如堆栈跟踪。"
}
}
}
<?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" />
<!--
此类型表示错误响应。
-->
<element name="RestRuntimeException">
<complexType>
<sequence>
<element name="status" type="string"/>
<element name="Data" type="tns:ExceptionData">
</element>
</sequence>
</complexType>
</element>
<!--
此类型包含与异常关联的详细错误信息。
-->
<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"/>
<!--
与异常关联的堆栈跟踪。
请注意，除非 "server-stacktrace-enabled" 属性
在服务器的 100Custom.xml 文件中启用。
-->
<element name="programmersDetails" type="string"></element>
<!-- Prior responses. 如果使用了批量命令，请设置 -->
<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>
| 代码 | 描述 |
|---|---|
| 200 成功 | 成功完成。
|
| 400 错误请求 | 错误请求
|
| 403 禁止 | 调用者无权执行此操作。
|
| 404 找不到 | 保存的搜索定义不存在。
|
| 406 不可接受 | 不支持请求的内容类型或内容编码。 |
| 500 内部服务器错误 | 内部服务器错误。 请参阅提供的详细信息。
|
8.5.7
父主题: 已保存的搜索定义资源