BatchRequest

WebApiClient. BatchRequest

new BatchRequest(parameters)

Source:
See:

Request used inside batches, used for all HTTP methods

Parameters:
Name Type Description
parameters Object
Properties
Name Type Attributes Description
method String

The HTTP method such as GET, POST, ... for this request
url String

The url used for this request
payload Object <optional>

The request body for this request. Will be stringified and embedded.
headers Array.<{key:string, value:string}> <optional>

Headers to append to this request
contentId String

Content ID to set for this request

Members

contentId

Source:
Properties:
Name Type Description
contentId String

Content ID for this request. Will be set on the responses as well, to match responses with requests

headers

Source:
Properties:
Name Type Description
headers Array.<{key: string, value:string}>

Headers to append to this request

method

Source:
Properties:
Name Type Description
method String

Method of the request such as GET, POST, ...

payload

Source:
Properties:
Name Type Description
payload Object

Payload to send with this request

url

Source:
Properties:
Name Type Description
url String

URL for this request

Methods

stringify() → {String}

Source:

Converts current batch request into a string representation for including in the batch body

This:
  • {BatchRequest}
Returns:
Type
String