Yonsei University pressMedia API
The pressMedia API from Yonsei University — 24 operation(s) for pressmedia.
The pressMedia API from Yonsei University — 24 operation(s) for pressmedia.
openapi: 3.0.1
info:
title: Pure activity pressMedia 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: pressMedia
paths:
/pressmedia:
get:
tags:
- pressMedia
summary: List all Press/Media content
description: List all Press/Media content in the Pure instance. If you need to filter which content is returned returned, see the POST version which supports additional filtering.
operationId: pressmedia_list
parameters:
- name: size
in: query
description: Number of returned Press/Media 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 /pressmedia/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PressMediaListResult'
put:
tags:
- pressMedia
summary: Create Press/Media content
description: Create Press/Media content in the Pure instance.
operationId: pressmedia_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/PressMedia'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PressMedia'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/pressmedia/allowed-categories:
get:
tags:
- pressMedia
summary: A list of allowed categories
description: Get a list of allowed categories on Press/Media content
operationId: pressmedia_getAllowedCategories
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-custom-defined-field-values/{fieldIdentifer}/classifications:
get:
tags:
- pressMedia
summary: Get allowed classifications for the custom-defined field associated with the Press/Media
description: Get allowed classifications for the custom-defined field associated with the Press/Media.
operationId: pressmedia_getAllowedCustomDefinedFieldClassifications
parameters:
- name: fieldIdentifer
in: path
description: FieldIdentifer 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'
/pressmedia/allowed-descriptions-types:
get:
tags:
- pressMedia
summary: A list of allowed description types
description: Get a list of classifications that can be used when submitting a description.
operationId: pressmedia_getAllowedDescriptionsTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-image-types:
get:
tags:
- pressMedia
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 activities
operationId: pressmedia_getAllowedImageTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-keyword-group-configurations:
get:
tags:
- pressMedia
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: pressmedia_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/pressmedia/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- pressMedia
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: pressmedia_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'
/pressmedia/allowed-locales:
get:
tags:
- pressMedia
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: pressmedia_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/pressmedia/allowed-media-coverage-types:
get:
tags:
- pressMedia
summary: A list of allowed media coverage types
description: Get a list of allowed types that can be used for the 'mediaCoverageType' attribute of media coverages on Press/Media
operationId: pressmedia_getAllowedMediaCoverageTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/APIStringListResult'
/pressmedia/allowed-media-coverages-countries:
get:
tags:
- pressMedia
summary: A list of allowed countries
description: Get a list of allowed countries for media coverages on Press/Media
operationId: pressMedia_getAllowedMediaCoveragesCountries
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-media-coverages-degree-of-recognitions:
get:
tags:
- pressMedia
summary: A list the degrees of recognition allowed on Press/Media
description: Get a list of degrees of recognition that are allowed to be used for the attribute 'mediaCoverage.degreeOfRecognition' on Press/Media.
operationId: pressMedia_getAllowedMediaCoveragesDegreeOfRecognitions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-media-coverages-media-types:
get:
tags:
- pressMedia
summary: A list of allowed media types
description: Get a list of allowed types that can be used for the 'mediaType' attribute of media coverages on Press/Media
operationId: pressmedia_getAllowedMediaCoveragesMediaTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-media-coverages-persons-roles:
get:
tags:
- pressMedia
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 Press/Media media coverage.
operationId: pressMedia_getAllowedMediaCoveragesPersonsRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-media-coverages-subdivisions:
get:
tags:
- pressMedia
summary: A list of allowed subdivisions
description: Get a list of allowed subdivisions for media coverages on Press/Media
operationId: pressMedia_getAllowedMediaCoveragesSubdivisions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-types:
get:
tags:
- pressMedia
summary: A list of allowed Press/Media types
description: Get a list of allowed types that can be used for the 'type' attribute of Press/Media
operationId: pressmedia_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/pressmedia/allowed-workflow-steps:
get:
tags:
- pressMedia
summary: A list of allowed workflow steps
description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of Press/Media content
operationId: pressmedia_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/pressmedia/file-uploads:
put:
tags:
- pressMedia
summary: Upload file to a specific Press/Media
description: Uploads file for the Press/Media with the specified UUID.
operationId: pressmedia_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'
/pressmedia/orderings:
get:
tags:
- pressMedia
summary: Lists available orderings
description: Lists all orderings available to the Press/Media endpoint. These values can be used by the order parameter.
operationId: pressmedia_getOrderings
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OrderingsList'
/pressmedia/search:
post:
tags:
- pressMedia
summary: Query operation for Press/Media content
description: Lists Press/Media content 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: pressmedia_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/PressMediaQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PressMediaListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/pressmedia/{uuid}:
get:
tags:
- pressMedia
summary: Get specific Press/Media
description: Get Press/Media with specific UUID.
operationId: pressmedia_get
parameters:
- name: uuid
in: path
description: UUID of the desired Press/Media
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PressMedia'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- pressMedia
summary: Update Press/Media
description: Update Press/Media with specific UUID.
operationId: pressmedia_update
parameters:
- name: uuid
in: path
description: UUID of the Press/Media to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/PressMedia'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PressMedia'
'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:
- pressMedia
summary: Delete specific Press/Media
description: Delete Press/Media content with specific UUID.
operationId: pressmedia_delete
parameters:
- name: uuid
in: path
description: UUID of the Press/Media
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'
/pressmedia/{uuid}/actions/lock:
post:
tags:
- pressMedia
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: pressmedia_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'
/pressmedia/{uuid}/actions/unlock:
post:
tags:
- pressMedia
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: pressmedia_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'
/pressmedia/{uuid}/files/{fileId}:
get:
tags:
- pressMedia
summary: Get file related to Press/Media
description: Get file related to Press/Media
operationId: pressmedia_getFile
parameters:
- name: uuid
in: path
description: UUID of the Press/Media
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
/pressmedia/{uuid}/notes:
get:
tags:
- pressMedia
summary: Lists notes
description: Lists notes associated with a specific Press/Media ordered by date (nulls last)
operationId: pressmedia_listNotes
parameters:
- name: uuid
in: path
description: UUID of the Press/Media 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: Press/Media not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- pressMedia
summary: Create note
description: Create note and associate it with a piece of Press/Media
operationId: pressmedia_createNote
parameters:
- name: uuid
in: path
description: UUID of the Press/Media 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
PressMediaListResult:
type: object
properties:
count:
type: integer
description: The full count, ignoring paging
format: int32
pageInformation:
$ref: '#/components/schemas/PageInformation'
items:
type: array
description: Press Media
items:
$ref: '#/components/schemas/PressMedia'
description: List of Press Media. Can contain a subset of all items along with the full count
EventRef:
required:
- uuid
type: object
description: A reference to an event
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'
ProjectRef:
required:
- uuid
type: object
description: A reference to project
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
PressMediaActivityAssociation:
required:
- activity
type: object
properties:
activity:
$ref: '#/components/schemas/ActivityRef'
description: An association to an activity.
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
UploadedFile:
required:
- key
type: object
properties:
digest:
type: string
description: The calculated digest for the file in Pure
readOnly: true
digestType:
type: string
description: The digest type
readOnly: true
size:
type: integer
description: The file size of the file in Pure
format: int64
readOnly: true
mimeType:
type: string
description: The mime type detected for the file
readOnly: true
timeStamp:
type: string
description: The timestamp Pure received the file
format: date-time
readOnly: true
expires:
type: string
description: The timestamp where Pure deletes the uploaded file if it has not been attached to any content
format: date-time
readOnly: true
key:
type: string
description: Pure key identifer for the file upload
readOnly: true
description: Information about the uploaded file
PressMediaStudentThesisAssociation:
required:
- studentThesis
type: object
properties:
studentThesis:
$ref: '#/components/schemas/StudentThesisRef'
description: An association to a student thesis.
StudentThesisRef:
required:
- uuid
type: object
description: A reference to student thesis
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
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
PressMediaPressMediaAssociation:
required:
- pressMedia
type: object
properties:
pressMedia:
$ref: '#/components/schemas/PressMediaRef'
description: An association to a press media.
PressMediaPrizeAssociation:
required:
- prize
type: object
properties:
prize:
$ref: '#/components/schemas/PrizeRef'
description: An association to a prize.
Workflow:
required:
- step
type: object
properties:
step:
type: string
description: Current workflow step
description:
$ref: '#/components/schemas/SystemLocalizedString'
description: Information about workflow
ClassifiedFormattedLocalizedValue:
required:
- type
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
value:
$ref: '#/components/schemas/FormattedLocalizedString'
type:
$ref: '#/components/schemas/ClassificationRef'
description: A classified formatted localized value
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 system name this configuration applies to
keywordGroupType:
type: string
description: The OpenAPI schema type of this keyword configuration
readOnly: true
name:
$ref: '#/components/schemas/LocalizedString'
description:
$ref: '#/components/schemas/FormattedLocalizedString'
classificationScheme:
$ref: '#/components/schemas/ClassificationSchemeRef'
allowUserdefinedKeywords:
type: boolean
description: Defines if user defined keywords are allowed
limitToLeafSelection:
type: boolean
logicalName:
type: string
relationType:
type: string
description: The schema name of the type (with the ability to associate keywords) on which the keyword group configuration is related to, e.g. StaffOrganizationAssociation. It can also be
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-pressmedia-api-openapi.yml