| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\napi\\_version\n\n | \n\nVersion of the endpoint to access. For example, `v1` or `v2`.Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nbatch\\_request\\_id\n\n | \n\nID that identifies the batch of requests.Data type: String\n\n |
| \n\nrest\\_requests\n\n | \n\nRequired. List of request objects to include in the batch request. Data type: Array\n\n ```\n\"rest_requests\":[\n {\n \"body\": \"String\",\n \"exclude_response_headers\": Boolean,\n \"headers\":[Array],\n \"id\": \"String\",\n \"method\": \"String\",\n \"url\": \"String\"\n }\n]\n```\n\n |
| \n\nrest\\_requests.body\n\n | \n\nBase64-encoded body of the request. Only applies to methods that require a body, for example POST. Before encoding, the body can be in any format. For example, XML or JSON. Data type: String\n\n |
| \n\nrest\\_requests.exclude\\_response\\_headers\n\n | \n\nFlag that indicates whether to exclude response headers from the response.Valid values:\n\n- true: Response headers are not included in the response.\n- false: Response headers are included in the response.\n\n Data type: Boolean\n\n Default: false\n\n |
| \n\nrest\\_requests.headers\n\n | \n\nList of request header objects to send to the endpoint.Data type: Array\n\n ```\n\"headers\":[\n {\n \"name\":\"String\",\n \"value\":\"String\"\n }\n]\n```\n\n |
| \n\nrest\\_requests.headers.name\n\n | \n\nName of the header.Data type: String\n\n |
| \n\nrest\\_requests.headers.value\n\n | \n\nValue of the header.Data type: String\n\n |
| \n\nrest\\_requests.id\n\n | \n\nRequired. ID for each item in the batch.Data type: String\n\n |
| \n\nrest\\_requests.method\n\n | \n\nRequired. Method to call for the associated endpoint.Data type: String\n\n |
| \n\nrest\\_requests.url\n\n | \n\nRequired. Relative path of the endpoint to send the request to. Includes the query parameters. Data type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **multipart/mixed**.To stream multipart responses, set the **glide.rest.serialize.disable\\_response\\_stream\\_buffering** system property to true. For more information, see [Available system properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/r_AvailableSystemProperties.md).\n\n |
| \n\nContent-Type\n\n | \n\nData format of the request body. Only supports **application/json**.\n\n |
| \n\nX-BATCHREQUEST-MAX-OUTPUT-SIZE\n\n | \n\nSize limit for each item in the batch response. Add this header to provide a lower size limit than the default set by the **glide.rest.batch.max.outputSize** system property. You cannot set a value higher than the value in the system property. Default: 10 MB.\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nbatch\\_request\\_id\n\n | \n\nID of the batch that matches the **batch\\_request\\_id** parameter in the request.Data type: String\n\n |
| \n\nserviced\\_requests\n\n | \n\nList of response objects from the batch request. Data type: Array\n\n ```\n\"serviced_requests\":[\n {\n \"body\": \"String\",\n \"error_message\": \"String\",\n \"execution_time\": Number,\n \"headers\": [Array],\n \"id\": \"String\",\n \"redirect_url: \"String\",\n \"status_code\": Number,\n \"status_text\": \"String\"\n }\n]\n```\n\n |
| \n\nserviced\\_requests.body\n\n | \n\nBase64 encoded body of the response. To get the value of the body, Base64 decode the content of this parameter.Data type: String\n\n |
| \n\nserviced\\_requests.error\\_message\n\n | \n\nIf present, the error messages.Data type: String\n\n |
| \n\nserviced\\_requests.execution\\_time\n\n | \n\nTime it took to execute the batch item request.Data type: Number\n\n Unit: Milliseconds\n\n |
| \n\nserviced\\_requests.headers\n\n | \n\nHeaders for the batch item.Data type: Array\n\n ```\n\"headers\":[\n {\n \"name\":\"String\",\n \"value\":\"String\"\n }\n]\n```\n\n |
| \n\nserviced\\_requests.headers.name\n\n | \n\nName of the header.Data type: String\n\n |
| \n\nserviced\\_requests.headers.value\n\n | \n\nValue of the header.Data type: String\n\n |
| \n\nserviced\\_requests.id\n\n | \n\nID of the batch item that matches the **rest\\_requests.id** parameter in the request.Data type: String\n\n |
| \n\nserviced\\_requests.redirect\\_url\n\n | \n\nIf present, the redirect URL.Data type: String\n\n |
| \n\nserviced\\_requests.status\\_code\n\n | \n\nStatus code for the batch item.Data type: Number\n\n |
| \n\nserviced\\_requests.status\\_text\n\n | \n\nText of the status code for the batch item.Data type: String\n\n |
| \n\nunserviced\\_requests\n\n | \n\nIDs of the requests that were not processed because the batch request reached a size or processing limit. Data type: Array\n\n |