Initiates workflow to unpost multiple batches

Request

This method will initiate the batch unposting process for one or more supplied batches

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed

Bodyapplication/jsonrequired

Paylaod containing the batches to unpost and other options

batch_idsArray of strings, non-empty(Batches)required

The IDs of the batches to post

business_unit_idstring(Business Unit)required

The business unit

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batchPosting/{tenantId}/batchUnpostingRequest' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batch_ids": [
      "string"
    ],
    "business_unit_id": "string"
  }'

Responses

An execution ARN to be used to monitor the batch unposting process.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring, (date-time)(Start Date)

The start date of the execution

Response

{
  "executionArn": "string",
  "notification_channel": "string",
  "notification_publishKey": "string",
  "notification_subscribeKey": "string",
  "start_date": "2019-08-24T14:15:22Z"
}