Vrije Universiteit Amsterdam pressMedia API
The pressMedia API from Vrije Universiteit Amsterdam — 24 operation(s) for pressmedia.
The pressMedia API from Vrije Universiteit Amsterdam — 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.34.3
servers:
- url: https://research.vu.nl/ws/api
description: VU Amsterdam Pure REST web service (API key required)
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:
AbstractPressMediaPersonAssociation:
required:
- typeDiscriminator
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
externalOrganizations:
type: array
description: A collection of external organization affiliations.
nullable: true
items:
$ref: '#/components/schemas/ExternalOrganizationRef'
name:
$ref: '#/components/schemas/Name'
role:
$ref: '#/components/schemas/ClassificationRef'
typeDiscriminator:
type: string
description: An association between press media and a person
discriminator:
propertyName: typeDiscriminator
mapping:
InternalPressMediaPersonAssociation: '#/components/schemas/InternalPressMediaPersonAssociation'
ExternalPressMediaPersonAssociation: '#/components/schemas/ExternalPressMediaPersonAssociation'
SystemLocalizedString:
type: object
additionalProperties:
type: string
description: A set of localized string values each for a specific UI locale.
nullable: true
example: '{"en_GB":"Some text"}'
description: A set of localized string values each for a specific UI locale.
nullable: true
example:
en_GB: Some text
RemoteFile:
required:
- fileId
- fileState
- sourceId
- storeName
type: object
properties:
sourceId:
type: string
description: The remote source ID
storeName:
type: string
description: The name of the remote store
timeStamp:
type: string
description: The timestamp at which the file was stored
format: date-time
fileId:
type: string
description: The remote file ID
fileState:
type: string
description: The remote file state
enum:
- AWAITING_CREATION
- CREATION_IN_PROGRESS
- CREATION_FAILED
- STORED
- AWAITING_DELETE
- DELETE_IN_PROGRESS
- DELETE_FAILED
- DELETED
metadataUpdateRequired:
type: boolean
description: Whether the file's metadata should be updated
default: false
description: Information about a remote file (Elsevier only)
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
PressMediaDataSetAssociation:
required:
- dataSet
type: object
properties:
dataSet:
$ref: '#/components/schemas/DataSetRef'
description: An association to a dataset.
PressMedia:
required:
- mediaCoverages
- title
- type
- visibility
- workflow
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
uuid:
type: string
description: UUID, this is the primary identity of the entity
format: uuid
readOnly: true
createdBy:
type: string
description: Username of creator
readOnly: true
createdDate:
type: string
description: Date and time of creation
format: date-time
readOnly: true
modifiedBy:
type: string
description: Username of the user that performed a modification
readOnly: true
modifiedDate:
type: string
description: Date and time of last modification
format: date-time
readOnly: true
portalUrl:
type: string
description: URL of the content on the Pure Portal
readOnly: true
prettyUrlIdentifiers:
type: array
description: All pretty URLs
readOnly: true
items:
type: string
description: All pretty URLs
readOnly: true
previousUuids:
type: array
description: UUIDs of other content items which have been merged into this content item (or similar)
readOnly: true
items:
type: string
description: UUIDs of other content items which have been merged into this content item (or similar)
readOnly: true
version:
type: string
description: Used to guard against conflicting updates. For new content this is null, and for existing content the current value. The property should never be modified by a client, except in the rare case where the client wants to perform an update irrespective of if other clients have made updates in the meantime, also known as a "dirty write". A dirty write is performed by not including the property value or setting the property to null
nullable: true
category:
$ref: '#/components/schemas/ClassificationRef'
title:
$ref: '#/components/schemas/FormattedLocalizedString'
mediaCoverages:
type: array
description: MediaCoverages
items:
$ref: '#/components/schemas/MediaCoverage'
keywordGroups:
type: array
description: Groups of keywords associated with the press media.
nullable: true
items:
$ref: '#/components/schemas/KeywordGroup'
type:
$ref: '#/components/schemas/ClassificationRef'
visibility:
$ref: '#/components/schemas/Visibility'
event:
$ref: '#/components/schemas/EventRef'
workflow:
$ref: '#/components/schemas/Workflow'
descriptions:
type: array
description: A list of descriptions for this press media. Query the relevant /press-media/allowed-*-description-types endpoint for allowed types.
nullable: true
items:
$ref: '#/components/schemas/ClassifiedFormattedLocalizedValue'
customDefinedFields:
$ref: '#/components/schemas/CustomDefinedFields'
images:
type: array
description: Image files with a maximum file size of 1MB
nullable: true
items:
$ref: '#/components/schemas/ImageFile'
managingOrganization:
$ref: '#/components/schemas/OrganizationRef'
identifiers:
type: array
description: Identifiers related to the project.
nullable: true
items:
$ref: '#/components/schemas/Identifier'
activities:
type: array
description: A collection of related activities.
nullable: true
items:
$ref: '#/components/schemas/PressMediaActivityAssociation'
dataSets:
type: array
description: A collection of related datasets.
nullable: true
items:
$ref: '#/components/schemas/PressMediaDataSetAssociation'
equipment:
type: array
description: A collection of related equipment.
nullable: true
items:
$ref: '#/components/schemas/PressMediaEquipmentAssociation'
impacts:
type: array
description: A collection of related impacts.
nullable: true
items:
$ref: '#/components/schemas/PressMediaImpactAssociation'
pressMedia:
type: array
description: A collection of related press media.
nullable: true
items:
$ref: '#/components/schemas/PressMediaPressMediaAssociation'
prizes:
type: array
description: A collection of related prizes.
nullable: true
items:
$ref: '#/components/schemas/PressMediaPrizeAssociation'
projects:
type: array
description: A collection of related projects.
nullable: true
items:
$ref: '#/components/schemas/PressMediaProjectAssociation'
researchOutputs:
type: array
description: A collection of related research outputs.
nullable: true
items:
$ref: '#/components/schemas/PressMediaResearchOutputAssociation'
studentTheses:
type: array
description: A collection of related student theses.
nullable: true
items:
$ref: '#/components/schemas/PressMediaStudentThesisAssociation'
systemName:
type: string
description: The content system name
readOnly: true
description: A piece of press, media, or other sort of news clipping.
StudentThesisRef:
required:
- uuid
type: object
description: A reference to student thesis
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
ConflictProblemDetails:
type: object
properties:
type:
type: string
description: A URI reference [RFC3986] that identifies the problem type.
title:
type: string
description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
status:
type: integer
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vrije-universiteit-amsterdam/refs/heads/main/openapi/vrije-universiteit-amsterdam-pressmedia-api-openapi.yml