GET /rest/bpm/federated/v1/searches/meta/{type}[?searchType={string}][&instanceType={string}][&syncCacheUpdate={boolean}]
| Name | Value Type | Description |
|---|---|---|
| searchType | string | Possible values are:
|
| instanceType | string |
Only applies when setting the searchType parameter to value INSTANCE_SEARCH.
|
| syncCacheUpdate | boolean | A boolean value that specifies whether or not this function should wait until the cache data is updated and then return, or if the function should asynchronously update the cache data and return immediately. If this parameter is not specified, false is used as the default value. |
None
The default content type is application/json.
{ "description": "Search Meta Typed Result",
"type": "object",
"properties":
{
"result":
[ { "type": "object",
"description": "List for the request 'type' information to use for building saved searches."
"properties":
{
"name" : { "type" : "string",
"description": " The name of a valid field when the type is 'field', 'constraintFields', or 'businessDataFields'
or the name of a valid value when the type is 'taskStatus', 'taskState', 'instanceStatus', or 'priority'"
},
"type" : { "type" : "string",
"description": " The type of this field. This attribute will be included when the type is 'field', 'constraintFields', and 'businessDataFields'"
"enum":
[
"String",
"Date",
"Time",
"Boolean",
"Integer",
"Decimal"
]
},
"full_text_searchable" : { "type" : "boolean",
"description": " Is this field full text searchable, this attribute will be included when type is 'constraintFields'"
},
}
]
}
}
{
"result": [
{
"full_text_searchable": true,
"name": "applicationName",
"type": "String"
},
{
"full_text_searchable": true,
"name": "assignedToRoleDisplayName",
"type": "String"
},
{
"full_text_searchable": false,
"name": "assignedToUser",
"type": "String"
},
{
"full_text_searchable": false,
"name": "bpdId",
"type": "String"
},
{
"full_text_searchable": true,
"name": "bpdName",
"type": "String"
},
{
"full_text_searchable": false,
"name": "businessCategoryId",
"type": "String"
},
{
"full_text_searchable": false,
"name": "instanceId",
"type": "String"
},
{
"full_text_searchable": true,
"name": "instanceName",
"type": "String"
},
{
"full_text_searchable": true,
"name": "instanceProcessApp",
"type": "String"
},
{
"full_text_searchable": true,
"name": "instanceSnapshot",
"type": "String"
},
{
"full_text_searchable": false,
"name": "instanceSnapshotId",
"type": "String"
},
{
"full_text_searchable": false,
"name": "instanceStatus",
"type": "String"
},
{
"full_text_searchable": false,
"name": "invokedInstanceId",
"type": "String"
},
{
"full_text_searchable": false,
"name": "isEscalated",
"type": "Boolean"
},
{
"full_text_searchable": false,
"name": "isRead",
"type": "Boolean"
},
{
"full_text_searchable": false,
"name": "isSuspended",
"type": "Boolean"
},
{
"full_text_searchable": false,
"name": "isTransferredToWorkBasket",
"type": "Boolean"
},
{
"full_text_searchable": false,
"name": "isWaitingForSubTask",
"type": "Boolean"
},
{
"full_text_searchable": false,
"name": "kind",
"type": "String"
},
{
"full_text_searchable": false,
"name": "resumptionTime",
"type": "Date"
},
{
"full_text_searchable": false,
"name": "starter",
"type": "String"
},
{
"full_text_searchable": false,
"name": "supportsClaimIfSuspended",
"type": "Boolean"
},
{
"full_text_searchable": true,
"name": "taskActivityName",
"type": "String"
},
{
"full_text_searchable": false,
"name": "taskAtRiskTime",
"type": "Date"
},
{
"full_text_searchable": false,
"name": "taskClosedDate",
"type": "Date"
},
{
"full_text_searchable": false,
"name": "taskDueDate",
"type": "Date"
},
{
"full_text_searchable": false,
"name": "taskId",
"type": "String"
},
{
"full_text_searchable": false,
"name": "taskIsAtRisk",
"type": "Boolean"
},
{
"full_text_searchable": true,
"name": "taskNarrative",
"type": "String"
},
{
"full_text_searchable": false,
"name": "taskPriority",
"type": "Integer"
},
{
"full_text_searchable": false,
"name": "taskReceivedDate",
"type": "Date"
},
{
"full_text_searchable": false,
"name": "taskReceivedFrom",
"type": "String"
},
{
"full_text_searchable": false,
"name": "taskState",
"type": "String"
},
{
"full_text_searchable": false,
"name": "taskStatus",
"type": "String"
},
{
"full_text_searchable": true,
"name": "taskSubject",
"type": "String"
},
{
"full_text_searchable": false,
"name": "taskTemplateId",
"type": "String"
},
{
"full_text_searchable": true,
"name": "type",
"type": "String"
},
{
"full_text_searchable": false,
"name": "workBasketId",
"type": "String"
},
{
"full_text_searchable": true,
"name": "workBasketName",
"type": "String"
}
]
}
| Code | Description |
|---|---|
| 200 OK | The request completed successfully. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 404 Not Found | The resource does not exist. |
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem occurred. |
| 503 Service Unavailable | The federated request could not be delivered to individual federation targets. |
| 504 Gateway Timeout | The federated response has partial content because of missing individual responses. |
21.0.2
Parent Topic: Search Metadata Resource