---
updatedAt: 2025-09-26T08:55:10.000Z
agentTools:
  projectIndex: https://developer.soilhive.ag/llms.txt
---

# /datasets/{datasetId}

This resource represents an individual dataset in the system. Each dataset is identified by an integer number called `id`.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "SoilHive API Services",
    "version": "1.1.0"
  },
  "tags": [
    {
      "name": "Datasets"
    }
  ],
  "servers": [
    {
      "url": "https://api.soilhive.ag/v1",
      "description": "SoilHive API services"
    }
  ],
  "components": {
    "securitySchemes": {
      "Varda-JWT": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "A JWT access token is required."
      }
    },
    "responses": {
      "400": {
        "description": "Request is malformed. Please check parameters/payload.",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "Bad request"
                },
                "detail": {
                  "type": "string",
                  "example": "Parameter is missing"
                },
                "instance": {
                  "type": "string",
                  "example": "URI of this resource"
                }
              }
            }
          }
        }
      },
      "403": {
        "description": "Forbidden. Request is not authorized.",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "Forbidden"
                },
                "detail": {
                  "type": "string",
                  "example": "Key not authorized"
                },
                "instance": {
                  "type": "string",
                  "example": "URI of this resource"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Required data does not exist.",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "Not found"
                },
                "detail": {
                  "type": "string",
                  "example": "Resource not found"
                },
                "instance": {
                  "type": "string",
                  "example": "URI of this resource"
                }
              }
            }
          }
        }
      },
      "500": {
        "description": "There is some internal server error. Please try again.",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "Internal sever error"
                },
                "detail": {
                  "type": "string",
                  "example": "An unspecified internal server error has occurred"
                },
                "instance": {
                  "type": "string",
                  "example": "URI of this resource"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "DataSet": {
        "type": "object",
        "properties": {
          "@context": {
            "type": "string",
            "description": "the JSON-LD context of this resource",
            "example": "https://api.soilhive.ag/v1/core.jsonld"
          },
          "@id": {
            "type": "string",
            "description": "The node identifier of the resource",
            "example": "https://api.soilhive.ag/v1/datasets/17"
          },
          "identifier": {
            "type": "number",
            "description": "The dataset identifier",
            "example": 1
          },
          "type": {
            "type": "string",
            "description": "The type of resource requested, always `DataSet`",
            "example": "DataSet"
          },
          "name": {
            "type": "string",
            "description": "Name of the dataset",
            "example": "Dataset name"
          },
          "abstract": {
            "type": "string",
            "description": "An abstract about the dataset",
            "example": "This is a soil resource created by xyz"
          },
          "url": {
            "type": "string",
            "description": "Link to the original website of the dataset",
            "example": "URI of the dataSet"
          },
          "datePublished": {
            "type": "string",
            "description": "Date of publication of this dataset",
            "example": "2019-06-01"
          },
          "temporalCoverage": {
            "type": "string",
            "description": "The years' range this dataset covers",
            "example": "2001/2017"
          },
          "version": {
            "type": "string",
            "description": "The version of this dataset",
            "example": 0.3
          },
          "publisher": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of publisher",
                "example": "Organization"
              },
              "name": {
                "type": "string",
                "description": "Name of the publisher",
                "example": "FAO - Food and Agriculture Organization of the United Nations"
              },
              "url": {
                "type": "string",
                "description": "Link to the website of the publisher",
                "example": "https://www.fao.org/home/en"
              }
            }
          },
          "author": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of author",
                "example": "Organization"
              },
              "name": {
                "type": "string",
                "description": "Name of the author",
                "example": "IIASA - International Institute for Applied System Analysis"
              },
              "url": {
                "type": "string",
                "description": "Link to the website of the author",
                "example": "https://iiasa.ac.at/"
              }
            }
          },
          "spatialCoverage": {
            "description": "An object containing information about the spatial coverage of this dataset",
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the spatial coverage",
                "example": "global"
              },
              "spatialResolution": {
                "type": "string",
                "description": "Resolution of the spatial coverage",
                "example": "30 m"
              }
            }
          },
          "variableMeasured": {
            "type": "array",
            "description": "A list of objects representing the properties measured in this dataset",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of the property",
                  "example": "PropertyValue"
                },
                "name": {
                  "type": "string",
                  "description": "Name of the property",
                  "example": "Al.mehlich3"
                },
                "description": {
                  "type": "string",
                  "description": "Description of the property",
                  "example": "Clay soils have a high proportion of fine particles, primarily composed of clay minerals."
                },
                "identifier": {
                  "type": "number",
                  "description": "The unique identifier for the property",
                  "example": 1
                },
                "unitText": {
                  "type": "string",
                  "description": "The text representation of the unit in which the property is expressed",
                  "example": "meq/100g"
                },
                "unitCode": {
                  "type": "string",
                  "description": "The unit code in which the property is expressed",
                  "example": "http://qudt.org/vocab/unit/PPM"
                }
              }
            }
          },
          "measurementTechnique": {
            "type": "object",
            "description": "What measurement technique is used by the dataset",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of the measurement technique",
                "example": "DefinedTerm"
              },
              "name": {
                "type": "string",
                "description": "The name of the measurement technique",
                "example": "D2.8.III.3 INSPIRE Data Specification on Soil, soil profile category"
              },
              "termCode": {
                "type": "string",
                "description": "The termCode of measurement technique",
                "example": "DerivedSoilProfile"
              },
              "url": {
                "type": "string",
                "description": "The url of measurement technique",
                "example": "http://inspire.ec.europa.eu/featureconcept/DerivedSoilProfile"
              }
            }
          },
          "distribution": {
            "type": "object",
            "description": "An object containing information about the distribution of the dataset",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of distribution",
                "example": "DataDownload"
              },
              "encodingFormat": {
                "type": "string",
                "description": "The encoding format used for distribution",
                "example": "TIF"
              },
              "lockedForDownload": {
                "type": "boolean",
                "description": "If DataSet is available for download or not",
                "example": true
              }
            }
          },
          "gisDataType": {
            "type": "object",
            "description": "Specifies the dataset type between point, polygonal, raster",
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "GISDataType"
                ],
                "description": "Property name",
                "example": "GISDataType"
              },
              "value": {
                "type": "string",
                "enum": [
                  "point",
                  "polygonal",
                  "raster"
                ],
                "description": "The value of the dataset type",
                "example": "point"
              }
            }
          },
          "size": {
            "type": "object",
            "description": "Size of the dataset",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of the size",
                "example": "QuantitativeValue"
              },
              "value": {
                "type": "string",
                "description": "The value of the size",
                "example": "600"
              },
              "unitCode": {
                "type": "string",
                "description": "unit code of the size, files or data points",
                "example": "files"
              }
            }
          },
          "license": {
            "type": "string",
            "description": "The list of licenses this dataset is distributed under",
            "example": "CC-BY-SA-4.0"
          },
          "citation": {
            "type": "string",
            "description": "A string representing the citation of the dataset",
            "example": "Some text"
          },
          "parentProject": {
            "type": "object",
            "description": "parent project of the dataset",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of the project",
                "example": "Project"
              },
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "Unique id of the resource",
                "example": "d3e90c89-2728-4177-9b78-e9d417a8032e"
              },
              "name": {
                "type": "string",
                "description": "The name of the project",
                "example": "project-1"
              },
              "description": {
                "type": "string",
                "description": "The description of the project",
                "example": "This project has been created to help people to understand soil properties."
              },
              "memberOf": {
                "type": "object",
                "description": "member of the project",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "The type of the organization",
                    "example": "Organization"
                  },
                  "name": {
                    "type": "string",
                    "description": "The name of the organization",
                    "example": "organization-1"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "Varda-JWT": []
    }
  ],
  "paths": {
    "/datasets/{datasetId}": {
      "get": {
        "tags": [
          "Datasets"
        ],
        "description": "This resource represents an individual dataset in the system. Each dataset is identified by an integer number called `id`.",
        "parameters": [
          {
            "in": "path",
            "name": "datasetId",
            "description": "Dataset ID",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Information about the dataset",
            "content": {
              "application/ld+json": {
                "schema": {
                  "$ref": "#/components/schemas/DataSet"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    }
  }
}
```