dataset.yaml

commonErrors: &commonErrors
  "400":
    $ref: ../../responses/BadRequest.yaml
  "401":
    $ref: ../../responses/Unauthorized.yaml
  "403":
    $ref: ../../responses/Forbidden.yaml
  "404":
    $ref: ../../responses/NotFound.yaml
  "405":
    $ref: ../../responses/MethodNotAllowed.yaml
  "429":
    $ref: ../../responses/TooManyRequests.yaml

sharedGet: &sharedGet
  responses:
    <<: *commonErrors
    "200":
      description: ""
      headers: {}
      content:
        application/json:
          schema:
            $ref: ../../schemas/datasets/DatasetResponse.yaml
  deprecated: false

getById:
  <<: *sharedGet
  tags:
    - Storage/Datasets
  summary: Get dataset
  description: |
    Returns dataset object for given dataset ID.

    This does not return dataset items, only information about the storage itself.
    To retrieve dataset items, use the [List dataset items](/api/v2/dataset-items-get) endpoint.

    :::note

    Keep in mind that attributes `itemCount` and `cleanItemCount` are not propagated right away after data are pushed into a dataset.

    :::

    There is a short period (up to 5 seconds) during which these counters may not match with exact counts in dataset items.
  operationId: dataset_get
  parameters:
    - $ref: "../../parameters/storageParameters.yaml#/datasetId"
    - name: token
      in: query
      description: |
        API authentication token. It is required only when using the `username~dataset-name` format for `datasetId`.
      style: form
      explode: true
      schema:
        type: string
        example: soSkq9ekdmfOslopH
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset
    - https://docs.apify.com/api/v2#/reference/datasets/get-dataset
    - https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_get
  x-js-parent: DatasetClient
  x-js-name: get
  x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#get
  x-py-parent: DatasetClientAsync
  x-py-name: get
  x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#get

getDefault:
  <<: *sharedGet
  tags:
    - Default storages
  summary: Get default dataset
  description: |
    Returns the default dataset associated with an Actor run.

    This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
    [Get dataset](/api/v2/dataset-get) endpoint.

  operationId: actorRun_dataset_get
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/runId"

getLastRun:
  <<: *sharedGet
  tags:
    - Last Actor run
  summary: Get last run's default dataset
  description: |
    Returns the default dataset associated with the last Actor run.

    This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
    [Get dataset](/api/v2/dataset-get) endpoint.
  operationId: act_runs_last_dataset_get
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"

sharedPut: &sharedPut
  requestBody:
    description: ""
    content:
      application/json:
        schema:
          $ref: ../../schemas/datasets/UpdateDatasetRequest.yaml
    required: true
  responses:
    <<: *commonErrors
    "200":
      description: ""
      headers: {}
      content:
        application/json:
          schema:
            $ref: ../../schemas/datasets/DatasetResponse.yaml
    "413":
      $ref: ../../responses/PayloadTooLarge.yaml
    "415":
      $ref: ../../responses/UnsupportedMediaType.yaml
  deprecated: false

putById:
  <<: *sharedPut
  tags:
    - Storage/Datasets
  summary: Update dataset
  description: |
    Updates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
    The response is the updated dataset object, as returned by the [Get dataset](/api/v2/dataset-get) API endpoint.
  operationId:
    dataset_put
  parameters:
    - $ref: "../../parameters/storageParameters.yaml#/datasetId"
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset
    - https://docs.apify.com/api/v2#/reference/datasets/update-dataset
    - https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_put
  x-js-parent: DatasetClient
  x-js-name: update
  x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#update
  x-py-parent: DatasetClientAsync
  x-py-name: update
  x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#update

putDefault:
  <<: *sharedPut
  tags:
    - Default storages
  summary: Update default dataset
  description: |
    Updates the default dataset associated with an Actor run.

    This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
    [Put dataset](/api/v2/dataset-put) endpoint.

  operationId: actorRun_dataset_put
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/runId"

putLastRun:
  <<: *sharedPut
  tags:
    - Last Actor run
  summary: Update last run's default dataset
  description: |
    Updates the default dataset associated with the last Actor run.

    This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
    [Update dataset](/api/v2/dataset-put) endpoint.
  operationId: act_runs_last_dataset_put
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"

sharedDelete: &sharedDelete
  responses:
    <<: *commonErrors
    "204":
      $ref: ../../responses/NoContent.yaml
  deprecated: false

deleteById:
  <<: *sharedDelete
  tags:
    - Storage/Datasets
  summary: Delete dataset
  description: Deletes a specific dataset.
  operationId: dataset_delete
  parameters:
    - $ref: "../../parameters/storageParameters.yaml#/datasetId"
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset
    - https://docs.apify.com/api/v2#/reference/datasets/delete-dataset
    - https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_delete
  x-js-parent: DatasetClient
  x-js-name: delete
  x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#delete

deleteDefault:
  <<: *sharedDelete
  tags:
    - Default storages
  summary: Delete default dataset
  description: |
    Deletes default dataset associated with an Actor run.

    This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
    [ Delete dataset ](/api/v2/dataset-delete) endpoint.
  operationId: actorRun_dataset_delete
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/runId"

deleteLastRun:
  <<: *sharedDelete
  tags:
    - Last Actor run
  summary: Delete last run's default dataset
  description: |
    Deletes the default dataset associated with the last Actor run.

    This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
    [Delete dataset](/api/v2/dataset-delete) endpoint.
  operationId: act_runs_last_dataset_delete
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"