Queen's University Belfast dataSet API
The dataSet API from Queen's University Belfast — 30 operation(s) for dataset.
Queen’s University Belfast dataSet API is one of 38 APIs that Queen’s University Belfast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include dataSet. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 34 operations across 30 paths, and defines 67 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.
Requests are made against a single base URL, https://pure.qub.ac.uk/ws/api.
34 operations
30 paths
67 schemas
1 DELETE26 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Queen's University Belfast dataSet API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as api-key (api-key).
By default, every request must be authenticated.
api-key— Security mechanism for the API
Paths & Operations 34
Across 30 paths, the API surfaces 34 operations — 1 DELETE, 26 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
dataSet 34
GET
/data-sets
Lists all data sets
PUT
/data-sets
Create data set
GET
/data-sets/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/data-sets/allowed-contributors-roles
A list of allowed contributors roles
GET
/data-sets/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the data set
GET
/data-sets/allowed-description-types
A list of allowed classifications for the descriptions property
GET
/data-sets/allowed-document-licenses
A list of allowed document licenses
GET
/data-sets/allowed-document-types
A list of allowed document types
GET
/data-sets/allowed-doi-access-types
A list of allowed access types for DOI
GET
/data-sets/allowed-doi-license-types
A list of allowed license types for DOI
GET
/data-sets/allowed-image-types
A list of allowed image types
GET
/data-sets/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/data-sets/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/data-sets/allowed-legal-condition-types
A list of allowed legal condition types
GET
/data-sets/allowed-licenses
A list of allowed licenses
GET
/data-sets/allowed-link-types
A list of allowed link types
GET
/data-sets/allowed-locales
A list of allowed locales in localized strings
GET
/data-sets/allowed-nature-types
A list of allowed nature types
GET
/data-sets/allowed-open-access-permissions
A list of allowed open access permissions
GET
/data-sets/allowed-persons-roles
A list of allowed person roles
GET
/data-sets/allowed-physical-data-types
A list of allowed physical data types
GET
/data-sets/allowed-types
A list of allowed classifications for the type property
GET
/data-sets/allowed-workflow-steps
A list of allowed workflow steps
PUT
/data-sets/file-uploads
Upload file to a specific data set
POST
/data-sets/search
Query operation for data sets
GET
/data-sets/{uuid}
Get data set
PUT
/data-sets/{uuid}
Update data set
DELETE
/data-sets/{uuid}
Delete data set
POST
/data-sets/{uuid}/actions/lock
Lock the content
POST
/data-sets/{uuid}/actions/unlock
Unlock the content
GET
/data-sets/{uuid}/dependents
Lists all dependents to a data set
GET
/data-sets/{uuid}/files/{fileId}
Get file from the data set
GET
/data-sets/{uuid}/notes
Lists notes
PUT
/data-sets/{uuid}/notes
Create note
Schemas 67
The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are DataSet (52 properties), DataSetDocument (18 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
UploadedFile
object
Information about the uploaded file
7 properties
1 required
DataSetImpactAssociation
object
An association to an impact.
1 property
1 required
DataSetDocument
object
A dataset document.
18 properties
4 required
DataSetActivityAssociation
object
An association to an activity.
1 property
1 required
DataSetsQuery
object
Create a query for data sets
6 properties
DataSet
object
A dataset
52 properties
6 required
StudentThesisRef
object
A reference to student thesis
1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
DataSetGeoLocation
object
A data set geo-location.
4 properties
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
DataSetProjectAssociation
object
An association to a project.
1 property
1 required
Identifier
object
1 property
1 required
DataSetRef
object
A reference to a data set
1 required
Visibility
object
Visibility of an object
2 properties
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
EquipmentRef
object
A reference to a piece of equipment
1 required
Note
object
A note
3 properties
1 required
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties
1 required
DataSetResearchOutputAssociation
object
An association to a research output.
1 property
1 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ContentRefListResult
object
List of Content Refs
1 property
ProblemDetails
object
RFC7807 Error details
5 properties
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
ContentRef
object
2 properties
2 required
ProjectRef
object
A reference to project
1 required
DataSetPrizeAssociation
object
An association to a prize.
1 property
1 required
ImpactRef
object
A reference to impact
1 required
DataSetDoi
object
A DOI.
5 properties
ImageFile
object
An image file
15 properties
2 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
OrganizationRef
object
A reference to an organization in the institution
1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ResearchOutputRef
object
A reference to a research output
1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
PersonRef
object
A reference to a person internal to the institution
1 required
DataSetListResult
object
List of datasets. Can contain a subset of all items along with the full count
3 properties
FundingDetails
object
Details about funding.
4 properties
PrizeRef
object
A reference to a prize
1 required
ClassificationRefList
object
List of classification references
1 property
PageInformation
object
Information about pages
2 properties
DateRange
object
A date range
2 properties
PressMediaRef
object
A reference to a press/media
1 required
OpenAccess
object
Open Access information.
3 properties
DataSetLegalCondition
object
A description of a legal condition.
3 properties
CompoundDateRange
object
A date range of that can be defined by only year, year and month or a full date
2 properties
WorkflowListResult
object
List of workflow steps.
1 property
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
DataSetEquipmentAssociation
object
An association to an equipment.
1 property
1 required
KeywordGroup
object
4 properties
2 required
LocalesList
object
List of available locales
1 property
NoteListResult
object
List of notes
3 properties
DataSetPressMediaAssociation
object
An association to a press media.
1 property
1 required
Workflow
object
Information about workflow
2 properties
1 required
DataSetPhysicalData
object
A description of physical data.
6 properties
3 required
AbstractDataSetPersonAssociation
object
An association between dataset and a person
6 properties
2 required
ClassifiedLocalizedValue
object
A classified localized value
3 properties
1 required
ActivityRef
object
A reference to an activity
1 required
DataSetStudentThesisAssociation
object
An association to a student thesis.
1 property
1 required
PublisherRef
object
A reference to a publisher
1 required
AbstractDataSetContributorAssociation
object
An association between dataset and a contributor
3 properties
1 required
DataSetAssociation
object
An association to a dataset.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Queen's University Belfast 12
Other APIs Queen's University Belfast publishes across the network.
Queen's University Belfast Research Portal (Pure OAI-PMH)
Queen's University Belfast activity API
Queen's University Belfast application API
Queen's University Belfast authorCollaboration API
Queen's University Belfast award API
Queen's University Belfast classificationScheme API
Queen's University Belfast concept API
Queen's University Belfast conferenceSeries API
Queen's University Belfast contract API
Queen's University Belfast course API
Queen's University Belfast education API
Queen's University Belfast equipment API
#dataSet