Yonsei University dataSet API
The dataSet API from Yonsei University — 30 operation(s) for dataset.
The dataSet API from Yonsei University — 30 operation(s) for dataset.
openapi: 3.0.1
info:
title: Pure activity dataSet API
description: The Pure API provides a secure and complete web services API for using and managing research information data in Pure. The API enables a broad range of use-cases for interacting with research information, from anonymous Open Data scenarios to enabling the next generation Pure admin.
termsOfService: ''
contact:
name: ''
url: ''
email: pure-support@elsevier.com
license:
name: ''
url: ''
version: 5.35.3-4
servers:
- url: https://yonsei.elsevierpure.com/ws/api
description: Yonsei University Elsevier Pure REST API
security:
- api-key: []
tags:
- name: dataSet
paths:
/data-sets:
get:
tags:
- dataSet
summary: Lists all data sets
description: Lists all data sets in the Pure instance. If you need to filter the data sets returned, see the POST version which supports additional filtering.
operationId: dataSet_list
parameters:
- name: size
in: query
description: Number of returned data sets per request.
schema:
maximum: 1000
type: integer
format: int32
default: 10
- name: offset
in: query
description: The offset for the returned list. 0 or null value is from the start
schema:
type: integer
format: int32
default: 0
- name: order
in: query
description: The order of the list, must be a value from /data sets/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataSetListResult'
put:
tags:
- dataSet
summary: Create data set
description: Create data set
operationId: dataSet_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/DataSet'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataSet'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/data-sets/allowed-classified-identifier-types:
get:
tags:
- dataSet
summary: A list of allowed classified identifier types
description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of data sets
operationId: dataSet_getAllowedClassifiedIdentifierTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-contributors-roles:
get:
tags:
- dataSet
summary: A list of allowed contributors roles
description: Get a list of allowed contributors roles that can be used for the 'contributor.role' attribute of the data set.
operationId: dataSet_getAllowedContributorsRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-custom-defined-field-values/{propertyName}/classifications:
get:
tags:
- dataSet
summary: Get allowed classifications for the custom-defined field associated with the data set
description: Get allowed classifications for the custom-defined field associated with the data set.
operationId: dataSet_getAllowedCustomDefinedFieldClassifications
parameters:
- name: propertyName
in: path
description: PropertyName for the desired custom-defined field
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/data-sets/allowed-description-types:
get:
tags:
- dataSet
summary: A list of allowed classifications for the descriptions property
description: Get a list of classifications that can be used when submitting a description.
operationId: dataSet_getAllowedDescriptionTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-document-licenses:
get:
tags:
- dataSet
summary: A list of allowed document licenses
description: Get a list of allowed license types that can be used for the 'documents.license' attribute of data sets
operationId: dataSet_getAllowedDocumentLicenses
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-document-types:
get:
tags:
- dataSet
summary: A list of allowed document types
description: Get a list of allowed license types that can be used for the 'documents.type' attribute of data sets
operationId: dataSet_getAllowedDocumentTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-doi-access-types:
get:
tags:
- dataSet
summary: A list of allowed access types for DOI
description: Get a list of allowed DOI access types on data sets
operationId: dataSet_getAllowedDoiAccessTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-doi-license-types:
get:
tags:
- dataSet
summary: A list of allowed license types for DOI
description: Get a list of allowed DOI license types on data sets
operationId: dataSet_getAllowedDoiLicenseTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-image-types:
get:
tags:
- dataSet
summary: A list of allowed image types
description: Get a list of allowed image types that can be used for the 'images.type' attribute of the data set.
operationId: dataSet_getAllowedImageTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-keyword-group-configurations:
get:
tags:
- dataSet
summary: A list of keyword group configurations
description: Get a list of allowed keyword group configurations that can be used when submitting keyword groups.
operationId: dataSet_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/data-sets/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- dataSet
summary: A list of allowed classifications for the specified keyword group
description: Get a list of allowed classifications that can be used when submitting a specified keyword group.
operationId: dataSet_getAllowedKeywordGroupConfigurationClassifications
parameters:
- name: id
in: path
description: Pure id of the keyword group configuration
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-legal-condition-types:
get:
tags:
- dataSet
summary: A list of allowed legal condition types
description: Get a list of allowed types for legal condition on data sets
operationId: dataSet_getAllowedLegalConditionsTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-licenses:
get:
tags:
- dataSet
summary: A list of allowed licenses
description: Get a list of allowed licenses on data sets
operationId: dataSet_getAllowedLicenses
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-link-types:
get:
tags:
- dataSet
summary: A list of allowed link types
description: Get a list of allowed link types that can be used for the 'links.linkType' attribute of data sets
operationId: dataSet_getAllowedLinkTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-locales:
get:
tags:
- dataSet
summary: A list of allowed locales in localized strings
description: Get a list of allowed locales that can be used when submitting localized string entities.
operationId: dataSet_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/data-sets/allowed-nature-types:
get:
tags:
- dataSet
summary: A list of allowed nature types
description: Get a list of allowed nature types for data sets.
operationId: dataSet_getAllowedNatureTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-open-access-permissions:
get:
tags:
- dataSet
summary: A list of allowed open access permissions
description: Get a list of allowed open access permissions on data sets
operationId: dataSet_getAllowedOpenAccessPermissions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-persons-roles:
get:
tags:
- dataSet
summary: A list of allowed person roles
description: Get a list of allowed person roles that can be used for the 'persons.role' attribute of the data set.
operationId: dataSet_getAllowedPersonsRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-physical-data-types:
get:
tags:
- dataSet
summary: A list of allowed physical data types
description: Get a list of allowed types for physical data on data sets
operationId: dataSet_getAllowedPhysicalDataTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-types:
get:
tags:
- dataSet
summary: A list of allowed classifications for the type property
description: Get a list of classifications that can be used when submitting a type.
operationId: dataSet_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/data-sets/allowed-workflow-steps:
get:
tags:
- dataSet
summary: A list of allowed workflow steps
description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of data sets
operationId: dataSet_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/data-sets/file-uploads:
put:
tags:
- dataSet
summary: Upload file to a specific data set
description: Uploads file for the data set
operationId: dataSet_fileUploads
parameters:
- name: Content-Type
in: header
description: Set the mime type for the file
schema:
type: string
requestBody:
content:
'*/*':
schema:
type: string
format: binary
required: true
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/UploadedFile'
application/xml:
schema:
$ref: '#/components/schemas/UploadedFile'
/data-sets/search:
post:
tags:
- dataSet
summary: Query operation for data sets
description: Lists data sets in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options.
operationId: dataSet_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/DataSetsQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataSetListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/data-sets/{uuid}:
get:
tags:
- dataSet
summary: Get data set
description: Get data set with specific UUID.
operationId: dataSet_get
parameters:
- name: uuid
in: path
description: UUID of the desired data set
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataSet'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- dataSet
summary: Update data set
description: Update data set with specific UUID.
operationId: dataSet_update
parameters:
- name: uuid
in: path
description: UUID of the data set to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/DataSet'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataSet'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Version conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
delete:
tags:
- dataSet
summary: Delete data set
description: Delete data set with specific UUID.
operationId: dataSet_delete
parameters:
- name: uuid
in: path
description: UUID of the data set
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'204':
description: Successful operation
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/data-sets/{uuid}/actions/lock:
post:
tags:
- dataSet
summary: Lock the content
description: Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API.
operationId: dataSet_lock
parameters:
- name: uuid
in: path
description: UUID of the content to lock
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'204':
description: Content marked as locked
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Content already locked
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/data-sets/{uuid}/actions/unlock:
post:
tags:
- dataSet
summary: Unlock the content
description: Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API.
operationId: dataSet_unlock
parameters:
- name: uuid
in: path
description: UUID of the content to unlock
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'204':
description: Content marked as unlocked
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Content already unlocked
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/data-sets/{uuid}/dependents:
get:
tags:
- dataSet
summary: Lists all dependents to a data set
description: 'Lists all dependents to a data set with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: dataSet_dependents
parameters:
- name: uuid
in: path
description: UUID of the data set
required: true
schema:
pattern: .+
type: string
format: uuid
- name: verbose
in: query
description: DEPRECATED - Parameter has no effect.
deprecated: true
schema:
type: boolean
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ContentRefListResult'
/data-sets/{uuid}/files/{fileId}:
get:
tags:
- dataSet
summary: Get file from the data set
description: Get file from the data set
operationId: dataSet_getFile
parameters:
- name: uuid
in: path
description: UUID of the data set
required: true
schema:
pattern: .+
type: string
format: uuid
- name: fileId
in: path
description: 'File id '
required: true
schema:
pattern: .+
type: string
responses:
'200':
description: Successful operation
content:
'*/*':
schema:
type: string
format: binary
/data-sets/{uuid}/notes:
get:
tags:
- dataSet
summary: Lists notes
description: Lists notes associated with an data set ordered by date (nulls last)
operationId: dataSet_listNotes
parameters:
- name: uuid
in: path
description: UUID of the data set to get notes for
required: true
schema:
pattern: .+
type: string
format: uuid
- name: size
in: query
description: Number of returned notes per request
schema:
maximum: 1000
type: integer
format: int32
default: 10
- name: offset
in: query
description: The offset for the returned list. 0 or null value is from the start
schema:
type: integer
format: int32
default: 0
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/NoteListResult'
'404':
description: data set not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- dataSet
summary: Create note
description: Create note and associate it with a data set
operationId: dataSet_createNote
parameters:
- name: uuid
in: path
description: UUID of the data set to add note to
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The note to create
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
components:
schemas:
Visibility:
required:
- key
type: object
properties:
key:
type: string
description: Visibility value
enum:
- FREE
- CAMPUS
- BACKEND
- CONFIDENTIAL
description:
$ref: '#/components/schemas/SystemLocalizedString'
description: Visibility of an object
ContentRef:
required:
- systemName
- uuid
type: object
properties:
uuid:
type: string
description: UUID of the referred content
format: uuid
systemName:
type: string
nullable: true
discriminator:
propertyName: systemName
mapping:
AccessDefinition: '#/components/schemas/AccessDefinitionRef'
Activity: '#/components/schemas/ActivityRef'
Application: '#/components/schemas/ApplicationRef'
AuthorCollaboration: '#/components/schemas/AuthorCollaborationRef'
Award: '#/components/schemas/AwardRef'
ClassificationScheme: '#/components/schemas/ClassificationSchemeRef'
ConferenceSeries: '#/components/schemas/ConferenceSeriesRef'
DataSet: '#/components/schemas/DataSetRef'
Equipment: '#/components/schemas/EquipmentRef'
Event: '#/components/schemas/EventRef'
ExternalOrganization: '#/components/schemas/ExternalOrganizationRef'
ExternalPerson: '#/components/schemas/ExternalPersonRef'
Impact: '#/components/schemas/ImpactRef'
Journal: '#/components/schemas/JournalRef'
Organization: '#/components/schemas/OrganizationRef'
Person: '#/components/schemas/PersonRef'
Publisher: '#/components/schemas/PublisherRef'
PressMedia: '#/components/schemas/PressMediaRef'
Prize: '#/components/schemas/PrizeRef'
Project: '#/components/schemas/ProjectRef'
ResearchOutput: '#/components/schemas/ResearchOutputRef'
StudentThesis: '#/components/schemas/StudentThesisRef'
FundingOpportunity: '#/components/schemas/FundingOpportunityRef'
EthicalReview: '#/components/schemas/EthicalReviewRef'
ApplicationCluster: '#/components/schemas/ApplicationClusterRef'
AwardCluster: '#/components/schemas/AwardClusterRef'
User: '#/components/schemas/UserRef'
ERA2018FieldOfResearch: '#/components/schemas/Anzsrc2008FieldOfResearchRef'
UnitOfAssessmentREF2014: '#/components/schemas/Ref2014UnitOfAssessmentRef'
UnitOfAssessmentREF2020: '#/components/schemas/Ref2020UnitOfAssessmentRef'
ANZSRCTypeOfActivity: '#/components/schemas/Anzsrc2020TypeOfActivityRef'
ANZSRCFieldOfResearch: '#/components/schemas/Anzsrc2020FieldOfResearchRef'
ANZSRCSocioEconomicObjective: '#/components/schemas/Anzsrc2020SocioEconomicObjectiveRef'
Semester: '#/components/schemas/SemesterRef'
Education: '#/components/schemas/EducationRef'
Course: '#/components/schemas/CourseRef'
CurriculumVitae: '#/components/schemas/CurriculumVitaeRef'
CustomDefinedFieldConfiguration: '#/components/schemas/CustomDefinedFieldConfigurationRef'
KeywordGroupConfiguration: '#/components/schemas/KeywordGroupConfigurationRef'
Review: '#/components/schemas/ReviewRef'
GenericContentRef: '#/components/schemas/GenericContentRef'
UserProfile: '#/components/schemas/UserProfileRef'
Thesaurus: '#/components/schemas/ThesaurusRef'
Concept: '#/components/schemas/ConceptRef'
PersonExpertise: '#/components/schemas/PersonExpertiseRef'
Contract: '#/components/schemas/ContractRef'
Milestone: '#/components/schemas/MilestoneRef'
Fingerprint: '#/components/schemas/FingerprintRef'
Specialization: '#/components/schemas/SpecializationRef'
StudentProject: '#/components/schemas/StudentProjectRef'
PageInformation:
type: object
properties:
offset:
type: integer
description: Offset that returned items start at
format: int32
size:
type: integer
description: The requested number of items. May be higher than the actual number of items in the result if there are fewer items in the store than requested
format: int32
description: Information about pages
DataSetPressMediaAssociation:
required:
- pressMedia
type: object
properties:
pressMedia:
$ref: '#/components/schemas/PressMediaRef'
description: An association to a press media.
DataSetPrizeAssociation:
required:
- prize
type: object
properties:
prize:
$ref: '#/components/schemas/PrizeRef'
description: An association to a prize.
CompoundDate:
required:
- year
type: object
properties:
year:
maximum: 4000
minimum: 0
type: integer
format: int32
month:
maximum: 12
minimum: 1
type: integer
format: int32
nullable: true
day:
maximum: 31
minimum: 1
type: integer
format: int32
nullable: true
description: A date that can be defined by only year, year and month or a full date
nullable: true
DataSetStudentThesisAssociation:
required:
- studentThesis
type: object
properties:
studentThesis:
$ref: '#/components/schemas/StudentThesisRef'
description: An association to a student thesis.
OrganizationOrExternalOrganizationRef:
type: object
properties:
organizationRef:
$ref: '#/components/schemas/OrganizationRef'
externalOrganizationRef:
$ref: '#/components/schemas/ExternalOrganizationRef'
description: A reference to an organization in the institution or an external organization
nullable: true
ProjectRef:
required:
- uuid
type: object
description: A reference to project
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
OrganizationRef:
required:
- uuid
type: object
description: A reference to an organization in the institution
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
FundingDetails:
type: object
properties:
pureId:
type: integer
description: Pure database ID of the object, prefer using the UUID if it is present on the entity
format: int64
readOnly: true
fundingOrganizations:
maxItems: 1
type: array
description: The internal or external funding organizations
nullable: true
items:
$ref: '#/components/schemas/OrganizationOrExternalOrganizationRef'
fundingOrganizationAcronym:
type: string
description: The acronym of the funding organization
nullable: true
fundingNumbers:
type: array
description: Funding numbers/IDs
nullable: true
items:
type: string
description: Details about funding.
DataSetsQuery:
type: object
properties:
uuids:
type: array
items:
type: string
format: uuid
size:
type: integer
format: int32
offset:
type: integer
format: int32
orderings:
type: array
items:
type: string
searchString:
type: string
description: String used to perform search
orderBy:
type: string
writeOnly: true
description: Create a query for data sets
ClassificationRef:
required:
- uri
# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-dataset-api-openapi.yml