ROSE Developers - Web API Reference

Master Data Business Entities | Task Box Service Provider

The Task Box Service Provider allows keep the historical of the last operation executed by the task box. (RESERVED FOR INTERNAL USE).

Overview


URL api/{tenantKey}/{orgKey}/businessCore/taskBoxServiceProviders
Methods Supported GET, POST

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET Check Pending Async Tasks

Check if exists pending async tasks.

Response:

When successful, the response body contains an item of type 'boolean'.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/taskBoxServiceProviders/checkPendingAsyncTasks

POST Operations

POST ExecuteTask

Custom operation 'ExecuteTask'.

The following elements are required:

id (Guid) Id.

Response:

When successful, the response body is empty.

Resource URL:

POST /businessCore/taskBoxServiceProviders/executeTask/{id}

Resources


TaskBoxServiceProviderResource

The following elements are required:

taskBoxProxyKey (int) Task Box Proxy.
returnActionType (enum TaskBoxReturnActionType) Return Action Type.
See TaskBoxReturnActionType.
callBackIdentifier (string) Call Back Identifier.
retryCount (int) Retry Count.
state (int) State.
processId (string) Process Id.

The following elements are optional:

context (string) Context.
actionContext (string) Action Context.
asyncTaskId (Guid) Async Task Id.
titleMessage (string) Title Message.
successMessage (string) Success Message.
exception (string) Exception.


Enumerations


TaskBoxReturnActionType

1 Notification
2 Action
3 Both