Views:

Last Updated: 1/22/2020 12:11:12 AM

Asynchronously request WFBSS Agents to update

Request

HTTP Request

POST /SMPI/{version}/service/wfbss/api/commands/update

Parameters

Name

Type

Description

Validation

Optional Parameters

cids

string

A list of customer ID separated by comma.

At least one customer ID must be specified, and no more than 10.

gids

string

A list of group IDs separated by comma. If set, only request update for specidied group.

HTTP Request Example

Request all groups to update for customers:
POST /SMPI/{version}/service/wfbss/api/commands/update?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3

Request some groups to update for customers:
POST /SMPI/{version}/service/wfbss/api/commands/update?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3&gids=1,2,3

Request Body

Do not supply a request body with this method.

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:

{
    "task": {
        "status": "PENDING",
        "id": "4cab9d44-ea63-41dd-9215-ac261a3bdcff"
    }
}

Name

Type

Description

Length

task.id

string

The ID of the asynchronous task to update global settings.

GUID

task.status

string

The status of the asynchronous task to update global settings.

PENDING, STARTED, SUCCESS, FAILURE, or REVOKED