Yonsei University event API
The event API from Yonsei University — 22 operation(s) for event.
The event API from Yonsei University — 22 operation(s) for event.
openapi: 3.0.1
info:
title: Pure activity event 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: event
paths:
/events:
get:
tags:
- event
summary: Lists all events
description: Lists all events in the Pure instance. If you need to filter the events returned, see the POST version which supports additional filtering.
operationId: event_list
parameters:
- name: size
in: query
description: Number of returned events 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 /events/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EventListResult'
put:
tags:
- event
summary: Create event
description: Create event
operationId: event_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/events/allowed-classified-identifier-types:
get:
tags:
- event
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 events
operationId: event_getAllowedClassifiedIdentifierTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/events/allowed-countries:
get:
tags:
- event
summary: A list of allowed countries
description: Get a list of allowed countries that can be used for the 'country' attribute of events
operationId: event_getAllowedCountries
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/events/allowed-degree-of-recognition:
get:
tags:
- event
summary: A list of allowed degree of recognitions
description: Get a list of allowed degree of recognitions that can be used for the 'degreeOfRecognition' attribute of events
operationId: event_getAllowedDegreeOfRecognitions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/events/allowed-keyword-group-configurations:
get:
tags:
- event
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: event_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/events/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- event
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: event_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'
/events/allowed-link-types:
get:
tags:
- event
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 events
operationId: event_getAllowedLinkTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/events/allowed-locales:
get:
tags:
- event
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: event_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/events/allowed-subdivision:
get:
tags:
- event
summary: A list of allowed subdivisions
description: Get a list of allowed subdivisions can be used for the 'subdivision' attribute of events
operationId: event_getAllowedSubdivisions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/events/allowed-types:
get:
tags:
- event
summary: A list of allowed event types
description: Get a list of allowed types that can be used for the 'type' attribute of events
operationId: event_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/events/allowed-workflow-steps:
get:
tags:
- event
summary: A list of allowed workflow steps
description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of events
operationId: event_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/events/disciplines/allowed-discipline-schemes:
get:
tags:
- event
summary: A list of allowed discipline schemes
description: Get a list fo a allowed discipline schemes for events
operationId: event_getAllowedDisciplineSchemes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
/events/disciplines/{discipline-scheme}/allowed-disciplines:
get:
tags:
- event
summary: A list of allowed disciplines for a specific discipline scheme
description: Get a list of a allowed disciplines for specific discipline scheme for events
operationId: event_getAllowedDisciplines
parameters:
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme for events
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'
/events/disciplines/{discipline-scheme}/search:
post:
tags:
- event
summary: Query operation for disciplines associated with events
description: Lists disciplines from the discipline scheme associated with events in the Pure instance that matches the provided query.
operationId: event_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'
/events/orderings:
get:
tags:
- event
summary: Lists available orderings
description: Lists all orderings available to the event endpoint. These values can be used by the order parameter.
operationId: event_getOrderings
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OrderingsList'
/events/search:
post:
tags:
- event
summary: Query operation for events
description: Lists events 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: events_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/EventsQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EventListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/events/{uuid}:
get:
tags:
- event
summary: Get event
description: Get event with specific UUID.
operationId: event_get
parameters:
- name: uuid
in: path
description: UUID of the desired event
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- event
summary: Update event
description: Update event with specific UUID.
operationId: event_update
parameters:
- name: uuid
in: path
description: UUID of the event to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
'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:
- event
summary: Delete event
description: Delete event with specific UUID.
operationId: event_delete
parameters:
- name: uuid
in: path
description: UUID of the event
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'
/events/{uuid}/actions/lock:
post:
tags:
- event
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: event_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'
/events/{uuid}/actions/unlock:
post:
tags:
- event
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: event_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'
/events/{uuid}/dependents:
get:
tags:
- event
summary: Lists all dependents to an event
description: 'Lists all dependents to an event with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: event_dependents
parameters:
- name: uuid
in: path
description: UUID of the event
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'
/events/{uuid}/disciplines/{discipline-scheme}:
get:
tags:
- event
summary: Get disciplines from the discipline scheme associated with the event
description: Get disciplines from the discipline scheme associated with the event with specific UUID.
operationId: event_getDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the desired event
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:
- event
summary: Update disciplines from the discipline scheme associated with the event
description: Update disciplines from the discipline scheme associated with the event with specific UUID.
operationId: event_putDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the event 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'
/events/{uuid}/notes:
get:
tags:
- event
summary: Lists notes
description: Lists notes associated with an event ordered by date (nulls last)
operationId: event_listNotes
parameters:
- name: uuid
in: path
description: UUID of the event 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: Event not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- event
summary: Create note
description: Create note and associate it with an event
operationId: event_createNote
parameters:
- name: uuid
in: path
description: UUID of the event 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
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
EventRef:
required:
- uuid
type: object
description: A reference to an event
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
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
OrganizationRef:
required:
- uuid
type: object
description: A reference to an organization in the institution
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
GeoLocation:
type: object
properties:
point:
type: string
description: Location expressed as a point
nullable: true
polygon:
type: string
description: Location expressed as a polygon
nullable: true
calculatedPoint:
type: string
description: Used to determine whether or not we may update the point. An end-user has not entered a point manually if the value of the calculated point is the same as point
readOnly: true
description: Geographical location
nullable: true
EventListResult:
type: object
properties:
count:
type: integer
description: The full count, ignoring paging
format: int32
pageInformation:
$ref: '#/components/schemas/PageInformation'
items:
type: array
description: Events
items:
$ref: '#/components/schemas/Event'
description: List of events. Can contain a subset of all items along with the full count
ClassificationRef:
required:
- uri
type: object
properties:
uri:
type: string
description: Classification URI of the referred classification
term:
$ref: '#/components/schemas/SystemLocalizedString'
description: A reference to a classification value
nullable: true
Link:
required:
- url
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
url:
type: string
description: The URL (Uniform Resource Locator) of the link
alias:
type: string
description: A user-friendly text to show instead of the URL
nullable: true
description:
$ref: '#/components/schemas/LocalizedString'
linkType:
$ref: '#/components/schemas/ClassificationRef'
description: A hyperlink describing a location on the web.
DateRange:
type: object
properties:
startDate:
type: string
description: Start date
format: date
nullable: true
endDate:
type: string
description: End date
format: date
nullable: true
description: A date range
DisciplinesDisciplineAssignment:
required:
- disciplineId
- splitPercentage
type: object
properties:
disciplineId:
type: string
description: The assigned discipline
splitPercentage:
type: number
description: The split percentages within an assigned discipline scheme must sum up to 100%
format: double
description: The assigned discipline and its split percentage
DisciplinesDisciplineScheme:
required:
- disciplineScheme
- title
type: object
properties:
disciplineScheme:
type: string
description: The discipline scheme identifier
title:
type: string
description: The discipline title
description: A discipline scheme
LocalizedString:
type: object
additionalProperties:
type: string
description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
nullable: true
example: '{"en_GB":"Some text"}'
description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
nullable: true
example:
en_GB: Some text
Workflow:
required:
- step
type: object
properties:
step:
type: string
description: Current workflow step
description:
$ref: '#/components/schemas/SystemLocalizedString'
description: Information about workflow
AllowedKeywordGroupConfiguration:
required:
- targetSystemName
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
targetSystemName:
type: string
description: The content sys
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-event-api-openapi.yml