Marketplace
API Reference

Create a single data set catalog entry.

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

Creates a single catalog entry.

Body Params

The data set to create.

uuid

The ID of a dataset in the catalog

string
enum
required

The type of the entry, data set or model

Allowed:
string
enum
Allowed:
string
required

Title for the data set.

alternativeTitles
array of strings
alternativeTitles
string
required

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).

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

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

publicationPlatform
array of strings

Which publication platforms are the data accessible from?

publicationPlatform
string | null

Is this dataset published externally through another publication platform?

string | null

Name of adviser who last quality checked the metadata record.

string | null

A link to a data tracker record

string

Scoring URI of the model.

string

Endpoint key for the model.

boolean

Whether the current user is the owner of this data set.

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

The ID of the publisher.

number

Data set creation timestamp.

number

Data set publication timestamp.

number

Metadata last-modification timestmap.

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.

usedBy
array of objects

Other data sets using this data set.

usedBy
derivedFrom
array

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
entitlements
array of objects

Entitlements for the current user.

entitlements
Allowed:
entitlementsByIdentity
object

Array of entitlements by user identity.

string
length ≤ 260

Summary of the data set.

string

Creator of the data set.

string

Free text description about the reliability of this dataset.

string
deprecated

License of the data set.

licence
object

Licence and use limitations.

string
deprecated

DEPRECATED. This has been replaced with the resources attribute. Reference URI of the data set.

resources
array of objects

Links containing more information on the data set

resources
dataFormats
array of objects

Format of the data set

dataFormats
string

Pricing description of the data set.

string

The geo spatial coverage of the data set.

number

The resolution of data set in meters.

geospatialExtent
object

The geospatial extent of the data on the data set

verticalExtent
object
conformity
object
string

The time frame this data set covers.

string
enum

The sampling time period of the data set.

Allowed:
string
enum

The frequency at which data set is published.

distributions
array of objects
distributions
string

The date when the data set was issued.

number

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

keywords
array of strings
deprecated

List of keywords on this data set. keywords is deprecated - use tags instead

keywords
tags
array of strings

List of tags on this data set.

tags
topics
array of objects

List of topics on this data set

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
enum

Category of this data set.

Allowed:
string
enum

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

Allowed:
concepts
array of strings

List of concepts on this data set. Check the concepts endpoint to see valid values.

concepts
dataSet
object

Information about the file data set

dataProtectionDataSet
object

Information about the GDPR data set

services
array of objects

List of services available on the data set

services
sampleData
object

Optional location to download sample data

image
object

A data set image.

string

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

string

Type of the geospatial data

string

Information about the creation and quality assurance process of the dataset

string

Information about which template was used to create the dataset record

contacts
array of objects

List of contacts for this data set

contacts
metadataContact
object

Contact for the metadata on this data set

publicContact
object

Public contact for the metadata on this data set

number

Approval for access status number

string
enum

Approval for access status value

string

Language used on the data set

string

Character set used on the data set

string

Hierarchy level of the data set

string

Language used on the metadata

string

Character set used on the metadata

string
string
string
enum

The workflow status of this data set's draft

Allowed:
string

Any notes added during review of the data set

string
enum

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

Allowed:
string

Update freequecny freq:annual, freq:bimonthly

string
enum

A rights statement that concerns how the distribution is accessed

Allowed:
string

The version indicator (name or identifier) of a resource.

string

A description of the services available via the end-points, including their operations, parameters etc.

string
enum

An information security designation that identifies the minimum level of protection assigned to an information resource.

Allowed:
servesData
array of strings

A collection of data that this data service can distribute

servesData
relatedResource
array of strings

A resource that bears a close relationship to the described resource

relatedResource
theme
array of objects
theme
securityClassifications
array of strings

An information security designation that identifies the minimum level of protection assigned to an information resource.

securityClassifications
string

A unique identifier of the resource being described or catalogued.

string
enum

The nature or genre of the resource

Allowed:
string
enum

The status of the resource in the context of a particular workflow process

boolean

Indicates if the dataset is a draft

boolean

Result of the last metadata validation run

number

Timestamp of the last validation run

string

The dataset that this draft was created from

Response

Updated 9 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago