Use the request parameters to filter the type of launchable entities to be returned and and the list of federated systems to retrieve it from.\n
The results include all information that are necessary to start the corresponding processes, services or invocation tasks directly on one of the federated system.\n
If a launchable entity is available on multiple federated systems, this REST API select a single one by using a load balancing algorithm that can be parameterized using the launchListPriority attribute of the ibmPfs_federatedSystem configuration element of each federated system.",
"operationId": "federatedLaunchQuery",
"parameters": [
{
"name": "includeSystemTypes",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"SYSTEM_TYPE_WLE",
"SYSTEM_TYPE_WPS",
"SYSTEM_TYPE_CASE",
"All"
]
},
"description": "
Use this method to retrieve the saved search definition action roles for the current user.
Note that this configuration differs from how action roles are defined in a federated Business Automation Workflow system.
Only applies when 'type' path parameter is set to value 'businessDataFields'.
When set to 'true', the business data variable exposed at the task level will also be returned."
},
{
"name": "searchType",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"TASK_SEARCH",
"INSTANCE_SEARCH"
]
},
"description": "
Possible values are:
- TASK_SEARCH (default): returns the metadata that applies for a task search
- INSTANCE_SEARCH: returns the metadata that applies for a process instance search
"
},
{
"name": "instanceType",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"BPD",
"Case",
"All"
]
},
"description": "
Only applies when setting the searchType parameter to value INSTANCE_SEARCH.
Possible values are:
- BPD: returns the metadata that applies for a BPD instance search
- Case: returns the metadata that applies for a Case instance search
- All (default): returns the metadata that applies for a BPD and Case instance search
"
},
{
"name": "syncCacheUpdate",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "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."
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_Search_Meta_Result.json"
},
"examples": {
"fields": {
"$ref": "#/components/examples/meta_fields"
},
"constraintFields": {
"$ref": "#/components/examples/meta_constraintFields"
},
"businessDataFields": {
"$ref": "#/components/examples/meta_businessDataFields"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v1/searches/tasks": {
"get": {
"tags": [
"Saved Search Definition"
],
"summary": "Get a list of saved searches definition that can be used to filter tasks & process instances lists.",
"description": "Return a list of saved search that can be referenced by the calling user when listing tasks and process instances with the
GET /v1/tasks REST API",
"operationId": "savedSearchQueries",
"parameters": [
{
"name": "includeSameName",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "By default, if a personally owned saved search and a shared saved search have the same name, only the personally owned saved search will be returned. To have both saved searches returned, set this parameter to true."
},
{
"name": "as_roles",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "string",
"enum": ["adminSavedSearch"],
"default": ""
},
"description": "Optional. Specifies a role for retrieving saved search definitions. Users with the
ACTION_ADMINISTER_SAVED_SEARCHES action role should set this parameter to
adminSavedSearch only when accessing saved search definitions that are neither shared nor owned by them. By default, the parameter is empty because other roles are applied automatically; only
ACTION_ADMINISTER_SAVED_SEARCHES requires explicit specification.
For more information about available action roles, refer to the
GET /v1/searches/actions REST API in the Metadata section."
}
],
"responses": {
"200": {
"description": "List of saved search definitions",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_ListMeta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchList_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
},
"post": {
"tags": [
"Saved Search Definition"
],
"summary": "Create a saved search definition.",
"operationId": "savedSearchNoNamePOST",
"description": "Use this method to create a saved search definition\n\n**Usage notes**\n
Valid field names that may be used in the 'fields' and 'sort' sections are based on the metadata fields names returned from these REST APIs:
GET /rest/bpm/federated/v1/searches/meta/fields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
Valid field names that may be used in the 'conditions' section are based on the metadata fields names returned from this REST API:
GET /rest/bpm/federated/v1/searches/meta/constraintFields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
Valid teams that may be used in the 'teams' section are based on the teams returned from this REST API:
GET /rest/bpm/federated/v1/globalTeams
The name of a saved search definition must be unique among all shared saved search definitions. The name only has to be unique among all saved search definitions owned by the same user when the saved search definition is not shared. The ID of the saved search definition will be assigned by the system and will be returned in the response JSON to the create. Even though saved search definitions are required to have a name the preferred access is to use the ID to avoid ambiguity with names.
Depending on the roles granted to the calling user, the user may be able to create shared and/or non-shared saved search definitions, whether owned by themselves or by other users.
For more information about available action roles, refer to the GET /v1/searches/actions REST API in the Metadata section.
",
"parameters": [
{
"name": "fieldValidationBypass",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Specifies that field name validation should be suppressed, so that saved search definitions can be created even if a business data field is not yet known. If this parameter is not specified, false is used as the default value."
},
{
"name": "as_roles",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "string",
"enum": ["adminSavedSearch"],
"default": ""
},
"description": "Optional. Specifies a role for creating saved search definitions. Users with the
ACTION_ADMINISTER_SAVED_SEARCHES action role should set this parameter to
adminSavedSearch only when creating saved search definitions that are neither shared nor owned by them. By default, the parameter is empty because other roles are applied automatically; only
ACTION_ADMINISTER_SAVED_SEARCHES requires explicit specification.
For more information about available action roles, refer to the
GET /v1/searches/actions REST API in the Metadata section."
}
],
"requestBody": {
"description": "Saved search definition",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_response"
}
}
}
}
},
"201": {
"description": "Created \nSuccessful completion, new resource created."
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"415": {
"description": "Unsupported Media Type \nThe content type or content encoding of the request is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
},
"x-codegen-request-body-name": "body"
}
},
"/v1/searches/tasks/meta/{type}": {
"get": {
"tags": [
"Metadata"
],
"summary": "deprecated, use GET /v1/searches/meta/{type} with searchType=TASK_SEARCH.",
"description": "This API is deprecated, use
GET /v1/searches/meta/{type} with
searchType=TASK_SEARCH",
"operationId": "taskSavedSearchMetadata",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"enum": [
"fields",
"constraintFields",
"businessDataFields",
"taskStatus",
"taskState",
"taskActivityType",
"instanceStatus",
"priority"
]
}
},
{
"name": "syncCacheUpdate",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_Search_Meta_Result.json"
},
"examples": {
"fields": {
"$ref": "#/components/examples/meta_fields"
},
"constraintFields": {
"$ref": "#/components/examples/meta_constraintFields"
},
"businessDataFields": {
"$ref": "#/components/examples/meta_businessDataFields"
}
}
}
}
}
},
"deprecated": true
}
},
"/v1/searches/tasks/{idOrName}": {
"get": {
"tags": [
"Saved Search Definition"
],
"summary": "Get a saved search definition.",
"description": "Use this method to retrieve the saved search definition with **ID** or **name** path parameter. \n\n **Usage notes:**\n\n The preferred access is to use the *ID* of a saved search definition to avoid ambiguity with names.",
"operationId": "savedSearchNameGET",
"parameters": [
{
"name": "idOrName",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "ID or name of the saved search to retrieve"
},
{
"name": "as_roles",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "string",
"enum": ["adminSavedSearch"],
"default": ""
},
"description": "Optional. Specifies a role for retrieving saved search definitions. Users with the
ACTION_ADMINISTER_SAVED_SEARCHES action role should set this parameter to
adminSavedSearch only when accessing saved search definitions that are neither shared nor owned by them. By default, the parameter is empty because other roles are applied automatically; only
ACTION_ADMINISTER_SAVED_SEARCHES requires explicit specification.
For more information about available action roles, refer to the
GET /v1/searches/actions REST API in the Metadata section."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
},
"put": {
"tags": [
"Saved Search Definition"
],
"summary": "Update a saved search definition.",
"description": "Use this method to update a saved search definition with
ID or name path parameter.\n\n**Usage note**\n\n
The preferred access mechanism is to use the ID of a saved search rather than the name, to avoid ambiguity with names.
Depending on the roles granted to the calling user, the user may be able to update shared and/or non-shared saved search definitions, whether owned by themselves or by other users.
For more information about available action roles, refer to the GET /v1/searches/actions REST API in the Metadata section.
Valid field names that may be used in the 'fields' and 'sort' sections are based on the metadata fields names returned from these REST APIs:
GET /rest/bpm/federated/v1/searches/meta/fields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
Valid field names that may be used in the 'conditions' section are based on the metadata fields names returned from these REST APIs:
GET /rest/bpm/federated/v1/searches/meta/constraintFields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
Valid teams that may be used in the 'teams' section are based on the teams returned from this REST API:
GET /rest/bpm/federated/v1/globalTeams
The preferred access is to use the ID of a saved search definition to avoid ambiguity with names.
",
"operationId": "savedSearchNamePUT",
"parameters": [
{
"name": "idOrName",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "ID or name of the saved search to update"
},
{
"name": "fieldValidationBypass",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Specifies that field name validation should be suppressed, so that a saved search definition can be updated even if a business data field is not yet known.\nIf this parameter is not specified, **false** is used as the default value."
},
{
"name": "as_roles",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "string",
"enum": ["adminSavedSearch"],
"default": ""
},
"description": "Optional. Specifies a role for updating saved search definitions. Users with the
ACTION_ADMINISTER_SAVED_SEARCHES action role should set this parameter to
adminSavedSearch only when updating saved search definitions that are neither shared nor owned by them. By default, the parameter is empty because other roles are applied automatically; only
ACTION_ADMINISTER_SAVED_SEARCHES requires explicit specification.
For more information about available action roles, refer to the
GET /v1/searches/actions REST API in the Metadata section."
}
],
"requestBody": {
"description": "saved search definition",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"415": {
"description": "Unsupported Media Type \nThe content type or content encoding of the request is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
},
"x-codegen-request-body-name": "body"
},
"delete": {
"tags": [
"Saved Search Definition"
],
"summary": "Delete a saved search definition.",
"description": "Use this method to delete the saved search definition with **ID** or **name** path parameter.\n\n**Usage notes**\n\n
The preferred access is to use the ID of a saved search definition to avoid ambiguity with names.
Depending on the roles granted to the calling user, the user may be able to delete shared and/or non-shared saved search definitions, whether owned by themselves or by other users.
For more information about available action roles, refer to the GET /v1/searches/actions REST API in the Metadata section.
",
"operationId": "savedSearchNameDELETE",
"parameters": [
{
"name": "idOrName",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "ID or name of the saved search to delete"
},
{
"name": "as_roles",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "string",
"enum": ["adminSavedSearch"],
"default": ""
},
"description": "Optional. Specifies a role for deleting saved search definitions. Users with the
ACTION_ADMINISTER_SAVED_SEARCHES action role should set this parameter to
adminSavedSearch only when deleting saved search definitions that are neither shared nor owned by them. By default, the parameter is empty because other roles are applied automatically; only
ACTION_ADMINISTER_SAVED_SEARCHES requires explicit specification.
For more information about available action roles, refer to the
GET /v1/searches/actions REST API in the Metadata section."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_response"
}
}
}
}
}
}
}
},
"/v1/searches/transfer": {
"get": {
"tags": [
"Saved Search Transfer"
],
"summary": "Get a list of saved searches that can be exported from a local system.",
"description": "Use this method to export the list of saved search definitions recorded in the Process Federation Server database.",
"operationId": "federatedSavedSearchesGET",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_LocalTransfer.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchLocalExportList_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
},
"post": {
"tags": [
"Saved Search Transfer"
],
"summary": "Import BPD-related saved search definitions to Process Federation Server.",
"description": "Use this method to import BPD-related saved search definitions to Process Federation Server. \n\n **Usage notes** \n\n
The 'results' section of the query result returned from one of these REST APIs or the content of the file generated with parameter 'outputFile' can be used as input to this REST API to import saved searches to Process Federation Server:
GET /rest/bpm/federated/v1/searches/transfer/bpd/systemsGET /rest/bpm/federated/v1/searches/transfer/bpd/system/{federatedSystem}GET /rest/bpm/federated/v1/searches/transfer/bpd/system/{federatedSystem}/search/{savedSearch}
Valid field names that may be used in the 'exportedFrom' section are based on the 'systemID' and 'id' names of the returned from this REST API:
GET /rest/bpm/federated/v1/systems
Valid field names that may be used in the 'fields' and 'sort' sections within the 'savedSearch' section are based on the metadata fields names returned from these REST APIs:
GET /rest/bpm/federated/v1/searches/meta/fields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
Valid field names that may be used in the 'conditions' section within the 'savedSearch' section are based on the metadata fields names returned from these REST APIs:
GET /rest/bpm/federated/v1/searches/meta/constraintFields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
The name of a saved search definition to import must be unique among all shared saved search definitions. The value specified in the 'importName' section provided in the list of saved search to import must therefore be unique. The ID of the saved search definition will be assigned by the system and will be returned in the response JSON when the import of all saved searches completes successfully.
Depending on the roles granted to the calling user, the user may be able to import shared and/or non-shared saved search definitions, whether owned by themselves or by other users.
For more information about available action roles, refer to the GET /v1/searches/actions REST API in the Metadata section.
",
"operationId": "federatedSystemAndSavedSearchPOST",
"parameters": [
{
"name": "fieldValidationBypass",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Specifies whether or not field name validation should be suppressed, so that saved search definitions can be created even if a business data field is not yet known. If this parameter is not specified, false is used as the default value."
},
{
"name": "validateOnly",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Specifies whether or not the saved search definitions must only be sanity-checked and validated without being effectively imported. If this parameter is not specified, false is used as the default value."
}
],
"requestBody": {
"description": "saved search definition",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_ImportInput.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchImport_request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_ImportOutput.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchImport_response"
}
}
}
}
},
"201": {
"description": "Created \nSuccessful completion, new resource created."
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"415": {
"description": "Unsupported Media Type \nThe content type or content encoding of the request is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
},
"x-codegen-request-body-name": "body"
}
},
"/v1/searches/transfer/bpd/system/{federatedSystem}": {
"get": {
"tags": [
"Saved Search Transfer"
],
"summary": "Get a list of saved search definitions available to this user from a specific federated systems.",
"description": "Use this method to retrieve a list of saved search definitions available to this user from a specific BPD-related federated system. The query result will contain a list of saved searches (name of the saved search, federated system it is exported from, summary information about each saved search definition).",
"operationId": "federatedSystemAndSavedSearchesGET",
"parameters": [
{
"name": "federatedSystem",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "The ID of a BPD-related federated system."
},
{
"name": "outputFile",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "Specifies the absolute path of a file to save the result of the query results. If this parameter is not specified, no file is generated."
},
{
"name": "renameDuplicates",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Renames the duplicate saved search names in the query result list by appending a dot followed by the BPD federated system ID to the saved search name. If this parameter is not specified, false is used as the default value."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Transfer.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchImportList_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v1/searches/transfer/bpd/system/{federatedSystem}/search/{search}": {
"get": {
"tags": [
"Saved Search Transfer"
],
"summary": "Get a saved search definition that can be exported from a specific BPD-related system.",
"description": "Use this method to retrieve a specific saved search definition available to this user from a specific BPD-related federated system. The query result will contain a saved search (name of the saved search, federated system it is exported from, summary information about each saved search definition).",
"operationId": "federatedSystemAndSavedSearchGET",
"parameters": [
{
"name": "federatedSystem",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "outputFile",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "Specifies the absolute path of a file to save the result of the query results. If this parameter is not specified, no file is generated."
}
],
"responses": {
"200": {
"description": "If the ID of the **federatedSystem** corresponds to a BPEL system then an error message with a status code 400 is returned. ",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Transfer.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchImportList_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses. "
}
}
}
},
"/v1/searches/transfer/bpd/systems": {
"get": {
"tags": [
"Saved Search Transfer"
],
"summary": "Get a list of saved search definitions available to this user from all the BPD-related federated systems.",
"operationId": "federatedSystemsAndSavedSearchesGET",
"description": "Use this method to retrieve a list of saved search definitions available to this user from all the BPD-related federated systems. The query result will contain a list of saved searches (name of the saved search, federated system it is exported from, summary information about each saved search definition).",
"parameters": [
{
"name": "outputFile",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "Specifies the absolute path of a file to save the result of the query results. If this parameter is not specified, no file is generated."
},
{
"name": "renameDuplicates",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Renames the duplicate saved search names in the query result list by appending a dot followed by the BPD federated system ID to the saved search name. If this parameter is not specified, false is used as the default value."
}
],
"responses": {
"200": {
"description": "Lists the available saved searches that can be exported from each of all the BPD-related federated systems.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Transfer.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchImportList_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v1/systems": {
"get": {
"tags": [
"Metadata"
],
"summary": "Information about federated IBM BPM systems.",
"operationId": "federatedSystemsQuery",
"description": "Use this method to retrieve metadata for the federated systems.
The attributes that are returned for each system depend on the system type (see example responses).",
"responses": {
"200": {
"description": "System details (SystemMetadata complexType).",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_Systems.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/systems_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v1/tasks": {
"get": {
"tags": [
"Tasks & Process Instances List"
],
"summary": "Get a list of tasks filtered using a predefined saved search definition.",
"description": "Use this method to retrieve a list of tasks filtered using a predefined saved search definition. \n\n **Usage notes** \n\n
- The list of saved search definitions that can be referenced in the 'savedSearch' parameter can be retrieved using the
GET /v1/searches/tasks REST API - The preferred access mechanism is to use the ID of a saved search rather than the name on the 'savedSearch' parameter, to avoid ambiguity with names.
- The query executed will be a query that is built from the saved search definition, the queryFilter parameter, the searchFilter parameter and the interaction parameter.
- Field names that may be used in the 'fields', 'sort' and 'queryFilter' parameters must be in the names listed in the 'fields' setting of the referrenced saved search definition.
- Use the parameter 'offset' along with the 'size' parameter to provide paging functionality.
",
"operationId": "federatedTasksQuery",
"parameters": [
{
"name": "savedSearch",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "The name or ID of the saved search definition. The default is 'IBM.DEFAULTALLTASKSLIST_75'"
},
{
"name": "systemID",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "The ID of a federated IBM BPM system. Use the ID to filter the results for a specific federated system. \nsystemID is a universally unique identifier (UUID), such as f1436904-793d-4a38-8c64-7634dbdae6f6. Use the Process Federation Server /federated/v1/systems rest query to retrieve the systemID."
},
{
"name": "interaction",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"claimed",
"available",
"claimed_and_available",
"completed",
"all"
]
},
"description": "Name of a predefined user interaction filter. This value when provided will override the interaction setting of the referenced saved search definition.
- claimed: Returns tasks that are claimed by the current user. Tasks in suspended process instances are excluded.
- available: Returns tasks that can be claimed by the current user. Tasks in suspended process instances are excluded.
- claimed_and_available: Returns tasks from the 'claimed' and the 'available' filters.
- completed: Returns tasks which were completed by the current user.
- all: All tasks that the current user can claim(available), claimed, or completed. Tasks in suspended process instances are included. This is the default value for the interaction if none is specified.
"
},
{
"name": "fields",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "Comma-separated list of fields that are to be retrieved by the query. If no fields are specified, then all the fields that are defined in the saved search definition are returned. Only fields defined in the saved search definition 'fields' setting are allowed to be specified."
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
A condition language expression that provides additional filtering.
You can reference any of the fields that are defined in the saved search definition.
This filter will be combined with searchFilter and with the conditions of the saved search definition.
The queryFilter parameter is a group of expressions separated by the AND & OR keywords, optionally grouped within parenthesis, similar to a SQL WHERE clause (including the usage of single quotes for string literals).
Example: (Expression1 OR Expression2) AND Expression3
The syntax of an expression is as follows:
<expression> := <field> <operator> [<value>]
<expression> := [(]<expression> AND <expression>[)]
<expression> := [(]<expression> OR <expression>[)]
<field> can be any of the task fields that are returned by the saved search.
<operator> depends on the type of the field. The following table details which operator is available for which type of field:
| Operator | Available for strings | Available for booleans | Available for numbers | Available for dates |
| = (equals) | X | X | X | X |
| <> (not equals and not null) | X | X | X | X |
| < (less than) | X | | X | X |
| <= (less than or equal) | | | X | |
| > (greater than) | X | | X | X |
| >= (greater than or equal) | | | X | |
| IS NULL (does not have a value) | X | | | |
| IS NOT NULL (has a value) | X | | | |
| LIKE | X | | | |
| NOT LIKE | X | | | |
| IN | X | | X | X |
Note that there might be some restrictions on the available operators for some predefined task fields, in which case a CWMFS4102E error will be returned by the rest API, with an explanation message that lists the operators available for the field.
<value> itself has the same type than the field. Here is the supported syntax for <value>:
- String: the value is in single quotes (example: 'my value').
- Boolean: all the following syntax are supported 'true', 'false', 'TRUE', 'FALSE', true, false, TRUE and FALSE.
- Date: use a string in ISO8601 format.
- Operators IS NULL and IS NOT NULL do not use a value.
- Operators LIKE and NOT LIKE accept wildcards characters in the string value:
- % at the start or end of the string represents 0..N characters (example: %Task% filter matches Task, MyTask, MyTaskTwo, ...)
- ? anywhere in the string represents exactly one character (example: T?skfilter matches Task, Tusk, ...)
- Operator IN uses a list value with the following syntax: (value1, value2, ...).
"
},
{
"name": "processAppName",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "Returns tasks that belong to the specified process application."
},
{
"name": "sort",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
A comma-separated list of sort criteria to apply to the results of the task query. The entries in the list are of field names followed by an optional order in the form [fieldName ASC|DESC]. Ascending(ASC) is the default order if it is not specified.
This list will override the sort list of the referenced saved search definition.
Only federated system indexes will be included in the task query that have at least one task indexed with each of these fields.
"
},
{
"name": "offset",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "Specifies the index (origin 0) of the first entity in the query result set. Offset 0 refers to the first entity in the result set; offset 1 to the second entity, and so on. If this parameter is not specified, 0 is used as the default value. \nUse this parameter with the size parameter to provide paging in the task list."
},
{
"name": "size",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
Specifies the maximum number of entities to be returned. If this parameter is not specified, 25 is used as the default value.
Use this parameter with the offset parameter to provide paging in the task list.
This value when provided will override the size setting of the referenced saved search definition. If this parameter is not specified as a query parameter and not specified in the saved search definition, 25 is used as the default value.
\t\t\t\t
"
},
{
"name": "searchFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Provide search words to filter the results. All task and business data fields will be searched.
This filter will be combined with queryFilter and with the conditions of the saved search definition.
Multiple words can be separated by a space, in which case all of the words must be found in a task.
Wildcards can be included: ? for single character wildcards, * for variable length wildcards.
To search for words spelled similarly, use ~ at the end of the word.
For searching within a single field, use a queryFilter expression instead.
For decimal, date, and boolean fields, use a queryFilter expression instead.
"
},
{
"name": "filterByCurrentUser",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "
This parameter is a flag that indicates whether or not the search results should be restricted to the entities that are associated with the current user. A value of false means that the search is unfiltered, whereas a value of true indicates that the search results are filtered by the current user. If the current user has IBM Business Automation Workflow Administrator rights on the server, the default value is false, but if an interactionFilter value is applied, a filtered search is performed. If the current user does not have administrator rights, this parameter is ignored and a filtered search is performed. [Available since IBM Process Federation Server 19.0.0.2]
Note: This parameter is used only when the request is executed by a user who belongs to the \"adminSavedSearch\" security-role.
"
},
{
"name": "calcStats",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Specifies that 'stats' response values should be returned. The statistics will include the total number of task found in this query, the number of open task that are at risk, overdue, and on track."
},
{
"name": "alphabeticalSort",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "By default, this parameter is set to false: the values that result from a sorted query on string business data fields are case-sensitive (lexicographical sorting order). For example, in ascending order: \"Alan\", \"Zoe\", \"bernard\". Set this parameter to true if you want the query result values to be case-insensitive (alphabetical sorting order). For example, in ascending order: \"Alan\", \"bernard\", \"Zoe\"."
},
{
"name": "includeAllBusinessData",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "By default, this parameter is set to false. If set to true, all existing business data will be returned in the task instances list. This parameter is only supported when using a remote Elasticsearch."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Result.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/taskAll_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
},
"put": {
"tags": [
"Tasks & Process Instances List"
],
"summary": "Get a list of tasks filtered using a saved search definition directly provided in the body of the request.",
"description": "Use this method to retrieve a list of task filtered using a saved search definition directly provided in the body of the request. This method may be used to test a saved search definition before saving. \n\n **Usage notes** \n\n
Valid field names that may be used in the 'fields' and 'sort' sections are based on the metadata fields names returned from these REST APIs:
GET /rest/bpm/federated/v1/searches/meta/fields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
Valid field names that may be used in the 'conditions' section are based on the metadata fields names returned from these REST APIs:
GER /rest/bpm/federated/v1/searches/meta/constraintFields?searchType=TASK_SEARCHGET /rest/bpm/federated/v1/searches/meta/businessDataFields?searchType=TASK_SEARCH
Note that for compatibility reasons with the corresponding non-federated BPM REST API, a filter condition like 'Owner Not Equal To XXX' will be applied as 'Owner exists AND Owner Not Equal to XXX'.
",
"operationId": "savedSearchTasksQueryAdhoc",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "Specifies the index (origin 0) of the first entity in the query result set. Offset 0 refers to the first entity in the result set; offset 1 to the second entity, and so on. If this parameter is not specified, 0 is used as the default value. Use this parameter with the size parameter to provide paging in the task list."
},
{
"name": "size",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "Specifies the maximum number of entities to be returned. If this parameter is not specified, 25 is used as the default value. Use this parameter with the offset parameter to provide paging in the task list."
},
{
"name": "filterByCurrentUser",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "
This parameter is a flag that indicates whether or not the search results should be restricted to the entities that are associated with the current user. A value of false means that the search is unfiltered, whereas a value of true indicates that the search results are filtered by the current user. If the current user has IBM Business Automation Workflow Administrator rights on the server, the default value is false, but if an interactionFilter value is applied, a filtered search is performed. If the current user does not have administrator rights, this parameter is ignored and a filtered search is performed. [Available since IBM Process Federation Server 19.0.0.2]
Note: This parameter is used only when the request is executed by a user who belongs to the \"adminSavedSearch\" security-role.
"
},
{
"name": "calcStats",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "Specifies that 'stats' response values should be returned. The statistics will include the total number of task found in this query, the number of open task that are at risk, overdue, and on track."
},
{
"name": "getFieldsValues",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "
If set to true, the search execution will not return any matching tasks but will return instead a single item with one array attribute per requested field. The array contains the actual values gathered in the federated indices for this field across all the tasks matching the search:
- For string fields, the array contains the existing values sorted lexicographically. The maximum number of entries in the array is defined by the size attribute of the search (the array is empty if there is no indexed value for the field).
- For numeric and date fields, the array contains exactly two entries: the minimum value for the field and the maximum value (both are null if there is no indexed value for the field)
- For boolean fields, the array contains the two true and false values.
- If retrieving existing values for the field is not supported (example: a business data field that is defined twice with a different type, one as numeric and one a string), the returned value for the field is null
"
},
{
"name": "alphabeticalSort",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "By default, this parameter is set to false: the values that result from a sorted query on string business data fields are case-sensitive (lexicographical sorting order). For example, in ascending order: \"Alan\", \"Zoe\", \"bernard\". Set this parameter to true if you want the query result values to be case-insensitive (alphabetical sorting order). For example, in ascending order: \"Alan\", \"bernard\", \"Zoe\"."
},
{
"name": "includeAllBusinessData",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "By default, this parameter is set to false. If set to true, all existing business data will be returned in the task instances list. This parameter is only supported when using a remote Elasticsearch."
}
],
"requestBody": {
"description": "Saved Search definition",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Task list (Task complexType).",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Result.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/taskAll_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"415": {
"description": "Unsupported Media Type \nThe content type or content encoding of the request is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/dashboards/processinstancetrend/{processAppId}/{processId}": {
"get": {
"tags": [
"Process Performance Dashboard"
],
"summary": "Retrieve daily or hourly process instance trend for a process that expose its performance metrics to the user",
"description": "Use this method to retrieve the process instances turnover rates (numbers of instances created and completed hourly or daily) for a BPD process that exposes its performance metrics to the calling user.",
"operationId": "getProcessInstanceTrend",
"parameters": [
{
"name": "processAppId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Identifier of the process"
},
{
"name": "processId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Identifier of the process instance"
},
{
"name": "units",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"DAY",
"HOUR"
]
},
"description": "
Use HOUR for hourly turnover rate, DAY for daily turnover rate.
If this parameter is not specified, the default value of HOUR (hourly turnover rate) is used.
"
},
{
"name": "numPeriods",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
The number of data points (turnover rate for one specific day or hour) to return.
If this parameter is not specified, the default value of 24 is used for hourly turnover rate, or of 14 for daily turnover rate.
"
},
{
"name": "endPeriod",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-01-01T08:30:00Z"
},
"description": "
Last date/time for which a turnover rate should be returned (ISO8601 formatted date).
If this parameter is not specified, the current date/time is used.
"
},
{
"name": "timeZone",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"examples": {
"iana": {
"value": "America/Los_Angeles",
"description": "IANA time zone ID"
},
"offset": {
"value": "GMT+01:00",
"description": "GMT offset"
}
},
"description": "
The time zone for the endPeriod and the results. It can be provided as an IANA time zone id (example: America/Los_Angeles) or as a GMT offset between GMT-18:00 and GMT+18:00 included (example: GMT+01:00)
If this parameter is not specified, the default time zone is GMT.
"
},
{
"name": "searchFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Provide search terms to filter the list of instances on which the returned statistics are calculated. Instances fields and business data fields that are available for search will be searched.
Multiple terms can be separated by a space, in which case all of the terms must be found in a task.
Wildcards can be included: ? for single character wildcards, * for variable length wildcards.
To search for terms spelled similarly, use ~ at the end of the term.
"
}
],
"responses": {
"200": {
"description": "Lists of turnover rate data points (one per hour or day for the requested period).",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_ProcessInstanceTrend.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/processInstanceTrend_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/dashboards/processsummary": {
"get": {
"tags": [
"Process Performance Dashboard"
],
"summary": "Retrieve summary information about the tasks of each process that has performance metrics exposed to the calling user.",
"description": "Use this method to retrieve summary information about the tasks of each process that exposes its performance metrics to the calling user.",
"operationId": "getProcessSummaries",
"parameters": [],
"responses": {
"200": {
"description": "Lists task summary information for each process that exposes its performance metrics to the calling user.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_ProcessSummaries.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/processSummaries_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/dashboards/processsummary/{processAppId}/{processId}": {
"get": {
"tags": [
"Process Performance Dashboard"
],
"summary": "Retrieve summary information about the tasks of a process that have performance metrics exposed to the calling user.",
"description": "Use this method to retrieve summary information about the tasks of a process that exposes its performance metrics to the calling user.",
"operationId": "getProcessSummary",
"parameters": [
{
"name": "processAppId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Identifier of the process"
},
{
"name": "processId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Identifier of the process instance"
},
{
"name": "searchFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Provide search terms to filter the list of instances on which the returned statistics are calculated. Instances fields and business data fields that are available for search will be searched.
Multiple terms can be separated by a space, in which case all of the terms must be found in an instance.
Wildcards can be included: ? for single character wildcards, * for variable length wildcards.
To search for terms spelled similarly, use ~ at the end of the term.
"
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_ProcessSummary.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/processSummary_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden\t \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/dashboards/teammember/{teamId}": {
"get": {
"tags": [
"Team Performance Dashboard"
],
"summary": "Retrieve a list of all members of a team managed by the user, with information about completed today and open tasks for each",
"description": "Use this method to retrieve a list of all members of a team managed by the calling user, with information about tasks completed on the day and open tasks for each.",
"operationId": "getTeamMemberList",
"parameters": [
{
"name": "teamId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Identifier of the team"
},
{
"name": "size",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "The maximum number of users to return. The default value is 100."
},
{
"name": "from",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "A username to use 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."
}
],
"responses": {
"200": {
"description": "Lists all members of a team managed by the calling user, with information about tasks completed on the day and open tasks for each.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_TeamMemberList.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/teamMemberList_response"
}
}
}
}
}
}
}
},
"/v2/dashboards/teammember/{teamId}/{username}": {
"get": {
"tags": [
"Team Performance Dashboard"
],
"summary": "Retrieve summary information about the tasks of a team member managed by the calling user.",
"description": "
Use this method to retrieve statistics for a team member from a team managed by the calling user.
The statistics cover all the tasks that are assigned to, or were completed today by the team member, whatever team those tasks are related to.
",
"operationId": "getTeamMember",
"parameters": [
{
"name": "teamId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Identifier of the team"
},
{
"name": "username",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Name of the team member"
},
{
"name": "searchFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Provide search terms to filter the list of tasks on which the returned statistics are calculated. Task fields and business data fields that are available for search will be searched.
Multiple terms can be separated by a space, in which case all of the terms must be found in a task.
Wildcards can be included: ? for single character wildcards, * for variable length wildcards.
To search for terms spelled similarly, use ~ at the end of the term.
"
}
],
"responses": {
"200": {
"description": "Statistics for a team member from a team managed by the calling user.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_TeamMemberSummary.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/teamMemberSummary_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/dashboards/teamsummary": {
"get": {
"tags": [
"Team Performance Dashboard"
],
"summary": "Retrieve summary information about the tasks of each team managed by the calling user.",
"description": "Use this method to retrieve summary information about the tasks of each team managed by the calling user.",
"operationId": "getTeamSummaries",
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "Filters the process app teams and includes only process app team names that match the specified filter condition. The filter is case-sensitive. By default, the method returns all the process app teams that are managed by the user. Example: \"hiring*\" returns all the process app teams whose name starts with \"hiring\"."
},
{
"name": "size",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "The maximum number of managed teams to retrieve summary information for. The default value is 100."
}
],
"responses": {
"200": {
"description": "Lists task summary information for each team managed by the calling user.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_TeamSummaries.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/teamSummaries_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/dashboards/teamsummary/{teamId}": {
"get": {
"tags": [
"Team Performance Dashboard"
],
"summary": "Retrieve summary information about the tasks of a team managed by the user",
"description": "Use this method to retrieve summary information about the tasks of a team managed by the calling user.",
"operationId": "getTeamSummary",
"parameters": [
{
"name": "teamId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Identifier of the team"
},
{
"name": "searchFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Provide search terms to filter the list of tasks on which the returned statistics are calculated. Task fields and business data fields that are available for search will be searched.
Multiple terms can be separated by a space, in which case all of the terms must be found in a task.
Wildcards can be included: ? for single character wildcards, * for variable length wildcards.
To search for terms spelled similarly, use ~ at the end of the term.
"
}
],
"responses": {
"200": {
"description": "Lists task summary information for a team managed by the calling user.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_TeamSummary.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/teamSummary_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/dashboards/teamtasks": {
"put": {
"tags": [
"Team Performance Dashboard"
],
"summary": "Retrieve a list of all tasks for all teams managed by the user",
"description": "Use this method to run an ad hoc saved search on the tasks of all teams managed by the calling user.",
"operationId": "putTeamTasks",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
Specifies the index (origin 0) of the first entity in the query result set.
Offset 0 refers to the first entity in the result set; offset 1 to the second entity, and so on.
If this parameter is not specified, 0 is used as the default value. Use this parameter with the size parameter to provide paging in the task list.
"
},
{
"name": "size",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
Specifies the maximum number of entities to be returned.
If this parameter is not specified, 25 is used as the default value.
Use this parameter with the offset parameter to provide paging in the task list.
"
},
{
"name": "alphabeticalSort",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "
By default, this parameter is set to false: the values that result from a sorted query on string business data fields are case-sensitive (lexicographical sorting order). For example, in ascending order: \"Alan\", \"Zoe\", \"bernard\".
Set this parameter to true if you want the query result values to be case-insensitive (alphabetical sorting order). For example, in ascending order: \"Alan\", \"bernard\", \"Zoe\".
"
}
],
"requestBody": {
"description": "Saved search definition. The input is in JSON format.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Task list (Task complexType).",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_TeamTasks.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/teamTasks_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"415": {
"description": "Unsupported Media Type \nThe content type or content encoding of the request is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/dashboards/teamtasks/{teamId}": {
"put": {
"tags": [
"Team Performance Dashboard"
],
"summary": "Retrieve a list of all tasks for a team managed by the user",
"description": "Use this method to run an ad hoc saved search on the tasks of a team managed by the calling user.",
"operationId": "putTeamTasks_0",
"parameters": [
{
"name": "teamId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "ID of the team"
},
{
"name": "offset",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
Specifies the index (origin 0) of the first entity in the query result set.
Offset 0 refers to the first entity in the result set; offset 1 to the second entity, and so on.
If this parameter is not specified, 0 is used as the default value. Use this parameter with the size parameter to provide paging in the task list.
"
},
{
"name": "size",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
Specifies the maximum number of entities to be returned.
If this parameter is not specified, 25 is used as the default value.
Use this parameter with the offset parameter to provide paging in the task list.
"
},
{
"name": "alphabeticalSort",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "
By default, this parameter is set to false: the values that result from a sorted query on string business data fields are case-sensitive (lexicographical sorting order). For example, in ascending order: \"Alan\", \"Zoe\", \"bernard\".
Set this parameter to true if you want the query result values to be case-insensitive (alphabetical sorting order). For example, in ascending order: \"Alan\", \"bernard\", \"Zoe\".
"
}
],
"requestBody": {
"description": "Saved search definition. The input is in JSON format.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_SavedSearch_Meta.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/savedSearchMeta_request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Task list (Task complexType).",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_TeamTasks.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/teamTasks_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"415": {
"description": "Unsupported Media Type \nThe content type or content encoding of the request is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/dashboards/teamtasktrend/{teamId}": {
"get": {
"tags": [
"Team Performance Dashboard"
],
"summary": "Retrieve daily or hourly task trend for a team managed by the user",
"description": "Use this method to retrieve the tasks turnover rates (numbers of tasks created and completed hourly or daily) for a team managed by the calling user.",
"operationId": "getTeamTaskTrend",
"parameters": [
{
"name": "teamId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"description": "Team ID"
},
{
"name": "units",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"DAY",
"HOUR"
]
},
"description": "
Use HOUR for hourly turnover rate, DAY for daily turnover rate.
If this parameter is not specified, the default value of HOUR (hourly turnover rate) is used.
"
},
{
"name": "numPeriods",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
The number of data points (turnover rate for one specific day or hour) to return.
If this parameter is not specified, the default value of 24 is used for hourly turnover rate, or of 14 for daily turnover rate.
"
},
{
"name": "endPeriod",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-01-01T08:30:00Z"
},
"description": "
last date/time for which a turnover rate should be returned (ISO 8601 formatted date).
If this parameter is not specified, the current date/time is used.
"
},
{
"name": "timeZone",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"examples": {
"iana": {
"value": "America/Los_Angeles",
"description": "IANA time zone ID"
},
"offset": {
"value": "GMT+01:00",
"description": "GMT offset"
}
},
"description": "
The time zone for the endPeriod and the results. It can be provided as an IANA time zone id (example: America/Los_Angeles) or as a GMT offset between GMT-18:00 and GMT+18:00 included (example: GMT+01:00)
If this parameter is not specified, the default time zone is GMT.
"
},
{
"name": "searchFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Provide search terms to filter the list of tasks on which the returned statistics are calculated. Task fields and business data fields that are available for search will be searched.
Multiple terms can be separated by a space, in which case all of the terms must be found in a task.
Wildcards can be included: ? for single character wildcards, * for variable length wildcards.
To search for terms spelled similarly, use ~ at the end of the term.
"
}
],
"responses": {
"200": {
"description": "Lists of turnover rate data points (one per hour or day for the requested period).",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_TeamTaskTrend.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/teamTaskTrend_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/management/indexers/backupState": {
"get": {
"tags": [
"Backup & Restore"
],
"summary": "Get the latest backup of the state of the indexers.",
"description": "Get the latest backup of the state of the indexers.",
"operationId": "backupStateGET",
"parameters": [
{
"name": "federatedSystemsFilter",
"in": "query",
"description": "A comma separated list of id, systemID or displayName that a federated system must match to be processed by the REST API",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Provide the result of the operation for each federated system for which there is at least one indexer running in the Process Federation Server on which the REST call was performed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_IndexersState.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/getIndexersBackupState_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
},
"put": {
"tags": [
"Backup & Restore"
],
"summary": "Backup the current state of the indexers.",
"description": "Backup the current state of the indexers.",
"operationId": "backupStatePUT",
"parameters": [
{
"name": "federatedSystemsFilter",
"in": "query",
"description": "A comma separated list of id, systemID or displayName that a federated system must match to be processed by the REST API",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Provide the result of the operation for each federated system for which there is at least one indexer running in the Process Federation Server on which the REST call was performed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_IndexersState.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/putIndexersBackupState_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
},
"delete": {
"tags": [
"Backup & Restore"
],
"summary": "Delete any backup of the state of the indexers.",
"description": "Delete any backup of the state of the indexers.",
"operationId": "backupStateDELETE",
"parameters": [
{
"name": "federatedSystemsFilter",
"in": "query",
"description": "A comma separated list of id, systemID or displayName that a federated system must match to be processed by the REST API",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Provide the result of the operation for each federated system for which there is at least one indexer running in the Process Federation Server on which the REST call was performed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_IndexersState.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/deleteIndexersBackupState_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/management/indexers/restoreState": {
"put": {
"tags": [
"Backup & Restore"
],
"summary": "Restore the latest backup of the state of the indexers.",
"description": "Restore the latest backup of the state of the indexers.",
"operationId": "restoreStatePUT",
"parameters": [
{
"name": "federatedSystemsFilter",
"in": "query",
"description": "A comma separated list of id, systemID or displayName that a federated system must match to be processed by the REST API",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Provide the result of the operation for each federated system for which there is at least one indexer running in the Process Federation Server on which the REST call was performed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_IndexersState.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/putIndexersRestoreState_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
},
"delete": {
"tags": [
"Backup & Restore"
],
"summary": "Cancel the previous request to restore the latest backup of the state of the indexers.",
"description": "Cancel the previous request to restore the latest backup of the state of the indexers.",
"operationId": "restoreStateDELETE",
"parameters": [
{
"name": "federatedSystemsFilter",
"in": "query",
"description": "A comma separated list of id, systemID or displayName that a federated system must match to be processed by the REST API",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Provide the result of the operation for each federated system for which there is at least one indexer running in the Process Federation Server on which the REST call was performed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_IndexersState.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/deleteIndexersRestoreState_response"
}
}
}
}
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"403": {
"description": "Forbidden \nThe caller is not allowed to complete this request."
},
"404": {
"description": "Not Found \nThe resource does not exist."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
},
"/v2/processInstances": {
"get": {
"deprecated": true,
"tags": [
"Tasks & Process Instances List"
],
"summary": "deprecated, use PUT /v1/instances instead.",
"description": "Use this method to retrieve a list of BPD process instance entities, ordered by ascending due date. \n\n **Note:** This API is deprecated, please use PUT /v1/instances instead",
"operationId": "federatedProcessInstances",
"parameters": [
{
"name": "systemID",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
The ID of a federated IBM BPM system. Use the ID to filter the results for a specific federated system.
systemID is a universally unique identifier (UUID), such as f1436904-793d-4a38-8c64-7634dbdae6f6.
Use the Process Federation Server /federated/v1/systems rest query to retrieve the systemID.
"
},
{
"name": "modifiedAfter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-01-01T08:30:00Z"
},
"description": "
Includes only process instances that were last updated after the specified date.
The date must be in ISO8601 format, such as 2011-08-04T03:12:53Z.
"
},
{
"name": "modifiedBefore",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-01-01T08:30:00Z"
},
"description": "
Includes only instances that were last updated before the specified date.
The date must be in ISO8601 format, such as 2011-08-04T03:12:53Z.
"
},
{
"name": "searchFilterScope",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"AppShortName",
"InstanceName",
"All"
]
},
"description": "
Specifies the scope of the search filter.
"
},
{
"name": "searchFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Includes either only instances with the specified name, or only the instances that belong to the process application with the specified short name, or the total of both types of searches.
The searchFilterScope parameter specifies which type of search to perform.
"
},
{
"name": "statusFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Returns the instances that have only the specified status.
The list of status values is: Active, Completed, Failed, Terminated, Suspended, Did_not_Start.
To specify more than one status value, separate the values with a comma, like this: Active,Suspended,Did_not_Start
"
},
{
"name": "projectFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"description": "
Returns the instances for the specified projects, identified by their acronyms (short names).
To specify more than one project, separate each one with a comma like this: APP1,APP2
"
},
{
"name": "processTypeFilter",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"Workstream",
"Workflow"
]
},
"description": ""
},
{
"name": "includeBusinessData",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
},
"description": "
Should the business data of the process instance be returned in the response ?
If set to \"true\", the response will include the business data of each process instance.
"
},
{
"name": "size",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
Specifies the maximum number of entities to be returned at once.
If this parameter is not specified, 25 is used as the default value.
"
},
{
"name": "offset",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"description": "
Specifies the index (origin 0) of the first entity in the query result set. Offset 0 refers to the first entity in the result set; offset 1 to the second entity, and so on. If this parameter is not specified, 0 is used as the default value.
Use this parameter with the size parameter to provide paging in the task list.
"
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"$ref": "schemas/FEDERATED_ProcessInstance.json"
},
"examples": {
"Example": {
"$ref": "#/components/examples/processInstanceAll_response"
}
}
}
}
},
"400": {
"description": "Bad Request \nThe parameters are not valid or they are missing."
},
"401": {
"description": "Unauthorized \nThe caller is not authorized for this request."
},
"406": {
"description": "Not Acceptable \nThe requested content type or content encoding is not supported."
},
"500": {
"description": "Internal Server Error \nA severe problem occurred."
},
"503": {
"description": "Service Unavailable \nThe federated request could not be delivered to individual federation targets."
},
"504": {
"description": "Gateway Timeout \nThe federated response has partial content because of missing individual responses."
}
}
}
}
},
"components": {
"schemas": {},
"examples": {
"ongoingReusableSearchQueriesImportStatus_response": {
"value": {
"expiration": "2024-04-25T08:42:12Z",
"logs": [
"CWMFS4191I: Search queries transfer started at 2024-04-25T08:40:08Z by uid=fdadmin,o=defaultWIMFileBasedRealm",
"CWMFS4192I: 6 saved searches have been found and are candidate for transfer as reusable search queries.",
"CWMFS4193I: Saved search with id 5 and name MySavedSearch6 has been successfully transfered as a reusable search query.",
"CWMFS4193I: Saved search with id 1 and name MySavedSearch2 has been successfully transfered as a reusable search query."
],
"status": "started"
}
},
"completedReusableSearchQueriesImportStatus_response": {
"value": {
"expiration": "2024-04-25T08:42:18Z",
"logs": [
"CWMFS4191I: Search queries transfer started at 2024-04-25T08:40:08Z by uid=fdadmin,o=defaultWIMFileBasedRealm",
"CWMFS4192I: 6 saved searches have been found and are candidate for transfer as reusable search queries.",
"CWMFS4193I: Saved search with id 5 and name MySavedSearch6 has been successfully transfered as a reusable search query.",
"CWMFS4193I: Saved search with id 1 and name MySavedSearch2 has been successfully transfered as a reusable search query.",
"CWMFS4193I: Saved search with id 6 and name MySavedSearch7 has been successfully transfered as a reusable search query.",
"CWMFS4193I: Saved search with id 2 and name MySavedSearch3 has been successfully transfered as a reusable search query.",
"CWMFS4193I: Saved search with id 3 and name MySavedSearch4 has been successfully transfered as a reusable search query.",
"CWMFS4193I: Saved search with id 4 and name MySavedSearch5 has been successfully transfered as a reusable search query.",
"CWMFS4195I: Search queries transfer terminated at 2024-04-25T08:40:18Z: 6 saved searches successfully transfered, 0 saved searches not transfered because of errors, 0 saved searches not processed."
],
"status": "completed"
}
},
"LaunchableEntities": {
"value": {
"federationResult": [
{
"statusCode": 200,
"taskCompletionUrlPrefix": "http://server1.com:9080/teamworks",
"restUrlPrefix": "http://server1.com:9080/rest/bpm/wle",
"systemType": "SYSTEM_TYPE_WLE",
"systemID": "e6bbf3c5-8e32-49d5-9eb2-e51a2ed2b6c9",
"version": "8.5.6.0"
},
{
"statusCode": 200,
"taskCompletionUrlPrefix": "http://server1.com:9080/teamworks",
"restUrlPrefix": "http://server1.com:9080/rest/service",
"systemType": "SYSTEM_TYPE_WPS",
"systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
"version": "8.5.6.0"
},
{
"statusCode": 200,
"taskCompletionUrlPrefix": "http://server3.com:9080/teamworks",
"restUrlPrefix": "http://server3.com:9080/rest/service",
"systemType": "SYSTEM_TYPE_WPS",
"systemID": "_PK:9023014a.34687eb0.f14991f6.e4560002",
"version": "8.0.1.3"
}
],
"items": [
{
"snapshotID": "2064.d80f6e56-4dc6-4e7e-84bd-4c7ba19b0445",
"itemID": "1.db28b2da-d2c8-4e4f-9a37-a61dce8daaea",
"processAppName": "StartableServiceApp",
"isMobileReady": false,
"snapshotCreatedOn": "2015-01-13T20:38:19Z",
"display": "StartableService",
"type": "service",
"systemType": "SYSTEM_TYPE_WLE",
"launchableEntityType": "SERVICE",
"startURL": "http://server1.com:9080/teamworks/executeServiceByName?processApp=SSAPP&serviceName=StartableService&snapshot=snap1",
"tip": true,
"processAppID": "2066.b256a64e-e72e-4507-8459-e214dfa4ba50",
"branchID": "2063.12178505-316f-4fe1-a45a-10360da8dcc5",
"isDefault": false,
"snapshotName": "snap1",
"subtype": "startable_service",
"itemReference": "/1.db28b2da-d2c8-4e4f-9a37-a61dce8daaea",
"ID": "2015.103",
"branchName": "Main",
"systemID": "e6bbf3c5-8e32-49d5-9eb2-e51a2ed2b6c9",
"processAppAcronym": "SSAPP"
},
{
"snapshotID": "2064.95c9fb3c-e4a2-48af-91df-dbcda7a90a17",
"itemID": "1.36bdcc65-8d6a-4635-85cf-57cab68a7e45",
"processAppName": "Process Portal",
"isMobileReady": false,
"snapshotCreatedOn": "2014-12-24T09:55:02Z",
"display": "Process Diagram",
"type": "service",
"systemType": "SYSTEM_TYPE_WLE",
"launchableEntityType": "SERVICE",
"startURL": "http://server1.com:9080/teamworks/executecf?modelID=1.36bdcc65-8d6a-4635-85cf-57cab68a7e45&branchID=2063.34a0ce6e-631b-465d-b0dc-414c39fb893f",
"tip": true,
"processAppID": "2066.23d3ecec-6fdb-4033-9c57-e931aa13761f",
"branchID": "2063.34a0ce6e-631b-465d-b0dc-414c39fb893f",
"isDefault": false,
"snapshotName": "8.5.6.0",
"subtype": "url",
"itemReference": "/1.36bdcc65-8d6a-4635-85cf-57cab68a7e45",
"ID": "2015.18",
"branchName": "Main",
"systemID": "e6bbf3c5-8e32-49d5-9eb2-e51a2ed2b6c9",
"processAppAcronym": "TWP"
},
{
"snapshotID": "2064.5327bc35-5faa-4052-9317-d2a4b6e96a28",
"itemID": "25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"processAppName": "Hiring Sample",
"isMobileReady": false,
"snapshotCreatedOn": "2014-11-27T16:19:33Z",
"display": "Standard HR Open New Position",
"type": "process",
"systemType": "SYSTEM_TYPE_WLE",
"launchableEntityType": "PROCESS",
"startURL": "http://server1.com:9080/rest/bpm/wle/v1/process?action=start&bpdId=25.c904b3b1-afc1-4698-bf5a-a20892c20275&branchId=2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"tip": true,
"processAppID": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"branchID": "2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"isDefault": false,
"snapshotName": "Standard Hiring Sample v8560",
"itemReference": "/25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"ID": "2015.37",
"branchName": "Main",
"systemID": "e6bbf3c5-8e32-49d5-9eb2-e51a2ed2b6c9",
"processAppAcronym": "HSS"
},
{
"snapshotID": "2064.95c9fb3c-e4a2-48af-91df-dbcda7a90a17",
"itemID": "1.8447c77c-5a1f-4170-8846-f1b517c47446",
"processAppName": "Process Portal",
"isMobileReady": false,
"snapshotCreatedOn": "2014-12-24T09:55:02Z",
"display": "Process Performance",
"type": "service",
"systemType": "SYSTEM_TYPE_WLE",
"launchableEntityType": "SERVICE",
"startURL": "http://server1.com:9080/teamworks/executeServiceByName?processApp=TWP&serviceName=Process+Performance&snapshot=8.5.6.0&zResumable=true",
"tip": true,
"processAppID": "2066.23d3ecec-6fdb-4033-9c57-e931aa13761f",
"title": "Process Performance",
"branchID": "2063.34a0ce6e-631b-465d-b0dc-414c39fb893f",
"isDefault": false,
"snapshotName": "8.5.6.0",
"subtype": "dashboard",
"itemReference": "/1.8447c77c-5a1f-4170-8846-f1b517c47446",
"ID": "2015.21",
"branchName": "Main",
"systemID": "e6bbf3c5-8e32-49d5-9eb2-e51a2ed2b6c9",
"processAppAcronym": "TWP"
},
{
"snapshotID": "2064.95c9fb3c-e4a2-48af-91df-dbcda7a90a17",
"itemID": "1.50c2c62e-888d-4e29-912c-240a1c46d0a1",
"processAppName": "Process Portal",
"isMobileReady": false,
"snapshotCreatedOn": "2014-12-24T09:55:02Z",
"display": "Team Performance",
"type": "service",
"systemType": "SYSTEM_TYPE_WLE",
"launchableEntityType": "SERVICE",
"startURL": "http://server1.com:9080/teamworks/executeServiceByName?processApp=TWP&serviceName=Team+Performance&snapshot=8.5.6.0&zResumable=true",
"tip": true,
"processAppID": "2066.23d3ecec-6fdb-4033-9c57-e931aa13761f",
"title": "Team Performance",
"branchID": "2063.34a0ce6e-631b-465d-b0dc-414c39fb893f",
"isDefault": false,
"snapshotName": "8.5.6.0",
"subtype": "dashboard",
"itemReference": "/1.50c2c62e-888d-4e29-912c-240a1c46d0a1",
"ID": "2015.19",
"branchName": "Main",
"systemID": "e6bbf3c5-8e32-49d5-9eb2-e51a2ed2b6c9",
"processAppAcronym": "TWP"
},
{
"snapshotID": "2064.95c9fb3c-e4a2-48af-91df-dbcda7a90a17",
"itemID": "1.7ba7ed4c-8928-4dcd-8d8a-55fd6b531de1",
"processAppName": "Process Portal",
"isMobileReady": false,
"snapshotCreatedOn": "2014-12-24T09:55:02Z",
"display": "Processes",
"type": "service",
"systemType": "SYSTEM_TYPE_WLE",
"launchableEntityType": "SERVICE",
"startURL": "http://server1.com:9080/teamworks/executecf?modelID=1.7ba7ed4c-8928-4dcd-8d8a-55fd6b531de1&branchID=2063.34a0ce6e-631b-465d-b0dc-414c39fb893f&zResumable=true",
"tip": true,
"processAppID": "2066.23d3ecec-6fdb-4033-9c57-e931aa13761f",
"title": "Processes",
"branchID": "2063.34a0ce6e-631b-465d-b0dc-414c39fb893f",
"isDefault": false,
"snapshotName": "8.5.6.0",
"subtype": "dashboard",
"itemReference": "/1.7ba7ed4c-8928-4dcd-8d8a-55fd6b531de1",
"ID": "2015.20",
"branchName": "Main",
"systemID": "e6bbf3c5-8e32-49d5-9eb2-e51a2ed2b6c9",
"processAppAcronym": "TWP"
},
{
"toolkitSnapshotID": null,
"topLevelToolkitAcronym": null,
"trackName": null,
"type": null,
"calendarName": null,
"isTip": false,
"namespace": "http://com.ibm.htm.predefined",
"supportsDelegation": true,
"validFromTime": "2012-02-02T01:00:00Z",
"autonomy": "AUTONOMY_PEER",
"assignmentType": "ASSIGNMENT_TYPE_SINGLE",
"toolkitSnapshotName": null,
"snapshotName": null,
"description": "%htm:task.originator% requests your approval",
"priority": 5,
"supportsSubTasks": true,
"durationUntilDeleted": "DURATION_INFINITE",
"supportsAutomaticClaim": true,
"substitutionPolicy": "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"topLevelToolkitName": null,
"eventHandlerName": null,
"systemType": "SYSTEM_TYPE_WPS",
"launchableEntityType": "COLLABORATION_TASK",
"jndiNameOfCalendar": null,
"processAppName": null,
"clientTypes": [
"Dojo"
],
"customProperties": {
"htm_isPredefinedTask": "true",
"htm_assigned_to": ""
},
"isAdHoc": false,
"supportsClaimIfSuspended": false,
"systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
"contextAuthorizationOfOwner": "AUTH_NONE",
"priorityDefinition": "5",
"state": "STATE_STARTED",
"kind": "KIND_HUMAN",
"definitionNamespace": "http://com.ibm.htm.predefined",
"containmentContextID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"name": "Approval_Request",
"workBasketName": null,
"processAppAcronym": null,
"isBusinessRelevant": false,
"durationUntilDue": null,
"snapshotID": null,
"customText7": null,
"customText6": null,
"customText8": null,
"applicationName": "HTM_PredefinedTasks_V8000_SingleCluster",
"autoDeletionMode": "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION",
"customText3": null,
"inheritedAuthorization": "INHERITED_AUTH_ALL",
"customText2": null,
"isInline": false,
"customText5": null,
"customText4": null,
"durationUntilExpires": null,
"customText1": null,
"definitionName": "Approval_Request",
"toolkitAcronym": null,
"toolkitName": null,
"applicationDefaultsID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"jndiNameOfStaffPluginProvider": "bpe/staff/samplevmmconfiguration",
"displayName": "Approval",
"supportsFollowOnTasks": true,
"tktid": "_TKT:a01a014a.7bc3cedf.94078ff6.2ad30003"
},
{
"toolkitSnapshotID": null,
"topLevelToolkitAcronym": null,
"trackName": null,
"type": null,
"calendarName": null,
"isTip": false,
"namespace": "http://com.ibm.htm.predefined",
"supportsDelegation": true,
"validFromTime": "2012-02-02T01:00:00Z",
"autonomy": "AUTONOMY_PEER",
"assignmentType": "ASSIGNMENT_TYPE_SINGLE",
"toolkitSnapshotName": null,
"snapshotName": null,
"description": "%htm:task.originator% gives you a to-do: %htm:input.\\request/title%",
"priority": 5,
"supportsSubTasks": true,
"durationUntilDeleted": "DURATION_INFINITE",
"supportsAutomaticClaim": true,
"substitutionPolicy": "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"topLevelToolkitName": null,
"eventHandlerName": null,
"systemType": "SYSTEM_TYPE_WPS",
"launchableEntityType": "INVOCATION_TASK",
"jndiNameOfCalendar": null,
"processAppName": null,
"clientTypes": [
"Dojo"
],
"customProperties": {
"htm_isPredefinedTask": "true",
"htm_assigned_to": ""
},
"isAdHoc": false,
"supportsClaimIfSuspended": false,
"systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
"contextAuthorizationOfOwner": "AUTH_NONE",
"priorityDefinition": "5",
"state": "STATE_STARTED",
"kind": "KIND_HUMAN",
"definitionNamespace": "http://com.ibm.htm.predefined",
"containmentContextID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"name": "Todo",
"workBasketName": null,
"processAppAcronym": null,
"isBusinessRelevant": false,
"durationUntilDue": null,
"snapshotID": null,
"customText7": null,
"customText6": null,
"customText8": null,
"applicationName": "HTM_PredefinedTasks_V8000_SingleCluster",
"autoDeletionMode": "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION",
"customText3": null,
"inheritedAuthorization": "INHERITED_AUTH_ALL",
"customText2": null,
"isInline": false,
"customText5": null,
"customText4": null,
"durationUntilExpires": null,
"customText1": null,
"definitionName": "Todo",
"toolkitAcronym": null,
"toolkitName": null,
"applicationDefaultsID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"jndiNameOfStaffPluginProvider": "bpe/staff/samplevmmconfiguration",
"displayName": "To-do",
"supportsFollowOnTasks": true,
"tktid": "_TKT:a01a014a.7bc3df6b.94078ff6.2ad30012"
},
{
"toolkitSnapshotID": null,
"topLevelToolkitAcronym": null,
"trackName": null,
"type": null,
"calendarName": null,
"isTip": false,
"namespace": "http://com.ibm.htm.predefined",
"supportsDelegation": true,
"validFromTime": "2012-02-02T01:00:00Z",
"autonomy": "AUTONOMY_PEER",
"assignmentType": "ASSIGNMENT_TYPE_SINGLE",
"toolkitSnapshotName": null,
"snapshotName": null,
"description": "\"%htm:input.\\request/subject%\" message from %htm:task.originator%",
"priority": 5,
"supportsSubTasks": true,
"durationUntilDeleted": "DURATION_INFINITE",
"supportsAutomaticClaim": true,
"substitutionPolicy": "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"topLevelToolkitName": null,
"eventHandlerName": null,
"systemType": "SYSTEM_TYPE_WPS",
"launchableEntityType": "PROCESS",
"jndiNameOfCalendar": null,
"processAppName": null,
"clientTypes": [
"Dojo"
],
"customProperties": {
"htm_isHidden": "true",
"htm_isPredefinedTask": "true",
"htm_assigned_to": ""
},
"isAdHoc": false,
"supportsClaimIfSuspended": false,
"systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
"contextAuthorizationOfOwner": "AUTH_NONE",
"priorityDefinition": "5",
"state": "STATE_STARTED",
"kind": "KIND_HUMAN",
"definitionNamespace": "http://com.ibm.htm.predefined",
"containmentContextID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"name": "Message",
"workBasketName": null,
"processAppAcronym": null,
"isBusinessRelevant": false,
"durationUntilDue": null,
"snapshotID": null,
"customText7": null,
"customText6": null,
"customText8": null,
"applicationName": "HTM_PredefinedTaskMsg_V8000_SingleCluster",
"autoDeletionMode": "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION",
"customText3": null,
"inheritedAuthorization": "INHERITED_AUTH_ALL",
"customText2": null,
"isInline": false,
"customText5": null,
"customText4": null,
"durationUntilExpires": null,
"customText1": null,
"definitionName": "Message",
"toolkitAcronym": null,
"toolkitName": null,
"applicationDefaultsID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"jndiNameOfStaffPluginProvider": "bpe/staff/samplevmmconfiguration",
"displayName": "Widget Message",
"supportsFollowOnTasks": true,
"tktid": "_TKT:a01a014a.7bc4b9d0.94078ff6.2ad30017"
},
{
"toolkitSnapshotID": null,
"topLevelToolkitAcronym": null,
"trackName": null,
"type": null,
"calendarName": null,
"isTip": false,
"namespace": "http://advhtpatterns",
"supportsDelegation": false,
"validFromTime": "2014-12-24T12:23:30Z",
"autonomy": "AUTONOMY_PEER",
"assignmentType": "ASSIGNMENT_TYPE_SINGLE",
"toolkitSnapshotName": null,
"snapshotName": null,
"description": null,
"priority": 5,
"supportsSubTasks": false,
"durationUntilDeleted": "DURATION_INFINITE",
"supportsAutomaticClaim": false,
"substitutionPolicy": "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"topLevelToolkitName": null,
"eventHandlerName": null,
"systemType": "SYSTEM_TYPE_WPS",
"launchableEntityType": "PROCESS",
"jndiNameOfCalendar": null,
"processAppName": null,
"clientTypes": [
"Dojo"
],
"customProperties": {},
"isAdHoc": false,
"supportsClaimIfSuspended": false,
"systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
"contextAuthorizationOfOwner": "AUTH_NONE",
"priorityDefinition": "5",
"state": "STATE_STARTED",
"kind": "KIND_ORIGINATING",
"definitionNamespace": "http://advhtpatterns",
"containmentContextID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"name": "InitiateAuthorizeOrder",
"workBasketName": null,
"processAppAcronym": null,
"isBusinessRelevant": false,
"durationUntilDue": null,
"snapshotID": null,
"customText7": null,
"customText6": null,
"customText8": null,
"applicationName": "advhtpatterns_1App",
"autoDeletionMode": "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION",
"customText3": null,
"inheritedAuthorization": "INHERITED_AUTH_ALL",
"customText2": null,
"isInline": false,
"customText5": null,
"customText4": null,
"durationUntilExpires": null,
"customText1": null,
"definitionName": "InitiateAuthorizeOrder",
"toolkitAcronym": null,
"toolkitName": null,
"applicationDefaultsID": "_ACO:a01c014a.7bc3bebd.94078ff6.2ad30001",
"jndiNameOfStaffPluginProvider": "bpe/staff/samplevmmconfiguration",
"displayName": "InitiateAuthorizeOrder",
"supportsFollowOnTasks": false,
"tktid": "_TKT:a01a014a.7c416209.c9078ff6.ba8900be"
},
{
"toolkitSnapshotID": null,
"topLevelToolkitAcronym": null,
"trackName": null,
"type": null,
"calendarName": null,
"isTip": false,
"namespace": "http://com.ibm.htm.predefined",
"supportsDelegation": true,
"validFromTime": "2012-02-02T01:00:00Z",
"assignmentType": "ASSIGNMENT_TYPE_SINGLE",
"toolkitSnapshotName": null,
"autonomy": "AUTONOMY_PEER",
"description": "%htm:task.originator% requests your approval",
"snapshotName": null,
"priority": 5,
"supportsAutomaticClaim": true,
"durationUntilDeleted": "DURATION_INFINITE",
"supportsSubTasks": true,
"substitutionPolicy": "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"topLevelToolkitName": null,
"eventHandlerName": null,
"systemType": "SYSTEM_TYPE_WPS",
"launchableEntityType": "COLLABORATION_TASK",
"jndiNameOfCalendar": null,
"processAppName": null,
"clientTypes": [
"Dojo"
],
"customProperties": {
"htm_isPredefinedTask": "true",
"htm_assigned_to": ""
},
"isAdHoc": false,
"supportsClaimIfSuspended": false,
"systemID": "_PK:9023014a.34687eb0.f14991f6.e4560002",
"contextAuthorizationOfOwner": "AUTH_NONE",
"priorityDefinition": "5",
"state": "STATE_STARTED",
"kind": "KIND_HUMAN",
"definitionNamespace": "http://com.ibm.htm.predefined",
"containmentContextID": "_ACO:a01c014a.34687ea5.f14991f6.e4560001",
"name": "Approval_Request",
"processAppAcronym": null,
"workBasketName": null,
"isBusinessRelevant": false,
"durationUntilDue": null,
"snapshotID": null,
"customText7": null,
"customText6": null,
"applicationName": "HTM_PredefinedTasks_V8000_BPM.AppTarget",
"customText8": null,
"autoDeletionMode": "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION",
"customText3": null,
"inheritedAuthorization": "INHERITED_AUTH_ALL",
"customText2": null,
"isInline": false,
"customText5": null,
"customText4": null,
"durationUntilExpires": null,
"customText1": null,
"definitionName": "Approval_Request",
"toolkitAcronym": null,
"toolkitName": null,
"jndiNameOfStaffPluginProvider": "bpe/staff/samplevmmconfiguration",
"applicationDefaultsID": "_ACO:a01c014a.34687ea5.f14991f6.e4560001",
"displayName": "Approval",
"tktid": "_TKT:a01a014a.3468dd7d.f14991f6.e4560003",
"supportsFollowOnTasks": true
},
{
"toolkitSnapshotID": null,
"topLevelToolkitAcronym": null,
"trackName": null,
"type": null,
"calendarName": null,
"isTip": false,
"namespace": "http://com.ibm.htm.predefined",
"supportsDelegation": true,
"validFromTime": "2012-02-02T01:00:00Z",
"assignmentType": "ASSIGNMENT_TYPE_SINGLE",
"toolkitSnapshotName": null,
"autonomy": "AUTONOMY_PEER",
"description": "\"%htm:input.\\request/subject%\" message from %htm:task.originator%",
"snapshotName": null,
"priority": 5,
"supportsAutomaticClaim": true,
"durationUntilDeleted": "DURATION_INFINITE",
"supportsSubTasks": true,
"substitutionPolicy": "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"topLevelToolkitName": null,
"eventHandlerName": null,
"systemType": "SYSTEM_TYPE_WPS",
"launchableEntityType": "COLLABORATION_TASK",
"jndiNameOfCalendar": null,
"processAppName": null,
"clientTypes": [
"Dojo"
],
"customProperties": {
"htm_isHidden": "true",
"htm_isPredefinedTask": "true",
"htm_assigned_to": ""
},
"isAdHoc": false,
"supportsClaimIfSuspended": false,
"systemID": "_PK:9023014a.34687eb0.f14991f6.e4560002",
"contextAuthorizationOfOwner": "AUTH_NONE",
"priorityDefinition": "5",
"state": "STATE_STARTED",
"kind": "KIND_HUMAN",
"definitionNamespace": "http://com.ibm.htm.predefined",
"containmentContextID": "_ACO:a01c014a.34687ea5.f14991f6.e4560001",
"name": "Message",
"processAppAcronym": null,
"workBasketName": null,
"isBusinessRelevant": false,
"durationUntilDue": null,
"snapshotID": null,
"customText7": null,
"customText6": null,
"applicationName": "HTM_PredefinedTaskMsg_V8000_BPM.AppTarget",
"customText8": null,
"autoDeletionMode": "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION",
"customText3": null,
"inheritedAuthorization": "INHERITED_AUTH_ALL",
"customText2": null,
"isInline": false,
"customText5": null,
"customText4": null,
"durationUntilExpires": null,
"customText1": null,
"definitionName": "Message",
"toolkitAcronym": null,
"toolkitName": null,
"jndiNameOfStaffPluginProvider": "bpe/staff/samplevmmconfiguration",
"applicationDefaultsID": "_ACO:a01c014a.34687ea5.f14991f6.e4560001",
"displayName": "Widget Message",
"tktid": "_TKT:a01a014a.346911f6.f14991f6.e4560017",
"supportsFollowOnTasks": true
},
{
"toolkitSnapshotID": null,
"topLevelToolkitAcronym": null,
"trackName": null,
"type": null,
"calendarName": null,
"isTip": false,
"namespace": "http://advhtpatterns",
"supportsDelegation": false,
"validFromTime": "2014-12-11T13:42:23Z",
"assignmentType": "ASSIGNMENT_TYPE_SINGLE",
"toolkitSnapshotName": null,
"autonomy": "AUTONOMY_PEER",
"description": null,
"snapshotName": null,
"priority": 5,
"supportsAutomaticClaim": false,
"durationUntilDeleted": "DURATION_INFINITE",
"supportsSubTasks": false,
"substitutionPolicy": "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"topLevelToolkitName": null,
"eventHandlerName": null,
"systemType": "SYSTEM_TYPE_WPS",
"launchableEntityType": "COLLABORATION_TASK",
"jndiNameOfCalendar": null,
"processAppName": null,
"clientTypes": [
"Dojo"
],
"customProperties": {},
"isAdHoc": false,
"supportsClaimIfSuspended": false,
"systemID": "_PK:9023014a.34687eb0.f14991f6.e4560002",
"contextAuthorizationOfOwner": "AUTH_NONE",
"priorityDefinition": "5",
"state": "STATE_STARTED",
"kind": "KIND_ORIGINATING",
"definitionNamespace": "http://advhtpatterns",
"containmentContextID": "_ACO:a01c014a.34687ea5.f14991f6.e4560001",
"name": "InitiateAuthorizeOrder",
"processAppAcronym": null,
"workBasketName": null,
"isBusinessRelevant": false,
"durationUntilDue": null,
"snapshotID": null,
"customText7": null,
"customText6": null,
"applicationName": "advhtpatterns_1App",
"customText8": null,
"autoDeletionMode": "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION",
"customText3": null,
"inheritedAuthorization": "INHERITED_AUTH_ALL",
"customText2": null,
"isInline": false,
"customText5": null,
"customText4": null,
"durationUntilExpires": null,
"customText1": null,
"definitionName": "InitiateAuthorizeOrder",
"toolkitAcronym": null,
"toolkitName": null,
"jndiNameOfStaffPluginProvider": "bpe/staff/samplevmmconfiguration",
"applicationDefaultsID": "_ACO:a01c014a.34687ea5.f14991f6.e4560001",
"displayName": "InitiateAuthorizeOrder",
"tktid": "_TKT:a01a014a.39973668.f14991f6.5d53010c",
"supportsFollowOnTasks": false
}
]
}
},
"InstancesAll": {
"value": {
"attributeInfo": [
{
"sourceQueryTableIdentifier": "n/a",
"name": "PROCESS_APP_ACRONYM",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceProcessApp",
"content": "process.processappacronym.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_PIID",
"isArray": false,
"type": "ID",
"sourceAttribute": "instanceId",
"content": "instance.piid.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_DUE",
"isArray": false,
"type": "TIMESTAMP",
"sourceAttribute": "instanceDueDate",
"content": "instance.duetime.date"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceName",
"content": "instance.processinstancename.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "SNAPSHOT_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceSnapshot",
"content": "instance.snapshotname.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PT_NAME",
"isArray": false,
"type": "ID",
"sourceAttribute": "bpdName",
"content": "process.processtemplatename.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_STATUS",
"isArray": false,
"type": "ID",
"sourceAttribute": "instanceStatus",
"content": "instance.status.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PROCESS_INSTANCE.PIID",
"isArray": false,
"type": "ID",
"sourceAttribute": "instanceId",
"content": "instance.piid.key"
}
],
"totalCount": 1,
"offset": 0,
"queryExecuteTime": "2021-03-31T12:34:40Z",
"requestedSize": 25,
"identifier": "PROCESS_INSTANCE.PIID",
"query": null,
"federationResult": [
{
"restUrlPrefix": "http://baw-db21.mycompany.com:9080/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "http://baw-db21.mycompany.com:9080/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "http://baw-db21.mycompany.com:9080/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"size": 1,
"items": [
{
"SNAPSHOT_NAME": "VS_8600",
"PI_STATUS": "Active",
"PI_NAME": "Advanced Employee Requisition NG (List) for Roland Peisl (6528)",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"PI_DUE": "2021-04-02T12:23:34.924Z",
"PROCESS_APP_ACRONYM": "HSAV1",
"PROCESS_INSTANCE.PIID": "6528",
"PI_PIID": "6528",
"PT_NAME": "Advanced HR Open New Position"
}
],
"entityTypeName": "INSTANCE"
}
},
"GlobalTeams": {
"value": {
"teams": [
{
"teamId": "24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
"teamName": "Human Resources",
"processAppName": "Hiring Sample"
},
{
"teamId": "24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"teamName": "GeneralManagers",
"processAppName": "Hiring Sample"
},
{
"teamId": "24.cd97937f-06ab-43cc-8067-17dea489fdb3",
"teamName": "HiringManagers",
"processAppName": "Hiring Sample"
}
]
}
},
"meta_fields": {
"value": {
"result": [
{
"name": "assignedToRoleDisplayName",
"type": "String",
"kind": "System"
},
{
"name": "assignedToUser",
"type": "String",
"kind": "System"
},
{
"name": "bpdId",
"type": "String",
"kind": "System"
},
{
"name": "bpdName",
"type": "String",
"kind": "System"
},
{
"name": "caseIdentifier",
"type": "String",
"kind": "System"
},
{
"name": "caseProcessTypeLocation",
"type": "String",
"kind": "System"
},
{
"name": "caseTypeId",
"type": "String",
"kind": "System"
},
{
"name": "instanceAtRiskDate",
"type": "Date",
"kind": "System"
},
{
"name": "instanceCompletionDate",
"type": "Date",
"kind": "System"
},
{
"name": "instanceCreationDate",
"type": "Date",
"kind": "System"
},
{
"name": "instanceDueDate",
"type": "Date",
"kind": "System"
},
{
"name": "instanceId",
"type": "String",
"kind": "System"
},
{
"name": "instanceLastModificationDate",
"type": "Date",
"kind": "System"
},
{
"name": "instanceName",
"type": "String",
"kind": "System"
},
{
"name": "instanceProcessApp",
"type": "String",
"kind": "System"
},
{
"name": "instanceSnapshot",
"type": "String",
"kind": "System"
},
{
"name": "instanceSnapshotId",
"type": "String",
"kind": "System"
},
{
"name": "instanceStageStatus",
"type": "String",
"kind": "System"
},
{
"name": "instanceStatus",
"type": "String",
"kind": "System"
},
{
"name": "isWorkstream",
"type": "Boolean",
"kind": "System"
},
{
"name": "parentActivityId",
"type": "String",
"kind": "System"
},
{
"name": "parentCaseId",
"type": "String",
"kind": "System"
},
{
"name": "solutionTargetObjectStoreSymbolicName",
"type": "String",
"kind": "System"
},
{
"name": "taskActivityName",
"type": "String",
"kind": "System"
},
{
"name": "taskActivityType",
"type": "String",
"kind": "System"
},
{
"name": "taskAtRiskTime",
"type": "Date",
"kind": "System"
},
{
"name": "taskClosedDate",
"type": "Date",
"kind": "System"
},
{
"name": "taskDueDate",
"type": "Date",
"kind": "System"
},
{
"name": "taskId",
"type": "String",
"kind": "System"
},
{
"name": "taskIsAtRisk",
"type": "Boolean",
"kind": "System"
},
{
"name": "taskNarrative",
"type": "String",
"kind": "System"
},
{
"name": "taskPriority",
"type": "Integer",
"kind": "System"
},
{
"name": "taskReceivedDate",
"type": "Date",
"kind": "System"
},
{
"name": "taskState",
"type": "String",
"kind": "System"
},
{
"name": "taskStatus",
"type": "String",
"kind": "System"
},
{
"name": "taskSubject",
"type": "String",
"kind": "System"
},
{
"name": "workflowApplication",
"type": "String",
"kind": "System"
}
]
}
},
"meta_constraintFields": {
"value": {
"result": [
{
"name": "assignedToRoleDisplayName",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "assignedToUser",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "bpdId",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "bpdName",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "caseIdentifier",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "caseProcessTypeLocation",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "caseTypeId",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceAtRiskDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceCompletionDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceCreationDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceDueDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceId",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceLastModificationDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceName",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "instanceProcessApp",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "instanceSnapshot",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "instanceSnapshotId",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceStageStatus",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "instanceStatus",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "isWorkstream",
"type": "Boolean",
"kind": "System",
"full_text_searchable": false
},
{
"name": "parentActivityId",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "parentCaseId",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "solutionTargetObjectStoreSymbolicName",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskActivityName",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "taskActivityType",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskAtRiskTime",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskClosedDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskDueDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskId",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskIsAtRisk",
"type": "Boolean",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskNarrative",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "taskPriority",
"type": "Integer",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskReceivedDate",
"type": "Date",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskState",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskStatus",
"type": "String",
"kind": "System",
"full_text_searchable": false
},
{
"name": "taskSubject",
"type": "String",
"kind": "System",
"full_text_searchable": true
},
{
"name": "workflowApplication",
"type": "String",
"kind": "System",
"full_text_searchable": false
}
]
}
},
"meta_businessDataFields": {
"value": {
"result": [
{
"name": "myInstanceVariable",
"type": "String",
"kind": "Instance",
"duplicatedInOtherKind": false,
"full_text_searchable": true
},
{
"name": "myTaskVariable",
"type": "Integer",
"kind": "Task",
"duplicatedInOtherKind": false,
"full_text_searchable": false
},
{
"name": "myVariable",
"type": "String",
"kind": "Instance",
"duplicatedInOtherKind": true,
"full_text_searchable": true
},
{
"name": "myVariable",
"type": "Integer",
"kind": "Task",
"duplicatedInOtherKind": true,
"full_text_searchable": false
}
]
}
},
"savedSearchList_response": {
"value": {
"results": [
{
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"shared": false,
"organization": "byTask",
"name": "How do you like this one",
"id": 204
},
{
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"shared": true,
"organization": "byTask",
"name": "MySavedSearch",
"id": 202
},
{
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"shared": false,
"organization": "byTask",
"name": "Some other one",
"id": 203
}
]
}
},
"reusableSearchList_response": {
"value": {
"results": [
{
"metadata": {
"owner": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"creator": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"lastUpdateDate": "2024-02-20T12:45:28.924Z",
"lastUpdater": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"name": "my instances list",
"description": "A search query that returns my instances list",
"sharing": {
"shared": false
},
"creationDate": "2024-02-20T12:45:28.924Z"
},
"readonly": false,
"datatype": "INSTANCES",
"id": "2",
"systemTypes": [
"Process",
"Case"
]
},
{
"metadata": {
"owner": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"creator": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"lastUpdateDate": "2024-02-20T12:45:13.050Z",
"lastUpdater": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"name": "my tasks list",
"description": "1 search query that returns my tasks list",
"sharing": {
"shared": false
},
"creationDate": "2024-02-20T12:45:13.050Z"
},
"readonly": false,
"datatype": "TASKS",
"id": "1",
"systemTypes": [
"Process",
"BPEL"
]
}
]
}
},
"adhocTaskSearchQuery_V1": {
"value": {
"datasource": {
"datatype": "TASKS",
"systemTypes": [
"Process",
"BPEL"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": "taskPriority",
"operator": "LessThan",
"value": 50
},
{
"field": "amount",
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
"instanceProcessApp",
"amount"
],
"usersFullName": true,
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
},
{
"field": "taskPriority",
"order": "DESC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"adhocInstanceSearchQuery_V1": {
"value": {
"jsonFormat": "v1",
"datasource": {
"datatype": "INSTANCES",
"systemTypes": [
"Process",
"Case"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": "taskPriority",
"operator": "LessThan",
"value": 50
},
{
"field": "amount",
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
"instanceProcessApp",
"amount"
],
"usersFullName": true,
"sort": [
{
"field": "instanceDueDate",
"order": "ASC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"adhocTaskSearchQuery_V2": {
"value": {
"jsonFormat": "v2",
"datasource": {
"datatype": "TASKS",
"systemTypes": [
"Process",
"BPEL"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"operator": "LessThan",
"value": 50
},
{
"field": {
"name": "amount",
"kind": "Instance"
},
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
{
"name": "instanceProcessApp",
"kind": "System"
},
{
"name": "amount",
"kind": "Instance"
},
{
"name": "awaitingReview",
"kind": "Task"
}
],
"usersFullName": true,
"sort": [
{
"field": {
"name": "taskDueDate",
"kind": "System"
},
"order": "ASC"
},
{
"field": {
"name": "variable1",
"kind": "Instance"
},
"order": "DESC"
},
{
"field": {
"name": "variable2",
"kind": "Task"
},
"order": "DESC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"adhocInstanceSearchQuery_V2": {
"value": {
"jsonFormat": "v2",
"datasource": {
"datatype": "INSTANCES",
"systemTypes": [
"Process",
"Case"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"operator": "LessThan",
"value": 50
},
{
"field": {
"name": "amount",
"kind": "Instance"
},
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
{
"name": "instanceProcessApp",
"kind": "System"
},
{
"name": "amount",
"kind": "Instance"
},
{
"name": "awaitingReview",
"kind": "Task"
}
],
"usersFullName": true,
"sort": [
{
"field": {
"name": "instanceDueDate",
"kind": "System"
},
"order": "ASC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"adhocTaskSearchQueryWithMetadata_V1": {
"value": {
"metadata": {
"name": "my tasks list",
"description": "A search query that returns my tasks list",
"sharing": {
"shared": false
}
},
"datasource": {
"datatype": "TASKS",
"systemTypes": [
"Process",
"BPEL"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": "taskPriority",
"operator": "LessThan",
"value": 50
},
{
"field": "amount",
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
"instanceProcessApp",
"amount"
],
"usersFullName": true,
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
},
{
"field": "taskPriority",
"order": "DESC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"adhocInstanceSearchQueryWithMetadata_V1": {
"value": {
"metadata": {
"name": "my instances list",
"description": "a search query that returns my instances list",
"sharing": {
"shared": false
}
},
"datasource": {
"datatype": "INSTANCES",
"systemTypes": [
"Process",
"Case"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": "taskPriority",
"operator": "LessThan",
"value": 50
},
{
"field": "amount",
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
"instanceProcessApp",
"amount"
],
"usersFullName": true,
"sort": [
{
"field": "instanceDueDate",
"order": "ASC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"adhocTaskSearchQueryWithMetadata_V2": {
"value": {
"jsonFormat": "v2",
"metadata": {
"name": "my tasks list",
"description": "A search query that returns my tasks list",
"sharing": {
"shared": false
}
},
"datasource": {
"datatype": "TASKS",
"systemTypes": [
"Process",
"BPEL"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"operator": "LessThan",
"value": 50
},
{
"field": {
"name": "amount",
"kind": "Instance"
},
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
{
"name": "instanceProcessApp",
"kind": "System"
},
{
"name": "amount",
"kind": "Instance"
},
{
"name": "awaitingReview",
"kind": "Task"
}
],
"usersFullName": true,
"sort": [
{
"field": {
"name": "taskDueDate",
"kind": "System"
},
"order": "ASC"
},
{
"field": {
"name": "variable1",
"kind": "Instance"
},
"order": "DESC"
},
{
"field": {
"name": "variable2",
"kind": "Task"
},
"order": "DESC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"adhocInstanceSearchQueryWithMetadata_V2": {
"value": {
"jsonFormat": "v2",
"metadata": {
"name": "my instances list",
"description": "a search query that returns my instances list",
"sharing": {
"shared": false
}
},
"datasource": {
"datatype": "INSTANCES",
"systemTypes": [
"Process",
"Case"
]
},
"population": {
"target": "SELF"
},
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"operator": "LessThan",
"value": 50
},
{
"field": {
"name": "amount",
"kind": "Instance"
},
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"output": {
"includeAllBusinessData": false,
"fields": [
{
"name": "instanceProcessApp",
"kind": "System"
},
{
"name": "amount",
"kind": "Instance"
},
{
"name": "awaitingReview",
"kind": "Task"
}
],
"usersFullName": true,
"sort": [
{
"field": {
"name": "instanceDueDate",
"kind": "System"
},
"order": "ASC"
}
],
"alphabeticalSort": false,
"size": 25,
"stats": {
"type": "Basic"
}
}
}
},
"savedSearchMeta_request": {
"value": {
"shared": true,
"teams": [
{
"teamId": "24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"teamName": "GeneralManagers",
"processAppName": "Hiring Sample"
}
],
"size": 25,
"organization": "byTask",
"name": "MySavedSearch",
"interaction": "claimed_and_available",
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"conditions": [
{
"field": "taskDueDate",
"value": "2016-03-02T05:00:00.000Z",
"operator": "LessThan"
}
],
"fields": [
"taskDueDate",
"taskId",
"taskSubject",
"taskStatus",
"taskPriority",
"taskIsAtRisk",
"taskAtRiskTime",
"taskClosedDate",
"taskActivityName",
"assignedToUser",
"assignedToRoleDisplayName",
"instanceName",
"instanceId",
"instanceStatus",
"instanceProcessApp",
"instanceSnapshot",
"bpdName",
"department",
"gmApproval",
"hiringManager",
"location"
]
}
},
"reusableSearchMeta_response_V1": {
"value": {
"jsonFormat": "v1",
"output": {
"alphabeticalSort": false,
"size": 25,
"includeAllBusinessData": false,
"fields": [
"instanceProcessApp",
"amount"
],
"stats": {
"type": "Basic"
},
"usersFullName": true,
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
},
{
"field": "taskPriority",
"order": "DESC"
}
]
},
"metadata": {
"owner": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"creator": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"lastUpdateDate": "2024-02-20T13:09:02.662Z",
"lastUpdater": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"name": "my tasks list",
"description": "a search query that returns my tasks list",
"sharing": {
"shared": false
},
"creationDate": "2024-02-20T13:09:02.662Z"
},
"datasource": {
"datatype": "TASKS",
"systemFilter": {
"excludes": [],
"includes": []
},
"systemTypes": [
"Process",
"BPEL"
]
},
"id": "1",
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": "taskPriority",
"operator": "LessThan",
"value": 50
},
{
"field": "amount",
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"population": {
"target": "SELF"
}
}
},
"reusableSearchMeta_response_V2": {
"value": {
"jsonFormat": "v2",
"output": {
"alphabeticalSort": false,
"size": 25,
"includeAllBusinessData": false,
"fields": [
{
"name": "instanceProcessApp",
"kind": "System"
},
{
"name": "amount",
"kind": "Instance"
},
{
"name": "awaitingReview",
"kind": "Task"
}
],
"stats": {
"type": "Basic"
},
"usersFullName": true,
"sort": [
{
"field": {
"name": "taskDueDate",
"kind": "System"
},
"order": "ASC"
},
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"order": "DESC"
}
]
},
"metadata": {
"owner": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"creator": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"lastUpdateDate": "2024-02-20T13:09:02.662Z",
"lastUpdater": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"name": "my tasks list",
"description": "a search query that returns my tasks list",
"sharing": {
"shared": false
},
"creationDate": "2024-02-20T13:09:02.662Z"
},
"datasource": {
"datatype": "TASKS",
"systemFilter": {
"excludes": [],
"includes": []
},
"systemTypes": [
"Process",
"BPEL"
]
},
"id": "1",
"filters": {
"interaction": "all",
"json_query": {
"and": [
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"operator": "LessThan",
"value": 50
},
{
"field": {
"name": "amount",
"kind": "Instance"
},
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"population": {
"target": "SELF"
}
}
},
"reusableSearchUpdateMeta_response_V1": {
"value": {
"jsonFormat": "v1",
"output": {
"alphabeticalSort": false,
"size": 25,
"includeAllBusinessData": false,
"fields": [
"instanceProcessApp",
"amount"
],
"stats": {
"type": "Basic"
},
"usersFullName": true,
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
},
{
"field": "taskPriority",
"order": "DESC"
}
]
},
"metadata": {
"owner": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"creator": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"lastUpdateDate": "2024-02-20T15:24:16.554Z",
"lastUpdater": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"name": "my tasks list",
"description": "a search query that returns my tasks list",
"sharing": {
"shared": false
},
"creationDate": "2024-02-20T13:09:02.662Z"
},
"datasource": {
"datatype": "TASKS",
"systemFilter": {
"excludes": [],
"includes": []
},
"systemTypes": [
"Process",
"BPEL"
]
},
"id": "1",
"filters": {
"interaction": "claimed",
"json_query": {
"and": [
{
"field": "taskPriority",
"operator": "LessThan",
"value": 50
},
{
"field": "amount",
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"population": {
"target": "SELF"
}
}
},
"reusableSearchUpdateMeta_response_V2": {
"value": {
"jsonFormat": "v2",
"output": {
"alphabeticalSort": false,
"size": 25,
"includeAllBusinessData": false,
"fields": [
{
"name": "instanceProcessApp",
"kind": "System"
},
{
"name": "amount",
"kind": "Instance"
},
{
"name": "awaitingReview",
"kind": "Task"
}
],
"stats": {
"type": "Basic"
},
"usersFullName": true,
"sort": [
{
"field": {
"name": "taskDueDate",
"kind": "System"
},
"order": "ASC"
},
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"order": "DESC"
}
]
},
"metadata": {
"owner": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"creator": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"lastUpdateDate": "2024-02-20T15:24:16.554Z",
"lastUpdater": {
"id": "uid=admin,o=defaultWIMFileBasedRealm"
},
"name": "my tasks list",
"description": "a search query that returns my tasks list",
"sharing": {
"shared": false
},
"creationDate": "2024-02-20T13:09:02.662Z"
},
"datasource": {
"datatype": "TASKS",
"systemFilter": {
"excludes": [],
"includes": []
},
"systemTypes": [
"Process",
"BPEL"
]
},
"id": "1",
"filters": {
"interaction": "claimed",
"json_query": {
"and": [
{
"field": {
"name": "taskPriority",
"kind": "System"
},
"operator": "LessThan",
"value": 50
},
{
"field": {
"name": "amount",
"kind": "Instance"
},
"operator": "GreaterThan",
"value": 10000
}
]
}
},
"population": {
"target": "SELF"
}
}
},
"savedSearchMeta_response": {
"value": {
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"shared": true,
"teams": [
{
"teamId": "24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"teamName": "GeneralManagers",
"processAppName": "Hiring Sample"
}
],
"size": 25,
"organization": "byTask",
"name": "MySavedSearch",
"interaction": "claimed_and_available",
"id": 202,
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"conditions": [
{
"field": "taskDueDate",
"value": "2016-03-02T05:00:00.000Z",
"operator": "LessThan"
}
],
"fields": [
"taskDueDate",
"taskId",
"taskSubject",
"taskStatus",
"taskPriority",
"taskIsAtRisk",
"taskAtRiskTime",
"taskClosedDate",
"taskActivityName",
"assignedToUser",
"assignedToRoleDisplayName",
"instanceName",
"instanceId",
"instanceStatus",
"instanceProcessApp",
"instanceSnapshot",
"bpdName",
"department",
"gmApproval",
"hiringManager",
"location"
]
}
},
"savedSearchLocalExportList_response": {
"value": {
"results": [
{
"importName": "my_bpm_saved_search_1",
"savedSearch": {
"conditions": [],
"id": "1006",
"shared": false,
"organization": "byTask",
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"name": "my_bpm_saved_search_1",
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"interaction": "completed",
"aliases": [],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"rfc@String",
"GMApproval@Boolean",
"HiringManager@String",
"taskDueDate"
],
"size": 10000
}
},
{
"importName": "my_bpm_saved_search_2",
"savedSearch": {
"conditions": [],
"id": "1004",
"shared": true,
"organization": "byTask",
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"name": "my_bpm_saved_search_2",
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"interaction": "claimed_and_available",
"aliases": [],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"GMApproval@Boolean",
"EmploymentStatus@String",
"RequisitionNumber@String",
"taskDueDate"
],
"size": 10000
}
}
],
"status": 200
}
},
"savedSearchImport_request": {
"value": [
{
"importName": "my_bpm_saved_search_1",
"exportedFrom": {
"id": "bpm1"
},
"savedSearch": {
"owner": "admin",
"shared": false,
"teams": null,
"size": 10000,
"organization": "byTask",
"name": "my_bpm_saved_search_1",
"interaction": "completed",
"id": "1006",
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"rfc@String",
"GMApproval@Boolean",
"HiringManager@String",
"taskDueDate"
],
"conditions": []
}
},
{
"importName": "my_bpm_saved_search_2",
"exportedFrom": {
"id": "bpm2"
},
"savedSearch": {
"owner": "admin",
"shared": true,
"teams": [
{
"teamName": "Managers",
"teamId": "24.581a472b-5016-479a-b5b5-0a9701c2c42c",
"processAppName": "System Data"
}
],
"size": 10000,
"organization": "byTask",
"name": "my_bpm_saved_search_2",
"interaction": "claimed_and_available",
"id": "1004",
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"GMApproval@Boolean",
"EmploymentStatus@String",
"RequisitionNumber@String",
"taskDueDate"
],
"conditions": []
}
}
]
},
"savedSearchImport_response": {
"value": {
"imported": [
{
"savedSearch": {
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"shared": false,
"aliases": [],
"size": 10000,
"organization": "byTask",
"name": "my_bpm_saved_search_1",
"interaction": "completed",
"id": 484,
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"conditions": [],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"rfc@String",
"GMApproval@Boolean",
"HiringManager@String",
"taskDueDate"
]
},
"exportedFrom": "bpm1"
},
{
"savedSearch": {
"owner": "uid=admin,o=defaultWIMFileBasedRealm",
"shared": true,
"aliases": [],
"size": 10000,
"organization": "byTask",
"name": "my_bpm_saved_search_2",
"interaction": "claimed_and_available",
"id": 485,
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"conditions": [],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"GMApproval@Boolean",
"EmploymentStatus@String",
"RequisitionNumber@String",
"taskDueDate"
]
},
"exportedFrom": "bpm2"
}
],
"failed": [],
"malformed": [],
"status": 201
}
},
"savedSearchImportList_response": {
"value": {
"results": [
{
"importName": "my_bpm_saved_search_1",
"exportedFrom": {
"systemId": "2ee12405-f15c-4482-85d0-e1ff7ec564b8",
"id": "bpm1"
},
"savedSearch": {
"owner": "admin",
"shared": false,
"teams": null,
"size": 10000,
"organization": "byTask",
"name": "my_bpm_saved_search_1",
"interaction": "completed",
"id": "1006",
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"rfc@String",
"GMApproval@Boolean",
"HiringManager@String",
"taskDueDate"
],
"conditions": []
}
},
{
"importName": "my_bpm_saved_search_2",
"exportedFrom": {
"systemId": "7cf5b53b-6c76-487c-93e5-25361b46d01d",
"id": "bpm2"
},
"savedSearch": {
"owner": "admin",
"shared": true,
"teams": [
{
"teamName": "Managers",
"teamId": "24.581a472b-5016-479a-b5b5-0a9701c2c42c",
"processAppName": "System Data"
}
],
"size": 10000,
"organization": "byTask",
"name": "my_bpm_saved_search_2",
"interaction": "claimed_and_available",
"id": "1004",
"sort": [
{
"field": "taskDueDate",
"order": "ASC"
}
],
"fields": [
"taskSubject",
"instanceName",
"taskStatus",
"taskPriority",
"GMApproval@Boolean",
"EmploymentStatus@String",
"RequisitionNumber@String",
"taskDueDate"
],
"conditions": []
}
}
],
"status": 200
}
},
"systems_response": {
"value": {
"federationResult": [
{
"systemID": "ca920a9e-f809-4076-9485-a05b6877f5cb",
"statusCode": 200,
"id": "com.ibm.bpm.pfs.ds.federatedSystem_83",
"displayName": "localsys01",
"systemType": "SYSTEM_TYPE_WLE",
"version": "8.5.6.0"
},
{
"systemID": "2a4a7cd6-20fa-4c14-8fdb-7bcbea89cee2",
"statusCode": 200,
"id": "com.ibm.bpm.pfs.ds.federatedSystem_84",
"displayName": "lsystem02",
"systemType": "SYSTEM_TYPE_WPS",
"version": "8.5.6.0"
}
],
"systems": [
{
"systemID": "ca920a9e-f809-4076-9485-a05b6877f5cb",
"systemType": "SYSTEM_TYPE_WLE",
"version": "8.5.6.0",
"groupWorkItemsEnabled": false,
"resources": [
"tasks",
"taskTemplates",
"processes"
],
"taskHistoryEnabled": false,
"buildLevel": "Development Build",
"substitutionEnabled": false,
"workBasketsEnabled": false,
"substitutionManagementRestrictedToAdministrators": false,
"businessCategoriesEnabled": false,
"taskSearchEnabled": true,
"notificationWebMessagingEnabled": false,
"taskListWebMessagingEnabled": false,
"apiVersion": "1.0",
"supports": null,
"hostname": "sjw540.raleigh.ibm.com"
},
{
"systemID": "2a4a7cd6-20fa-4c14-8fdb-7bcbea89cee2",
"systemType": "SYSTEM_TYPE_WPS",
"version": "8.5.6.0",
"groupWorkItemsEnabled": false,
"resources": [
"tasks",
"taskTemplates",
"processes"
],
"taskHistoryEnabled": false,
"buildLevel": "Development Build",
"substitutionEnabled": false,
"workBasketsEnabled": false,
"substitutionManagementRestrictedToAdministrators": false,
"businessCategoriesEnabled": false,
"taskSearchEnabled": true,
"notificationWebMessagingEnabled": false,
"taskListWebMessagingEnabled": false,
"apiVersion": "1.0",
"supports": null,
"hostname": "sjw540.raleigh.ibm.com"
}
]
}
},
"taskAll_response": {
"value": {
"attributeInfo": [
{
"sourceQueryTableIdentifier": "n/a",
"name": "SNAPSHOT_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceSnapshot",
"content": "instance.snapshotname.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "gmApproval",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "gmApproval",
"content": "gmApproval"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PRIORITY",
"isArray": false,
"type": "NUMBER",
"sourceAttribute": "taskPriority",
"content": "task.priority.long"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "hiringManager",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "hiringManager",
"content": "hiringManager"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PROCESS_INSTANCE.PIID",
"isArray": false,
"type": "ID",
"sourceAttribute": null,
"content": "instance.piid.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PT_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "bpdName",
"content": "process.processtemplatename.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "TKIID",
"isArray": false,
"type": "ID",
"sourceAttribute": "taskId",
"content": "task.tkiid.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "taskActivityName",
"content": "task.name.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "TAD_DISPLAY_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "taskSubject",
"content": "task.displayname.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_STATUS",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceStatus",
"content": "instance.status.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "STATUS",
"isArray": false,
"type": "STRING",
"sourceAttribute": "taskStatus",
"content": "task.status.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "COMPLETED",
"isArray": false,
"type": "TIMESTAMP",
"sourceAttribute": "taskClosedDate",
"content": "task.completiontime.date"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "OWNER",
"isArray": false,
"type": "ID",
"sourceAttribute": "assignedToUser",
"content": "task.owner.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceName",
"content": "instance.processinstancename.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "TASK.TKIID",
"isArray": false,
"type": "ID",
"sourceAttribute": null,
"content": "task.tkiid.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "DUE",
"isArray": false,
"type": "TIMESTAMP",
"sourceAttribute": "taskDueDate",
"content": "task.duetime.date"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "IS_AT_RISK",
"isArray": false,
"type": "BOOLEAN",
"sourceAttribute": "taskIsAtRisk",
"content": "task.isatrisk.boolean"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "location",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "location",
"content": "location"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "AT_RISK_TIME",
"isArray": false,
"type": "TIMESTAMP",
"sourceAttribute": "taskAtRiskTime",
"content": "task.atrisktime.date"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PROCESS_APP_ACRONYM",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceProcessApp",
"content": "process.processappacronym.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "department",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "department",
"content": "department"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "ASSIGNED_TO_ROLE_DISPLAY_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "assignedToRoleDisplayName",
"content": "task.assignedtoroledisplayname.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_PIID",
"isArray": false,
"type": "ID",
"sourceAttribute": "instanceId",
"content": "instance.piid.key"
}
],
"requestedSize": 2,
"identifier": "TASK.TKIID",
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"systemID": "_PK:9023014f.49a7767.66f3d6f6.f4850002",
"displayName": "bpel7",
"systemType": "SYSTEM_TYPE_WPS",
"id": "bpel7",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"version": "8.5.7.0",
"indexRefreshInterval": 2000,
"statusCode": "200"
},
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
"displayName": "Display name for system 5",
"systemType": "SYSTEM_TYPE_WLE",
"id": "System_5",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"version": "8.5.7.0",
"indexRefreshInterval": 1000,
"statusCode": "200"
}
],
"offset": 0,
"size": 2,
"stats": {
"onTrack": 0,
"total": 12,
"overdue": 10,
"atRisk": 2,
"open": 12
},
"query": "MySavedSearch",
"queryExecuteTime": "2016-02-25T18:52:02Z",
"entityTypeName": "TASK",
"totalCount": 12,
"items": [
{
"SNAPSHOT_NAME": "07/20/15 Advanced Hiring Sample 8570",
"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
"gmApproval": null,
"PRIORITY": 30,
"hiringManager": null,
"PROCESS_INSTANCE.PIID": "3",
"PT_NAME": "Advanced HR Open New Position",
"TKIID": "4",
"NAME": "Review new position request",
"TAD_DISPLAY_NAME": "Step: Review new position request",
"PI_STATUS": "Active",
"STATUS": "Received",
"COMPLETED": null,
"OWNER": null,
"PI_NAME": "Advanced Employee Requisition NG (List) for Tom Miller (3)",
"TASK.TKIID": "4",
"DUE": "2015-10-02T14:52:36.994Z",
"IS_AT_RISK": true,
"location": null,
"AT_RISK_TIME": "2015-10-02T14:46:36.994Z",
"PROCESS_APP_ACRONYM": "HSAV1",
"department": null,
"ASSIGNED_TO_ROLE_DISPLAY_NAME": "General Managers",
"PI_PIID": "3"
},
{
"SNAPSHOT_NAME": "BPM Task Search V8.5.5.0 v1",
"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
"gmApproval": null,
"PRIORITY": 30,
"hiringManager": null,
"PROCESS_INSTANCE.PIID": "869",
"PT_NAME": "Task Search Test",
"TKIID": "870",
"NAME": "Test",
"TAD_DISPLAY_NAME": "Step: Test",
"PI_STATUS": "Active",
"STATUS": "Received",
"COMPLETED": null,
"OWNER": null,
"PI_NAME": "Task Search Test:869",
"TASK.TKIID": "870",
"DUE": "2015-10-07T17:41:17.210Z",
"IS_AT_RISK": true,
"location": null,
"AT_RISK_TIME": "2015-10-07T17:35:17.210Z",
"PROCESS_APP_ACRONYM": "TSKSCRH",
"department": null,
"ASSIGNED_TO_ROLE_DISPLAY_NAME": "All Users",
"PI_PIID": "869"
}
]
}
},
"processInstanceTrend_response": {
"value": {
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"data": [
{
"created": 0,
"completed": 0,
"timestamp": "2020-06-15T00:00:00.000Z"
},
{
"created": 1,
"completed": 1,
"timestamp": "2020-06-16T00:00:00.000Z"
},
{
"created": 0,
"completed": 0,
"timestamp": "2020-06-17T00:00:00.000Z"
},
{
"created": 88977,
"completed": 28635,
"timestamp": "2020-06-18T00:00:00.000Z"
},
{
"created": 0,
"completed": 0,
"timestamp": "2020-06-19T00:00:00.000Z"
}
],
"queryExecuteTime": "2020-07-01T09:47:23Z"
}
},
"processSummaries_response": {
"value": {
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"queryExecuteTime": "2020-08-04T11:22:54Z",
"summaries": [
{
"processId": "25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"processAppName": "Hiring Sample",
"name": "Standard HR Open New Position",
"countOverdue": 0,
"description": "This process covers a manager requesting to create a new position or fill an existing position. The process routes the position request to the Human Resources (HR) department to search for candidates.",
"countAtRisk": 0,
"countActive": 0,
"countOnTrack": 0,
"systemIDs": [
"4a8a5317-808e-48fe-964e-ff489ed356ce"
]
},
{
"processId": "25.12df730b-3c1f-4658-98c9-cb99eefbc9ad",
"processAppId": "2066.1c793d64-d2bd-4302-a847-25a98f37c561",
"processAppName": "Hiring Sample Advanced",
"name": "Advanced HR Open New Position",
"countOverdue": 0,
"description": "This process covers a manager requesting to create a new position or to fill an existing position. The process routes the position request to the Human Resources (HR) department to search for candidates.",
"countAtRisk": 0,
"countActive": 0,
"countOnTrack": 0,
"systemIDs": [
"4a8a5317-808e-48fe-964e-ff489ed356ce"
]
}
]
}
},
"processSummary_response": {
"value": {
"summary": {
"processId": "25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"processAppName": "Hiring Sample",
"name": "Standard HR Open New Position",
"countOverdue": 0,
"description": "This process covers a manager requesting to create a new position or fill an existing position. The process routes the position request to the Human Resources (HR) department to search for candidates.",
"countAtRisk": 0,
"countActive": 0,
"countOnTrack": 0,
"averageDuration": 717120,
"systemIDs": [
"4a8a5317-808e-48fe-964e-ff489ed356ce"
]
},
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"queryExecuteTime": "2020-07-06T13:33:46Z"
}
},
"teamMemberList_response": {
"value": {
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"queryExecuteTime": "2020-08-06T13:09:24Z",
"teamMemberList": [
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "fdadmin",
"fullName": "fdadmin",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 2,
"jobTitle": "",
"name": "teamuser2",
"fullName": "teamuser2",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "fdauto2",
"fullName": "fdauto2",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "celladmin",
"fullName": "celladmin",
"assignedTasks": 13
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "fdauto1",
"fullName": "fdauto1",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "fvtadmin",
"fullName": "fvtadmin",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "teamuser22",
"fullName": "teamuser22",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "mgruser2",
"fullName": "mgruser2",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "teamuser12",
"fullName": "teamuser12",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "mgruser1",
"fullName": "mgruser1",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "tkuser1",
"fullName": "tkuser1",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "ssadmin",
"fullName": "ssadmin",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "tkteamuser1",
"fullName": "tkteamuser1",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "induser2",
"fullName": "induser2",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "bpmadmin",
"fullName": "bpmadmin",
"assignedTasks": 0
},
{
"emailAddress": "",
"phoneNumber": "",
"tasksCompletedToday": 0,
"jobTitle": "",
"name": "teamuser1",
"fullName": "teamuser1",
"assignedTasks": 0
}
]
}
},
"teamMemberSummary_response": {
"value": {
"summary": {
"tasksCompletedToday": 3,
"emailAddress": "",
"phoneNumber": "",
"countOverdue": 1,
"jobTitle": "",
"name": "fdadmin",
"fullName": "fdadmin",
"countAtRisk": 0,
"totalOpenTasks": 4,
"countOnTrack": 3
},
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"queryExecuteTime": "2020-07-06T13:33:46Z"
}
},
"teamSummaries_response": {
"value": {
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"queryExecuteTime": "2020-08-04T11:22:54Z",
"summaries": [
{
"tasksCompletedToday": 0,
"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"processAppName": "Hiring Sample",
"teamId": "24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"countOverdue": 0,
"name": "GeneralManagers",
"countAtRisk": 0,
"description": "People who have authority to approve new positions.",
"totalOpenTasks": 0,
"countOnTrack": 0
},
{
"tasksCompletedToday": 0,
"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"processAppName": "Hiring Sample",
"teamId": "24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
"countOverdue": 0,
"name": "Human Resources",
"countAtRisk": 0,
"description": "People in the human resources department.",
"totalOpenTasks": 0,
"countOnTrack": 0
},
{
"tasksCompletedToday": 0,
"processAppId": "2066.1c793d64-d2bd-4302-a847-25a98f37c561",
"processAppName": "Hiring Sample Advanced",
"teamId": "24.7d98b271-207f-4483-ad00-fba01068b785",
"countOverdue": 0,
"name": "Managers",
"countAtRisk": 0,
"description": "",
"totalOpenTasks": 0,
"countOnTrack": 0
},
{
"tasksCompletedToday": 0,
"processAppId": "2066.1b351583-e5cb-43b7-baee-340a63130ea7",
"processAppName": "System Data",
"teamId": "24.da7e4d23-78cb-4483-98ed-b9c238308a03",
"countOverdue": 0,
"name": "All Users",
"countAtRisk": 0,
"description": "All Users represents all people in the system.",
"totalOpenTasks": 28,
"countOnTrack": 28
},
{
"tasksCompletedToday": 0,
"processAppId": "2066.1c793d64-d2bd-4302-a847-25a98f37c561",
"processAppName": "Hiring Sample Advanced",
"teamId": "24.dd406779-df57-4cef-89b2-b3c9fa197b77",
"countOverdue": 1,
"name": "General Managers",
"countAtRisk": 0,
"description": "",
"totalOpenTasks": 1,
"countOnTrack": 0
},
{
"tasksCompletedToday": 0,
"processAppId": "2066.1c793d64-d2bd-4302-a847-25a98f37c561",
"processAppName": "Hiring Sample Advanced",
"teamId": "24.013cbb68-094d-4281-8789-c2966f34d480",
"countOverdue": 2,
"name": "Hiring Managers",
"countAtRisk": 0,
"description": "",
"totalOpenTasks": 2,
"countOnTrack": 0
},
{
"tasksCompletedToday": 0,
"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"processAppName": "Hiring Sample",
"teamId": "24.cd97937f-06ab-43cc-8067-17dea489fdb3",
"countOverdue": 0,
"name": "HiringManagers",
"countAtRisk": 0,
"description": "People who have a department that needs a new position or have an existing position that needs to be filled.",
"totalOpenTasks": 0,
"countOnTrack": 0
}
]
}
},
"teamSummary_response": {
"value": {
"summary": {
"tasksCompletedToday": 0,
"processAppId": "NOT YET AVAILABLE",
"processAppName": "System Data",
"teamId": "24.da7e4d23-78cb-4483-98ed-b9c238308a03",
"countOverdue": 30074,
"name": "All Users",
"countAtRisk": 0,
"description": "NOT YET AVAILABLE",
"totalOpenTasks": 60339,
"countOnTrack": 30265
},
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"queryExecuteTime": "2020-07-06T13:33:46Z"
}
},
"teamTasks_response": {
"value": {
"attributeInfo": [
{
"sourceQueryTableIdentifier": "n/a",
"name": "SNAPSHOT_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceSnapshot",
"content": "instance.snapshotname.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "gmApproval",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "gmApproval",
"content": "gmApproval"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PRIORITY",
"isArray": false,
"type": "NUMBER",
"sourceAttribute": "taskPriority",
"content": "task.priority.long"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "hiringManager",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "hiringManager",
"content": "hiringManager"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PROCESS_INSTANCE.PIID",
"isArray": false,
"type": "ID",
"sourceAttribute": null,
"content": "instance.piid.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PT_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "bpdName",
"content": "process.processtemplatename.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "TKIID",
"isArray": false,
"type": "ID",
"sourceAttribute": "taskId",
"content": "task.tkiid.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "taskActivityName",
"content": "task.name.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "TAD_DISPLAY_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "taskSubject",
"content": "task.displayname.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_STATUS",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceStatus",
"content": "instance.status.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "STATUS",
"isArray": false,
"type": "STRING",
"sourceAttribute": "taskStatus",
"content": "task.status.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "COMPLETED",
"isArray": false,
"type": "TIMESTAMP",
"sourceAttribute": "taskClosedDate",
"content": "task.completiontime.date"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "OWNER",
"isArray": false,
"type": "ID",
"sourceAttribute": "assignedToUser",
"content": "task.owner.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceName",
"content": "instance.processinstancename.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "TASK.TKIID",
"isArray": false,
"type": "ID",
"sourceAttribute": null,
"content": "task.tkiid.key"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "DUE",
"isArray": false,
"type": "TIMESTAMP",
"sourceAttribute": "taskDueDate",
"content": "task.duetime.date"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "IS_AT_RISK",
"isArray": false,
"type": "BOOLEAN",
"sourceAttribute": "taskIsAtRisk",
"content": "task.isatrisk.boolean"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "location",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "location",
"content": "location"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "AT_RISK_TIME",
"isArray": false,
"type": "TIMESTAMP",
"sourceAttribute": "taskAtRiskTime",
"content": "task.atrisktime.date"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PROCESS_APP_ACRONYM",
"isArray": false,
"type": "STRING",
"sourceAttribute": "instanceProcessApp",
"content": "process.processappacronym.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "department",
"isArray": false,
"type": "UNKNOWN",
"sourceAttribute": "department",
"content": "department"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "ASSIGNED_TO_ROLE_DISPLAY_NAME",
"isArray": false,
"type": "STRING",
"sourceAttribute": "assignedToRoleDisplayName",
"content": "task.assignedtoroledisplayname.string"
},
{
"sourceQueryTableIdentifier": "n/a",
"name": "PI_PIID",
"isArray": false,
"type": "ID",
"sourceAttribute": "instanceId",
"content": "instance.piid.key"
}
],
"requestedSize": 2,
"identifier": "TASK.TKIID",
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"systemID": "_PK:9023014f.49a7767.66f3d6f6.f4850002",
"displayName": "bpel7",
"systemType": "SYSTEM_TYPE_WPS",
"id": "bpel7",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"version": "8.5.7.0",
"indexRefreshInterval": 2000,
"statusCode": "200"
},
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
"displayName": "Display name for system 5",
"systemType": "SYSTEM_TYPE_WLE",
"id": "System_5",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
"version": "8.5.7.0",
"indexRefreshInterval": 1000,
"statusCode": "200"
}
],
"offset": 0,
"size": 2,
"riskStateSummary": {
"DueTomorrow": 0,
"DueThisWeek": 0,
"AtRisk": 2,
"DueLater": 0,
"OnTrack": 0,
"DueToday": 0,
"Overdue": 10
},
"query": "MySavedSearch",
"queryExecuteTime": "2016-02-25T18:52:02Z",
"entityTypeName": "TASK",
"totalCount": 12,
"items": [
{
"SNAPSHOT_NAME": "07/20/15 Advanced Hiring Sample 8570",
"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
"gmApproval": null,
"PRIORITY": 30,
"hiringManager": null,
"PROCESS_INSTANCE.PIID": "3",
"PT_NAME": "Advanced HR Open New Position",
"TKIID": "4",
"NAME": "Review new position request",
"TAD_DISPLAY_NAME": "Step: Review new position request",
"PI_STATUS": "Active",
"STATUS": "Received",
"COMPLETED": null,
"OWNER": null,
"PI_NAME": "Advanced Employee Requisition NG (List) for Tom Miller (3)",
"TASK.TKIID": "4",
"DUE": "2015-10-02T14:52:36.994Z",
"IS_AT_RISK": true,
"location": null,
"AT_RISK_TIME": "2015-10-02T14:46:36.994Z",
"PROCESS_APP_ACRONYM": "HSAV1",
"department": null,
"ASSIGNED_TO_ROLE_DISPLAY_NAME": "General Managers",
"PI_PIID": "3"
},
{
"SNAPSHOT_NAME": "BPM Task Search V8.5.5.0 v1",
"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
"gmApproval": null,
"PRIORITY": 30,
"hiringManager": null,
"PROCESS_INSTANCE.PIID": "869",
"PT_NAME": "Task Search Test",
"TKIID": "870",
"NAME": "Test",
"TAD_DISPLAY_NAME": "Step: Test",
"PI_STATUS": "Active",
"STATUS": "Received",
"COMPLETED": null,
"OWNER": null,
"PI_NAME": "Task Search Test:869",
"TASK.TKIID": "870",
"DUE": "2015-10-07T17:41:17.210Z",
"IS_AT_RISK": true,
"location": null,
"AT_RISK_TIME": "2015-10-07T17:35:17.210Z",
"PROCESS_APP_ACRONYM": "TSKSCRH",
"department": null,
"ASSIGNED_TO_ROLE_DISPLAY_NAME": "All Users",
"PI_PIID": "869"
}
]
}
},
"teamTaskTrend_response": {
"value": {
"federationResult": [
{
"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPM20002",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
"id": "bpm20002",
"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
"version": "8.6.2.20002",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"data": [
{
"created": 0,
"completed": 0,
"timestamp": "2020-06-15T00:00:00.000Z"
},
{
"created": 1,
"completed": 1,
"timestamp": "2020-06-16T00:00:00.000Z"
},
{
"created": 0,
"completed": 0,
"timestamp": "2020-06-17T00:00:00.000Z"
},
{
"created": 88977,
"completed": 28635,
"timestamp": "2020-06-18T00:00:00.000Z"
},
{
"created": 0,
"completed": 0,
"timestamp": "2020-06-19T00:00:00.000Z"
}
],
"queryExecuteTime": "2020-07-01T09:47:23Z"
}
},
"getIndexersBackupState_response": {
"value": {
"results": [
{
"federatedSystem": {
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPD2102",
"id": "bpd2102"
},
"indexName": "bpd2102",
"errorMessage": "no indexer state recorded in the index",
"status": "error"
},
{
"restorationTimestamp": "2021-10-12T13:06:10.912Z",
"federatedSystem": {
"systemID": "_PK:90230172.e73e2c1c.1460ef53.182e0002",
"displayName": "BPEL2103",
"id": "bpel2103"
},
"indexName": "bpel2103",
"recordTimestamp": "2021-10-12T14:03:38.086Z",
"status": "ok"
}
]
}
},
"putIndexersBackupState_response": {
"value": {
"results": [
{
"restorationTimestamp": "2021-10-12T08:27:04.660Z",
"federatedSystem": {
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPD2102",
"id": "bpd2102"
},
"indexName": "bpd2102",
"recordTimestamp": "2021-10-12T14:12:01.688Z",
"status": "ok"
},
{
"restorationTimestamp": "2021-10-12T13:06:10.912Z",
"federatedSystem": {
"systemID": "_PK:90230172.e73e2c1c.1460ef53.182e0002",
"displayName": "BPEL2103",
"id": "bpel2103"
},
"indexName": "bpel2103",
"recordTimestamp": "2021-10-12T14:12:01.688Z",
"status": "ok"
}
]
}
},
"deleteIndexersBackupState_response": {
"value": {
"results": [
{
"federatedSystem": {
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPD2102",
"id": "bpd2102"
},
"indexName": "bpd2102",
"message": "indexer state backup deleted: it is now impossible to restore a previous snapshot of this index",
"status": "ok"
},
{
"federatedSystem": {
"systemID": "_PK:90230172.e73e2c1c.1460ef53.182e0002",
"displayName": "BPEL2103",
"id": "bpel2103"
},
"indexName": "bpel2103",
"message": "indexer state backup deleted: it is now impossible to restore a previous snapshot of this index",
"status": "ok"
}
]
}
},
"putIndexersRestoreState_response": {
"value": {
"results": [
{
"federatedSystem": {
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPD2102",
"id": "bpd2102"
},
"indexName": "bpd2102",
"errorMessage": "No previously recorded indexer state found",
"status": "error"
},
{
"restorationTimestamp": "2021-10-12T13:06:10.912Z",
"federatedSystem": {
"systemID": "_PK:90230172.e73e2c1c.1460ef53.182e0002",
"displayName": "BPEL2103",
"id": "bpel2103"
},
"indexName": "bpel2103",
"recordTimestamp": "2021-10-12T14:12:01.688Z",
"status": "ok"
}
]
}
},
"deleteIndexersRestoreState_response": {
"value": {
"results": [
{
"federatedSystem": {
"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
"displayName": "BPD2102",
"id": "bpd2102"
},
"indexName": "bpd2102",
"errorMessage": "no previous restoration request to cancel",
"status": "error"
},
{
"federatedSystem": {
"systemID": "_PK:90230172.e73e2c1c.1460ef53.182e0002",
"displayName": "BPEL2103",
"id": "bpel2103"
},
"indexName": "bpel2103",
"message": "restoration cancelled",
"status": "ok"
}
]
}
},
"processInstanceAll_response": {
"value": {
"queryExecuteTime": "2020-01-24T14:05:52Z",
"requestedSize": 5,
"lastPiid": "56",
"federationResult": [
{
"restUrlPrefix": "http://9.34.56.12/rest/bpm/wle",
"systemID": "be760c24-1711-4e2a-a1a6-5a79f4a608ff",
"displayName": "BPD_SYSTEM_1",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "http://9.34.56.12:9080/portal",
"id": "bpdSystem_1",
"taskCompletionUrlPrefix": "http://9.34.56.12:9080/teamworks",
"version": "8.6.1.19003",
"indexRefreshInterval": 2000,
"statusCode": "200"
},
{
"restUrlPrefix": "https://9.34.56.13:9443/rest/bpm/wle",
"systemID": "fcfda9e1-f10e-42ef-ae17-f968b01182eb",
"displayName": "BPD_SYSTEM_2",
"systemType": "SYSTEM_TYPE_WLE",
"portalSupportUrlPrefix": "https://9.34.56.13:9443/portal",
"id": "bpdSystem_2",
"taskCompletionUrlPrefix": "https://9.34.56.13:9443/teamworks",
"version": "8.6.1.19003",
"indexRefreshInterval": 2000,
"statusCode": "200"
}
],
"size": 3,
"totalCount": 3,
"processes": [
{
"piid": "54",
"systemID": "be760c24-1711-4e2a-a1a6-5a79f4a608ff",
"snapshotID": "2064.83C26C14-8053-449A-9750-C125656F67AC",
"processName": "Advanced HR Open New Position",
"lastModificationTime": "2020-01-24T01:38:54.683Z",
"atRiskDate": "2020-01-24T09:38:16.993Z",
"dueDate": "2020-01-24T09:38:40.863Z",
"name": "Advanced Employee Requisition NG (List) for Tom Miller (54)",
"executionState": "Active",
"completionDate": null,
"creationDate": "2020-01-24T01:38:40.867Z",
"businessData": {
"Department": "Finance",
"EmploymentStatus": "Contract",
"HiringManager": "Tom Miller",
"RequisitionNumber": "1141",
"Location": "Chicago"
}
},
{
"piid": "55",
"systemID": "be760c24-1711-4e2a-a1a6-5a79f4a608ff",
"snapshotID": "2064.83C26C14-8053-449A-9750-C125656F67AC",
"processName": "Advanced HR Open New Position",
"lastModificationTime": "2020-01-24T01:39:47.583Z",
"atRiskDate": "2020-01-24T09:38:36.760Z",
"dueDate": "2020-01-24T09:39:00.630Z",
"name": "Advanced Employee Requisition NG (List) for Tom Miller (55)",
"executionState": "Active",
"completionDate": null,
"creationDate": "2020-01-24T01:39:00.633Z",
"businessData": {
"Department": "Marketing",
"EmploymentStatus": "Part time",
"HiringManager": "John Miller",
"RequisitionNumber": "1141",
"Location": "Dallas"
}
},
{
"piid": "56",
"systemID": "be760c24-1711-4e2a-a1a6-5a79f4a608ff",
"snapshotID": "2064.83C26C14-8053-449A-9750-C125656F67AC",
"processName": "Advanced HR Open New Position",
"lastModificationTime": "2020-01-24T01:39:55.147Z",
"atRiskDate": null,
"dueDate": "2020-01-24T09:39:54.987Z",
"name": "Advanced Employee Requisition NG (List) for Tom Miller (56)",
"executionState": "Active",
"completionDate": null,
"creationDate": "2020-01-24T01:39:54.990Z",
"businessData": {
"Department": "Sales",
"EmploymentStatus": "Full time",
"HiringManager": "John Miller",
"RequisitionNumber": "1141",
"Location": "Miami"
}
}
]
}
}
}
},
"x-ibm-services": [
"/pfs-fvt-case",
"/rest/bpm"
],
"x-original-swagger-version": "2.0"
}