apify-docs/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml at 775e660cbcefc6a6c8d37ea99df6caf9a2a965ae · apify/apify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
post:
  tags:
    - Storage/Request queues
  summary: Add requests
  description: |
    Adds requests to the queue in batch. The maximum requests in batch is limit
    to 25. The response contains an array of unprocessed and processed requests.
    If any add operation fails because the request queue rate limit is exceeded
    or an internal failure occurs,
    the failed request is returned in the unprocessedRequests response
    parameter.
    You can resend these requests to add. It is recommended to use exponential
    backoff algorithm for these retries.
    If a request with the same `uniqueKey` was already present in the queue,
    then it returns an ID of the existing request.
  operationId: requestQueue_requests_batch_post
  parameters:
    - $ref: "../../components/parameters/storageParameters.yaml#/queueId"
    - $ref: "../../components/parameters/storageParameters.yaml#/clientKey"
    - $ref: "../../components/parameters/storageParameters.yaml#/forefront"
  requestBody:
    description: ""
    content:
      application/json:
        schema:
          type: array
          items:
            $ref: ../../components/schemas/request-queues/RequestWithoutId.yaml
          description: ""
    required: true
  responses:
    "201":
      description: ""
      headers: {}
      content:
        application/json:
          schema:
            $ref: ../../components/schemas/request-queues/BatchAddResponse.yaml
    "400":
      $ref: ../../components/responses/BadRequest.yaml
    "401":
      $ref: ../../components/responses/Unauthorized.yaml
    "403":
      $ref: ../../components/responses/Forbidden.yaml
    "404":
      description: Not found - the requested resource was not found.
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/common/errors/StorageErrors.yaml#/RequestQueueNotFoundError"
    "405":
      $ref: ../../components/responses/MethodNotAllowed.yaml
    "413":
      $ref: ../../components/responses/PayloadTooLarge.yaml
    "415":
      $ref: ../../components/responses/UnsupportedMediaType.yaml
    "429":
      $ref: ../../components/responses/TooManyRequests.yaml
  deprecated: false
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests
    - https://docs.apify.com/api/v2#/reference/request-queues/add-requests
    - https://docs.apify.com/api/v2#tag/Request-queuesBatch-request-operations/operation/requestQueue_requests_batch_post
  x-js-parent: RequestQueueClient
  x-js-name: batchAddRequests
  x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchAddRequests
  x-py-parent: RequestQueueClientAsync
  x-py-name: batch_add_requests
  x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#batch_add_requests
delete:
  tags:
    - Storage/Request queues
  summary: Delete requests
  description: |
    Batch-deletes given requests from the queue. The number of requests in a
    batch is limited to 25. The response contains an array of unprocessed and
    processed requests.
    If any delete operation fails because the request queue rate limit is
    exceeded or an internal failure occurs,
    the failed request is returned in the `unprocessedRequests` response
    parameter.
    You can re-send these delete requests. It is recommended to use an
    exponential backoff algorithm for these retries.
    Each request is identified by its ID or uniqueKey parameter. You can use
    either of them to identify the request.
  operationId: requestQueue_requests_batch_delete
  parameters:
    - $ref: "../../components/parameters/storageParameters.yaml#/queueId"
    - name: Content-Type
      in: header
      description: ""
      required: true
      style: simple
      schema:
        type: string
        const: application/json
    - $ref: "../../components/parameters/storageParameters.yaml#/clientKey"
  requestBody:
    description: ""
    content:
      application/json:
        schema:
          type: array
          items:
            $ref: ../../components/schemas/request-queues/RequestDraftDelete.yaml
    required: true
  responses:
    "200":
      description: ""
      headers: {}
      content:
        application/json:
          schema:
            $ref: ../../components/schemas/request-queues/BatchDeleteResponse.yaml
    "400":
      $ref: ../../components/responses/BadRequest.yaml
    "401":
      $ref: ../../components/responses/Unauthorized.yaml
    "403":
      $ref: ../../components/responses/Forbidden.yaml
    "404":
      description: Not found - the requested resource was not found.
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/common/errors/StorageErrors.yaml#/RequestQueueNotFoundError"
    "405":
      $ref: ../../components/responses/MethodNotAllowed.yaml
    "413":
      $ref: ../../components/responses/PayloadTooLarge.yaml
    "415":
      $ref: ../../components/responses/UnsupportedMediaType.yaml
    "429":
      $ref: ../../components/responses/TooManyRequests.yaml
  deprecated: false
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests
    - https://docs.apify.com/api/v2#/reference/request-queues/delete-requests
    - https://docs.apify.com/api/v2#tag/Request-queuesBatch-request-operations/operation/requestQueue_requests_batch_delete
  x-js-parent: RequestQueueClient
  x-js-name: batchDeleteRequests
  x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchDeleteRequests
  x-py-parent: RequestQueueClientAsync
  x-py-name: batch_delete_requests
  x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#batch_delete_requests