Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

Panel

title	Service Report REST Methods

Get Deployed Services Report

Purpose: Provides a listing of the services which are currently deployed
Request: GET https://host:port/duraboss/report/service/deployed
Response Code: 200 (on success)
Response Body: XML, defined by the service report XSDs

Get Completed Services Report

Purpose: Provides a listing of the most recent completed services
Request: GET https://host:port/duraboss/report/service ? (limit)
- Parameter value for limit (optional) should indicate the maximum number of services to return in the report (default is 20, max is 1000)
Response Code: 200 (on success)
Response Body: XML, defined by the service report XSDs

Get Completed Services Report List

Purpose: Provides a listing of all service report IDs
Request: GET https://host:port/duraboss/report/service/list
Response Code: 200 (on success)
Response Body: XML, defined by the service report XSDs

Get Services Report

Purpose: Provides a specific services report based on the provided report ID
Request: GET https://host:port/duraboss/report/service/reportID
Response Code: 200 (on success)
Response Body: XML, defined by the service report XSDs

Panel

title	Action Executor REST Methods

Get Executor Status

Purpose: Provides a status of the Executor, which is the collected status of all Action Handlers
Request: GET https://host:port/duraboss/exec^{Image Added}
Response Code: 200 (on success)
Response Body: XML serialization of status map

Get Supported Executor Actions

Purpose: Provides a listing of the actions which the Executor can perform
Request: GET https://host:port/duraboss/exec/action^{Image Added}
Response Code: 200 (on success)
Response Body: XML serialization of the action set

Perform an Executor Action

Purpose: Performs a specific Executor action based on the provided actionName
Request: POST https://host:port/duraboss/exec/actionName^{Image Added}
Response Code: 200 (on success)

Shutdown Executor

Purpose: Requests that the Executor perform a graceful shutdown
Request: DELETE https://host:port/duraboss/exec^{Image Added}
Response Code: 200 (on success)