Yonsei University prize API
The prize API from Yonsei University — 29 operation(s) for prize.
The prize API from Yonsei University — 29 operation(s) for prize.
openapi: 3.0.1
info:
title: Pure activity prize 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: prize
paths:
/prizes:
get:
tags:
- prize
summary: Lists all prizes
description: Lists all prizes in the Pure instance. If you need to filter the prizes returned, see the POST version which supports additional filtering.
operationId: prize_list
parameters:
- name: size
in: query
description: Number of returned prizes 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 /prizes/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PrizeListResult'
put:
tags:
- prize
summary: Create prize
description: Create prize
operationId: prize_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/Prize'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Prize'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/prizes/allowed-categories:
get:
tags:
- prize
summary: A list of allowed classifications for the category property
description: Get a list of classifications that can be used when submitting a category.
operationId: prize_getAllowedCategories
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-classified-identifier-types:
get:
tags:
- prize
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 prizes
operationId: prize_getAllowedClassifiedIdentifierTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-custom-defined-field-values/{propertyName}/classifications:
get:
tags:
- prize
summary: Get allowed classifications for the custom-defined field associated with the prize
description: Get allowed classifications for the custom-defined field associated with the prize.
operationId: prize_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'
/prizes/allowed-degree-of-recognitions:
get:
tags:
- prize
summary: A list of allowed classifications for the degree of recognition
description: Get a list of classifications that can be used when submitting a degree of recognition.
operationId: prize_getAllowedDegreeOfRecognitions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-description-types:
get:
tags:
- prize
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: prize_getAllowedDescriptionsTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-document-licenses:
get:
tags:
- prize
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 prizes
operationId: prize_getAllowedDocumentLicenses
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-document-types:
get:
tags:
- prize
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 prizes
operationId: prize_getAllowedDocumentTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-image-types:
get:
tags:
- prize
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 prize.
operationId: prize_getAllowedImageTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-keyword-group-configurations:
get:
tags:
- prize
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: prize_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/prizes/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- prize
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: prize_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'
/prizes/allowed-link-types:
get:
tags:
- prize
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 prizes
operationId: prize_getAllowedLinkTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-locales:
get:
tags:
- prize
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: prize_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/prizes/allowed-receivers-of-prize-roles:
get:
tags:
- prize
summary: A list of allowed receiver of prize roles
description: Get a list of allowed receiver of prize roles that can be used for the 'receiversOfPrize.role' attribute of the prize.
operationId: prize_getAllowedReceiversOfPrizeRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-types:
get:
tags:
- prize
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: prize_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/prizes/allowed-workflow-steps:
get:
tags:
- prize
summary: A list of allowed workflow steps
description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of prizes
operationId: prize_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/prizes/disciplines/allowed-discipline-schemes:
get:
tags:
- prize
summary: A list of allowed discipline schemes
description: Get a list of allowed discipline schemes for prizes
operationId: prize_getAllowedDisciplineSchemes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
/prizes/disciplines/{discipline-scheme}/allowed-disciplines:
get:
tags:
- prize
summary: A list of allowed disciplines for a specific discipline scheme
description: Get a list of a allowed disciplines for specific discipline scheme for prizes
operationId: prize_getAllowedDisciplines
parameters:
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme for prizes
required: true
schema:
type: string
- name: size
in: query
description: Number of returned disciplines 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/DisciplinesDisciplineListResult'
/prizes/disciplines/{discipline-scheme}/search:
post:
tags:
- prize
summary: Query operation for disciplines associated with prizes
description: Lists disciplines from the discipline scheme associated with prizes in the Pure instance that matches the provided query.
operationId: prize_listDisciplineAssociations
parameters:
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociationsQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociationListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/prizes/file-uploads:
put:
tags:
- prize
summary: Upload file for a specific prize
description: Uploads file for the prize
operationId: prize_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'
/prizes/orderings:
get:
tags:
- prize
summary: Lists available orderings
description: Lists all orderings available to the prizes endpoint. These values can be used by the order parameter when listing prizes.
operationId: prize_getOrderings
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OrderingsList'
/prizes/search:
post:
tags:
- prize
summary: Query operation for prizes
description: Lists prizes 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: prize_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/PrizesQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PrizeListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/prizes/{uuid}:
get:
tags:
- prize
summary: Get prize
description: Get prize with specific UUID.
operationId: prize_get
parameters:
- name: uuid
in: path
description: UUID of the desired prize
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Prize'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- prize
summary: Update prize
description: Update prize with specific UUID.
operationId: prize_update
parameters:
- name: uuid
in: path
description: UUID of the prize to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/Prize'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Prize'
'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:
- prize
summary: Delete prize
description: Delete prize with specific UUID.
operationId: prize_delete
parameters:
- name: uuid
in: path
description: UUID of the prize
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'
/prizes/{uuid}/actions/lock:
post:
tags:
- prize
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: prize_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'
/prizes/{uuid}/actions/unlock:
post:
tags:
- prize
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: prize_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'
/prizes/{uuid}/dependents:
get:
tags:
- prize
summary: Lists all dependents to a prize
description: 'Lists all dependents to a prize with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: prize_dependents
parameters:
- name: uuid
in: path
description: UUID of the prize
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'
/prizes/{uuid}/disciplines/{discipline-scheme}:
get:
tags:
- prize
summary: Get disciplines from the discipline scheme associated with the prize
description: Get disciplines from the discipline scheme associated with the prize with specific UUID.
operationId: prize_getDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the desired prize
required: true
schema:
pattern: .+
type: string
format: uuid
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- prize
summary: Update disciplines from the discipline scheme associated with the prize
description: Update disciplines from the discipline scheme associated with the prize with specific UUID.
operationId: prize_putDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the prize to update
required: true
schema:
pattern: .+
type: string
format: uuid
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
requestBody:
description: The disciplines association to create
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
'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'
/prizes/{uuid}/files/{fileId}:
get:
tags:
- prize
summary: Get file from the prize
description: Get file from the prize
operationId: prize_getFile
parameters:
- name: uuid
in: path
description: UUID of the prize
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
/prizes/{uuid}/notes:
get:
tags:
- prize
summary: Lists notes
description: Lists notes associated with a prize ordered by date (nulls last)
operationId: prize_listNotes
parameters:
- name: uuid
in: path
description: UUID of the prize 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: prize not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- prize
summary: Create note
description: Create note and associate it with a prize
operationId: prize_createNote
parameters:
- name: uuid
in: path
description: UUID of the prize 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:
DisciplinesAssociation:
required:
- disciplineAssignments
type: object
properties:
content:
$ref: '#/components/schemas/ContentRef'
disciplineScheme:
type: string
description: The discipline scheme these disciplines are assigned from
readOnly: true
disciplineAssignments:
type: array
description: A collection of assigned disciplines
items:
$ref: '#/components/schemas/DisciplinesDisciplineAssignment'
description: An association between a content and a number of discipline assignments
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
PrizeEquipmentAssociatio
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-prize-api-openapi.yml