Marketplace
API Reference
Start typing to search…

Update a single data set catalog entry.

patch
https://api.agrimetrics.co.uk/catalog/data-sets/

Updates a single catalog entry.

Path Params
uuid
required

The ID of a dataset in the catalog

Query Params
boolean

If true, update the record directly instead of updating the draft

Body Params

The updated data set information.

string

Title for the data set.

alternativeTitles
array of strings
alternativeTitles
string
enum

Whether the data set supports self publishing.

Allowed:
string
enum

Is this dataset relevant to a Natural Capital approach?

Allowed:
string
enum

NCEA contribution to the data set.

Allowed:
string

ScoringURI for the model.

string

Endpoint key for the model.

string

Description of the data set.

string

File identifier of the metadata that is a parent to this child metadata. It supports the parent-child relationships in metadata. Allows navigation from a dataset record to the series record of which it forms a part.

integer

The level of detail of the data, i.e. if printing the data what scale would best show the data.

string | null

Any references to external information resources. Do not include links to systems (e.g. MAGIC) but do include links to documentation (flag each link internal or external).

string

To flag any sensitive or personal information contained within the data, to enable users to safely use and share the data.

string | null

A link to a data tracker record

publicationPlatform
array of strings

Which publication platforms are the data accessible from?

publicationPlatform
coupledResource
array of strings

This identifies the data resource(s) on which the service operates. Each occurrence shall be a URL that points to the metadata record of the data on which the service operates.

coupledResource
string | null

Is this dataset published externally through another publication platform?

string | null

Name of adviser who last quality checked the metadata record.

string
length ≤ 260

Summary of the data set.

derivedFrom
array | null

Data sets used to generate this data set. When updating a data set, use an array of IDs. When GETting the data set, the return type will be BasicDataSetInfo.

derivedFrom
string | null

Creator of the data set.

string | null

Free text description about the reliability of this dataset.

string | null
deprecated

License of the data set.

licence
object | null

Licensing information and access constraint

resources
array of objects | null

Links containing more information on the data set

resources
dataFormats
array of objects | null

Format of the data set

dataFormats
string | null

The geo spatial coverage of the data set.

number | null

The resolution of data set in meters.

geospatialExtent
object | null

The geospatial extent of the data on the data set

string | null

The time frame this data set covers.

temporalExtent
object
verticalExtent
object
conformity
object
string | null
enum

The sampling time period of the data set.

Allowed:
topics
array of objects
topics
workflowKeywords
array of objects

List of workflow keywords on this data set

workflowKeywords
taxonomyKeywords
array of objects

List of keywords based on specific taxonomies

taxonomyKeywords
string | null
enum

The frequency at which data set is published.

string | null

The date when the data set was issued.

number | null

Data set creation timestamp.

number | null

Data set publication timestamp.

string
enum

The publication status of this data set. Published data-sets have been approved by an admin

Allowed:
number

An timestamp of when the data in this dataset was last updated

number

Metadata last-modification timestamp.

number | null

Date when last quality check was completed.

number

If this data is licensed externally then the start date of the licence.

number

If this data is licensed externally then the end date of the licence.

tags
array of strings | null

List of tags on this data set.

tags
string
enum

Category of this data set.

Allowed:
string
enum

Whether or not this data set should be displayed in the index.

Allowed:
dataProtectionDataSet
object

Information about the GDPR data set

string

Pricing description of the data set.

distributions
array of objects
distributions
number | null

Approval for access status number

string | null
enum

Approval for access status value

contacts
array of objects

List of contacts for this data set

contacts
metadataContact
object | null

Contact for the metadata on this data set

string | null

Information about the creation and quality assurance process of the dataset

string | null

Language used on the data set

string | null

Character set used on the data set

string | null

Hierarchy level of the data set

string | null

Language used on the metadata

string | null

Character set used on the metadata

string | null
string | null
string | null

URL to the specification of the coordinate system used in the data

string | null

Type of the geospatial data

boolean

Result of the last metadata validation run

number

Timestamp of the last validation run

Response

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago