Datasets

This section provides information about the Datasets source , listing each field available for Datasets, with details about the field value type, including whether it may be used as a facet and whether it is a multi-value field. The table also contains information about whether the field may be used in the where section and whether the field the field may be used in the entity fields filter. The page also lists the fields included in each fieldset available for Datasets, and each aggregation indicator available.

Note

By default, Datasets is sorted by the relevance, unless specified differently using Sorting Results option.

Datasets Fields

Fields are used to perform searches on the source they belong to. Note: the emptiness filters can be used on any field, irrespectively of whether filtering / faceting is enabled on them.

Field

Type

Multi?

Filter?

Facet?

Description

associated_grant_ids

Literal: string

The Dimensions IDs of the grants linked to the publication the dataset is associated with.

associated_publication

Entity: publication_links

Publication linked to the dataset (single value).

associated_publication_id

Literal: string

The Dimensions ID of the publication linked to the dataset (single value).

authors

Literal: json

Ordered list of the dataset authors. ORCIDs are included if available. 1

category_bra

Entity: categories

Broad Research Areas

category_for

Entity: categories

ANZSRC Fields of Research classification

category_hra

Entity: categories

Health Research Areas

category_hrcs_hc

Entity: categories

HRCS - Health Categories

category_hrcs_rac

Entity: categories

HRCS – Research Activity Codes

category_icrp_cso

Entity: categories

ICRP Common Scientific Outline

category_icrp_ct

Entity: categories

ICRP Cancer Types

category_rcdc

Entity: categories

Research, Condition, and Disease Categorization

category_sdg

Entity: categories

SDG - Sustainable Development Goals

date

Literal: date

The publication date of the dataset, eg “2018-01-01”.

date_created

Literal: date

The creation date of the dataset.

date_embargo

Literal: date

The embargo date of the dataset.

date_inserted

Literal: date

Date when the record was inserted into Dimensions (note: this field does not support exact match on the data, only range filters e.g. <= or `>=’).

date_modified

Literal: date

The last modification date of the dataset.

description

Literal: string

Description of the dataset.

dimensions_url

Literal: string

Link pointing to the Dimensions web application

doi

Literal: string

Dataset DOI.

figshare_url

Literal: string

Figshare URL for the dataset.

funder_countries

Entity: countries

The country linked to the organisation funding the grant, expressed as GeoNames codes.

funders

Entity: organizations

The GRID organisations funding the dataset.

id

Literal: string

Dimensions dataset ID.

journal

Entity: journals

The journal a data set belongs to.

keywords

Literal: string

Keywords used to describe the dataset (from authors).

language_desc

Literal: string

Dataset title language, as ISO 639-1 language codes.

language_title

Literal: string

Dataset title language, as ISO 639-1 language codes.

license_name

Literal: string

The dataset licence name, e.g. ‘CC BY 4.0’.

license_url

Literal: string

The dataset licence URL, e.g. ‘https://creativecommons.org/licenses/by/4.0/’.

repository

Entity: repositories

Repository associtated with the dataset.

research_org_cities

Entity: cities

City of the organisations the publication authors are affiliated to, expressed as GeoNames ID and name.

research_org_countries

Entity: countries

Country of the organisations the publication authors are affiliated to, identified using GeoNames codes (note: this field supports count: count)..

research_org_states

Entity: states

State of the organisations the publication authors are affiliated to, expressed as GeoNames codes (ISO‌-3166-2).

research_orgs

Entity: organizations

GRID organisations linked to the publication associated to the dataset (note: this field supports count: count).

researchers

Entity: researchers

Dimensions researchers IDs associated to the dataset’s associated publication. Note: in most cases, these would be the same as the dataset authors.

score

Literal: float

For full-text queries, the relevance score is a numerical value assigned to a document that indicates how relevant that document is for a given query. Note: the score is query-specific i.e. it cannot be used to compare documents across queries.

title

Literal: string

Title of the dataset.

year

Literal: integer

Year of publication of the dataset.

1

Returned objects contain: name, orcid

For example:

{
    "name": "Steffen Vogt",
    "orcid": ""
}

Datasets Fieldsets

Fieldsets are used to specify fields groups in the context of a return statement.

Fieldset

Fields

categories

category_bra category_for category_hra category_hrcs_hc category_hrcs_rac category_icrp_cso category_icrp_ct category_rcdc category_sdg

basics

authors id journal keywords title year

Datasets Indicators

Indicators are used to aggregate results in the context of a facet query.

Indicator

Description

count

Total count

Datasets Search Indexes

Search indexes are used to perform full-text searches on the source they belong to. The default search index, which is used if none other is specified, is full_data.

Search index

Supports multi-index search

Description

title_abstract_only

The keywords will be searched for in the title and description/summary.

full_data

The keyword will be searched for in all data fields that are found for that document. In cases where the full text is indexed in the background this will also be searched, even though the full text may not be available to see within Dimensions itself. This will mean that many results that are returned may not include mention of the searched keyword on the document page, but are returned in the search because the keyword can be found in the full text which cannot be read. full text documents are available for both searching and reading.

Datasets Deprecations

This section lists fields and search fields that have been deprecated and should not be used.

Warning

This fields will be supported in versions 2.2.x and removed in the next major release. To ensure full compatibility with the upcoming major release, it is recommend to stop using deprecated fields as soon as possible.

Deprecated Fields

Field

Deprecation Note

repository_id

Deprecated in favor of: repository

Partially Deprecated Fields

Datasets has no partially deprecated fields.

Deprecated Search Indexes

Datasets has no deprecated search indexes.