EngineResource
The following resources are part of this group:
- /engines
- /engines/configuration
- /engines/connect
- /engines/copyConfigurationToRepository
- /engines/defaultConfiguration
- /engines/delete
- /engines/dispose
- /engines/disposeEngines
- /engines/ping
- /engines/pingHost
- /engines/setConfigurationFromRepository
- /engines/start
- /engines/stop
- /engines/testEngine
- /engines/testEngineWithoutRedirect
- /engines/testLdap
- /engines/updatePreferences
- /engines/{id}
- /engines/isAuthenticated/{id}
/engines
GET
Returns all the engines configured in the OpsConsole.
Response Body
| element: | engines |
| media types: | application/xml application/json |
List of Engines.
POST
Adds an engine that could be monitored from the OpsConsole.
Parameters
| name | description | type | default |
|---|---|---|---|
| host | The computer where the secured RMI engine is located. | form | |
| port | The port for the RMI registry located on the computer where the engine is located. | form | |
| ssl | (no documentation provided) | form |
Response Body
| element: | (custom) |
| media types: | text/plain |
Returns <success/> if the request succeeded, else returns <error>Engine already exists.</error>.
/engines/configuration
GET
Gets the engine configuration.
Parameters
| name | description | type | default |
|---|---|---|---|
| host | The computer where the secured RMI engine is located. | query | |
| port | The port for the RMI registry located on the computer where the engine is located. | query | |
| ssl | (no documentation provided) | query |
Response Body
| element: | configuration |
| media types: | application/xml |
Returns information if there was an error getting engine configuration.
POST
Restarts the engine configuration.
Parameters
| name | description | type | default |
|---|---|---|---|
| host | The computer where the secured RMI engine is located. | query | |
| port | The port for the RMI registry located on the computer where the engine is located. | query | |
| ssl | (no documentation provided) | query |
Request Body
| element: | (custom) |
| media types: | */* application/xml |
The updated engine configuration to be applied.
Response Body
| element: | (custom) |
| media types: | text/plain |
Returns information if there was an error applying engine configuration.
/engines/connect
POST
Connects to an engine using engine id.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Unique engine identifier. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/copyConfigurationToRepository
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| namespace | (no documentation provided) | query | |
| host | (no documentation provided) | query | |
| port | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/defaultConfiguration
GET
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/engines/delete
POST
Deletes an engine from the OpsConsole.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Unique engine identifier. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/dispose
POST
Stops the engine, disposes all engine resources, and finally shuts down the engine. The engine waits for any running jobs to reach a stopping point before returning. After dispose() is called, all other methods will throw exceptions if called.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Unique engine id in the Cluster. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/disposeEngines
POST
Stops all the engines in the Cluster, disposes all engine resources, and finally shuts down the engines. The engine waits for any running jobs to reach a stopping point before returning. After dispose() is called, all other methods will throw exceptions if called.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/ping
POST
An empty method that performs absolutely no function except to verify that the engine is alive. This method is completely empty and does nothing. No security checks are performed. No log or audit trail is written.
Parameters
| name | description | type | default |
|---|---|---|---|
| host | The computer where the secured RMI engine is located. | form | |
| port | The port for the RMI registry located on the computer where the engine is located. | form | |
| ssl | (no documentation provided) | form |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/engines/pingHost
POST
Pings a host machine.
Parameters
| name | description | type | default |
|---|---|---|---|
| host | hostname or IP address of a machine. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
Returns formatted round trip time in milli-seconds.
/engines/setConfigurationFromRepository
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| namespace | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/start
POST
Instructs the engine to start executing flow charts.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Unique engine id in the Cluster. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/stop
POST
Instructs the engine to stop executing flow charts. This method blocks until all running flow charts have stopped. Once stopped, the engine can be restarted.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Unique engine id in the Cluster. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/testEngine
POST
Tests an engine connectivity.
Parameters
| name | description | type | default |
|---|---|---|---|
| host | The computer where the secured RMI engine is located. | form | |
| port | The port for the RMI registry located on the computer where the engine is located. | form | |
| ssl | (no documentation provided) | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/engines/testEngineWithoutRedirect
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| host | (no documentation provided) | form | |
| port | (no documentation provided) | form | |
| ssl | (no documentation provided) | form |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/engines/testLdap
POST
Test an LDAP host to determine whether the host is available and configuration is correct, and if not, return a meaningful error message.
Request Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/engines/updatePreferences
POST
Request Body
| element: | engines |
| media types: | application/xml application/json |
(no documentation provided)
Response Body
| element: | engines |
| media types: | */* application/xml |
(no documentation provided)
/engines/{id}
GET
Access the Engine details using the engine id.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Unique engine identifier. | path |
Response Body
| element: | engine |
| media types: | application/xml application/json |
(no documentation provided)
/engines/isAuthenticated/{id}
GET
Checks if an engine is secure and if so, that the user is properly authenticated.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Unique engine identifier. | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)