ROSEPEOPLE Developers - Web API Reference

People | Task Box Proxy

Service to manage entities of type 'TaskBoxProxy'.

Overview


URL api/{tenantKey}/{orgKey}/peopleCore/taskBoxProxies
Methods Supported GET, POST

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

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 /peopleCore/taskBoxProxies/checkPendingAsyncTasks

POST Operations

POST Execute

Custom operation 'Execute'.

The following elements are required:

id (Guid) Id.

Response:

When successful, the response body is empty.

Resource URL:

POST /peopleCore/taskBoxProxies/execute/{id}

Resources


TaskBoxProxyResource

The following elements are required:

taskBoxProxyKey (int) Task Box Proxy.
callBackIdentifier (string) Call Back Identifier.
retryCount (int) Retry Count.
state (int) State.
processId (string) Process Id.

The following elements are optional:

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