IBM Business Process Manager, Version 8.5.6

REST interface for IBM Process Federation Server resources - Task Instance Queries Resource - GET Method

Sample method invocation

Parameters

None

Request content

None

Response content

The default content type is application/json.

MIME type: application/json

{  "description": "FEDERATED Queries", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string"},
      "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the IBM BPM system that the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP status code that was returned from this IBM BPM system."
            },
            "id": {"type": "string",
               "description":"The ID of this federated IBM BPM system"
            },
            "indexName": {"type": "string",
               "description":"The name of the index for this federated IBM BPM system."
            },
            "systemType": {"type": ["string"],
               "description":"The type of this federated IBM BPM system, either "SYSTEM_TYPE_WLE", or "SYSTEM_TYPE_WPS"."
            },
            "version": {"type": "object",
               "description":"The product version on this federated IBM BPM system."
            }
         }
      ]   
      "items": 
      [
         {  "name": {"type": "string",
               "description": "Query name."
            },
            "displayName": {"type": "string",
               "description": "Query display name (localized)."
            },
            "description": {"type": "string",
               "description": "Query description (localized)."
            },
            "kind": {"type": "string",
               "description": "Query kind.", 
               "enum":
               [
                  "FEDERATED"
               ]
            },
            "authorizationType": {"type": "string",
               "description": "Type of authorization required for performing queries using this query.",
               "enum":
               [
                  "INSTANCE_BASED"
               ]
            },
            "entityTypeName": {"type": "string",
               "description": "Type of entities that are returned by the query."
            },
            "keyAttribute": {"type": "string",
               "description": "Name of the attribute that uniquely identifies an entity."
            },
            "locales": {"type": ["string"],
               "description": "List of locales that are defined for the display names and descriptions of this query."
            }
         }
      ]
   }
}

{
	"federationResult": [{
		"systemID": "2a4a7cd6-20fa-4c14-8fdb-7bcbea89cee2",
		"statusCode": 200,
		"id": "com.ibm.bpm.pfs.ds.federatedSystem_84",
		"indexName": "lsystem02",
		"systemType": "SYSTEM_TYPE_WLE",
		"version": "8.5.6.0"
	},
	{
		"systemID": "ca920a9e-f809-4076-9485-a05b6877f5cb",
		"statusCode": 200,
		"id": "com.ibm.bpm.pfs.ds.federatedSystem_83",
		"indexName": "localsys01",
		"systemType": "SYSTEM_TYPE_WPS",
		"version": "8.5.6.0"
	}],
	"items": [{
		"authorizationType": "INSTANCE_BASED",
		"kind": "FEDERATED",
		"entityTypeName": "TASK",
		"systemIDs": ["2a4a7cd6-20fa-4c14-8fdb-7bcbea89cee2",
		              "ca920a9e-f809-4076-9485-a05b6877f5cb"],
		"locales": ["zh", "tr", "sv", "ru", "ro", "pl", "no", "nb", "ko", "ja",  "default",
		            "en", "ar", "cs", "da", "de", "el", "es", "fi", "fr", "iw", "hu", "it",  "zh_TW",
		            "pt_BR"],
		"name": "IBM.DEFAULTALLTASKSLIST_75",
		"description": "This is the default tasks list. Define custom tasks lists to show selected business data.",
		"displayName": "All",
		"keyAttribute": "TASK.TKIID"
	}],
	"identifier": "name"
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	The request completed successfully. The requested data was returned but the list might be empty.
400 Bad Request	The parameters are not valid or they are missing.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem occurred.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Available since

8.5.6

Parent Topic: Task Instance Queries Resource