Skip to content

Commit 5f2cc20

Browse files
committed
1 parent b29592d commit 5f2cc20

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

api/openapi-spec/v1.0.yaml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3773,6 +3773,96 @@ paths:
37733773
$ref: '#/components/schemas/application'
37743774
default:
37753775
$ref: '#/components/responses/error'
3776+
/v1.0/$batch:
3777+
post:
3778+
tags:
3779+
- batch
3780+
summary: Executes multiple requests in a single HTTP request
3781+
description: |
3782+
This endpoint allows for sending multiple Graph API requests in a single HTTP POST request.
3783+
Each request in the batch is specified in the requests array. Responses may be returned in any order and must be correlated via the id property.
3784+
operationId: RequestBatch
3785+
requestBody:
3786+
description: Batch request containing multiple individual requests.
3787+
required: true
3788+
content:
3789+
application/json:
3790+
schema:
3791+
type: object
3792+
required:
3793+
- requests
3794+
properties:
3795+
requests:
3796+
type: array
3797+
description: Array of individual requests to be processed in a batch.
3798+
items:
3799+
type: object
3800+
required:
3801+
- id
3802+
- method
3803+
- url
3804+
properties:
3805+
id:
3806+
type: string
3807+
description: A correlation value to associate individual responses with requests. This value allows the server to process requests in the batch in the most efficient order. Not case-sensitive. Must be unique in the batch.
3808+
method:
3809+
type: string
3810+
description: The HTTP method.
3811+
enum: [GET, POST, PATCH, DELETE]
3812+
url:
3813+
type: string
3814+
description: The relative resource URL for the individual request
3815+
headers:
3816+
type: object
3817+
description: 'Optional but required when the body is specified. A JSON object with the key/value pair for the headers. For example, when the ConsistencyLevel header is required, this property is represented as "headers": {"ConsistencyLevel": "eventual"}. When the body is supplied, a Content-Type header must be included.'
3818+
additionalProperties:
3819+
type: string
3820+
body:
3821+
type: string
3822+
format: binary
3823+
description: Might be a JSON object or a base64 URL-encoded value, for example, when the body is an image. When a body is included with the request, the headers object must contain a value for Content-Type.
3824+
dependsOn:
3825+
type: array
3826+
items:
3827+
type: string
3828+
description: Array of request IDs this request depends on; this request will only be executed after all specified requests have completed successfully.
3829+
responses:
3830+
'200':
3831+
description: |
3832+
Successful response with an array of responses corresponding to the batched requests.
3833+
Each response is correlated with its request by the id property.
3834+
content:
3835+
application/json:
3836+
schema:
3837+
type: object
3838+
required:
3839+
- responses
3840+
properties:
3841+
responses:
3842+
type: array
3843+
description: Array of responses for each request in the batch.
3844+
items:
3845+
type: object
3846+
required:
3847+
- id
3848+
- status
3849+
properties:
3850+
id:
3851+
type: string
3852+
description: Identifier of the response correlating to the original request's id.
3853+
status:
3854+
type: integer
3855+
description: HTTP status code of the response.
3856+
headers:
3857+
type: object
3858+
additionalProperties:
3859+
type: string
3860+
description: Headers returned by the response, if any.
3861+
body:
3862+
type: object
3863+
nullable: true
3864+
description: Body of the response if the request produced body content. The structure will depend on the request made.
3865+
37763866
/v1beta1/roleManagement/permissions/roleDefinitions:
37773867
get:
37783868
tags:

0 commit comments

Comments
 (0)