GET /rest/bpm/federated/htm/v1/systems[?domain={string}|systemID={string}]| Name | Value Type | Description |
|---|---|---|
| domain | string | Name of the domain containing the IBM Business Process Manager (BPEL runtime environment, BPD runtime, environment, or both) systems that host the distributed resource (mutually exclusive with the systemID parameter). |
| systemID | string | ID of the IBM Business Process Manager (BPEL runtime environment, BPD runtime, environment, or both) system hosting the resource (mutually exclusive with the domain parameter). If specified then this request is treated like any other request for a resource hosted by a single system, that is, the request and the response are just routed, and no pre/post-processing of parameters and results is performed by the federation layer. |
None
The default content-type is application/json.
{ "description": "Systems",
"type": "object",
"properties":
{ "federationResult":
[
{ "systemID": {"type": "string",
"description": "ID of the individual system the request was sent to."
},
"statusCode": {"type": "integer",
"description": "HTTP Status Code returned from this system."
},
"errorNumber": {"type": "string", "optional": true,
"description":"Message ID of the exception."
},
"errorMessage": {"type": "string", "optional": true,
"description":"Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description":"Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description":"Additional, exception details, for example, a stack trace."
}
}
],
"systems":
[
{ "systemID": {"type": "string",
"description": "ID of the system that is described by this object."
},
"systemType": {"type": "string",
"description": "Type of the system that is described by this object. Predefined values are listed below.",
"enum":
[
"SYSTEM_TYPE_WLE",
"SYSTEM_TYPE_WPS",
"SYSTEM_TYPE_ICM"
]
},
"version": {"type": "string",
"description": "Version of the system that is described by this object."
},
"buildLevel": {"type": "string",
"description": "Build level of the system that is described by this object."
},
"groupWorkItemsEnabled": {"type": "boolean",
"description": "States whether group workitems can be used."
},
"substitutionEnabled": {"type": "boolean",
"description": "States whether substitution is enabled."
},
"substitutionManagementRestrictedToAdministrators": {"type": "boolean",
"description": "States whether substitution management is restricted to administrators."
},
"taskHistoryEnabled": {"type": "boolean",
"description": "States whether the collection of task history events is enabled."
},
"workBasketsEnabled": {"type": "boolean",
"description": "States whether work baskets are enabled."
},
"businessCategoriesEnabled": {"type": "boolean",
"description": "States whether business categories are enabled."
},
"supports": {"type": "[string]", "optional": true,
"description": "List of features the API supports."
},
"resources": {"type": "[string]",
"description": "List of resources the API supports."
},
"hostName": {"type": "[string]", "optional": true,
"description": "Hostname of the system that is described by this object."
}
}
],
"domains":
[
{ "name": {"type": "string",
"description": "Name of the domain."
},
"displayName": {"type": "string",
"description": "Display name of the domain."
},
"status": {"type": "string", "optional": true,
"description": "Status of the domain information; 'incomplete' if one or more systems of the domain did not return metadata."
},
"systems": {"type": ["string"],
"description": "List of IDs for the systems in this domain."
}
}
], "optional": true
}
}
The default content-type is application/json.
{ "description": "Error Response",
"type": "object",
"properties":
{ "federationResult":
[
{ "systemID": {"type": "string",
"description": "ID of the individual system the request was sent to."
},
"statusCode": {"type": "integer",
"description": "HTTP Status Code returned from this system."
},
"errorNumber": {"type": "string", "optional": true,
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string", "optional": true,
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description": "Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description": "Additional, exception details, for example, a stack trace."
},
"status": {"type": "string", "optional": true,
"description": "Status of the request."
},
"exceptionType": {"type": "string", "optional": true,
"description": "Type of the exception."
}
}
],
"errorNumber": {"type": "string",
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string",
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description": "Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description": "Additional, exception details, for example, a stack trace."
},
"status": {"type": "string", "optional": true,
"description": "Status of the request."
},
"exceptionType": {"type": "string", "optional": true,
"description": "Type of the exception."
}
}
}
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred. Programmer's details are provided. |
| 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. |
| Release | Description |
|---|---|
| 7.5.1 | The returned query table attribute entry contains a new properties:
|
7.5
Parent topic: Systems Metadata (Task Resources) Resource