BatchRequestSchema

A single request within a batch request.

methodstring

The HTTP method to use for this request.

Possible values: [GET, POST, PUT, DELETE]

Example: GET

urlstring

The URL to send the request to, normally starting with /api/v1/.

Important: the URL must be relative to the server base URL. No absolute URLs are allowed (those starting with http:// or https://).

Example: /api/v1/users/123

headersobject

A dictionary of headers to include in the request.

If Accept is not specified, the server will default to application/json.

Please note that the server will ignore any authentication headers within each request. The batch request itself should be authenticated using the normal authentication methods.

Example: {"Accept":"application/json"}

bodyobject

The body of the request, if any. This is only used for POST and PUT requests.

The body should be a JSON object; either embedded in the larger batch request JSON, or as a string that is the JSON-encoded body.

Example: {"username":"john_doe@example.com","fullname":"John Doe","email":"john_doe@example.com"}

paramsobject

A dictionary (object) of query parameters to include in the request. These are normally only used for GET requests, especially for collections.

Example: {"$top":10,"$next":20,"$filter":"status eq \"active\""}

BatchRequestSchema

{
  "method": "GET",
  "url": "/api/v1/users/123",
  "headers": {
    "Accept": "application/json"
  },
  "body": {
    "username": "john_doe@example.com",
    "fullname": "John Doe",
    "email": "john_doe@example.com"
  },
  "params": {
    "$top": 10,
    "$next": 20,
    "$filter": "status eq \"active\""
  }
}