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 description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. modified: type: string format: date-time modifiedBy: type: string description: Problem details for state conflict failures ExternalOrganizationRef: required: - uuid type: object description: A reference to an organization external to the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' Identifier: required: - typeDiscriminator type: object properties: typeDiscriminator: type: string discriminator: propertyName: typeDiscriminator mapping: ClassifiedId: '#/components/schemas/ClassifiedId' PrimaryId: '#/components/schemas/PrimaryId' Id: '#/components/schemas/Id' DataSetRef: required: - uuid type: object description: A reference to a data set nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 Name: type: object properties: firstName: type: string lastName: type: string description: A name describing a person, made up of given- and family name PressMediaEquipmentAssociation: required: - equipment type: object properties: equipment: $ref: '#/components/schemas/EquipmentRef' description: An association to a piece of equipment. PressMediaPressMediaAssociation: required: - pressMedia type: object properties: pressMedia: $ref: '#/components/schemas/PressMediaRef' description: An association to a press media. EquipmentRef: required: - uuid type: object description: A reference to a piece of equipment nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 Note: required: - text type: object properties: date: type: string description: Date and time of when the note was created, an event occurred or similar. Can be any point in time, but is normally preferred format: date-time nullable: true username: type: string description: Username related to the note. Usually a username of the user creating the note. Does not have to be a username of a Pure user nullable: true text: type: string description: Note text description: A note AllowedKeywordGroupConfigurationList: type: object properties: configurations: type: array items: $ref: '#/components/schemas/AllowedKeywordGroupConfiguration' description: List of allowed keyword group configurations 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 PressMediaPrizeAssociation: required: - prize type: object properties: prize: $ref: '#/components/schemas/PrizeRef' description: An association to a prize. PressMediaProjectAssociation: required: - project type: object properties: project: $ref: '#/components/schemas/ProjectRef' description: An association to a project. ProjectRef: required: - uuid type: object description: A reference to project nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ProblemDetails: 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 description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. description: RFC7807 Error details discriminator: propertyName: type mapping: /error: '#/components/schemas/GenericProblemDetails' /validation-error: '#/components/schemas/ValidationProblemDetails' /dependency-violation-error: '#/components/schemas/DependencyViolationProblemDetails' 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' PressMediaActivityAssociation: required: - activity type: object properties: activity: $ref: '#/components/schemas/ActivityRef' description: An association to an activity. ImpactRef: required: - uuid type: object description: A reference to impact nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ImageFile: required: - fileName - mimeType 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 fileId: type: string description: The id of the file readOnly: true fileName: type: string description: The documents file name mimeType: type: string description: The documents mime type size: type: integer description: The documents size in bytes format: int64 url: type: string description: Download url for the binary file readOnly: true fileStoreLocations: type: object additionalProperties: type: string description: Locations of the binary file in file stores. readOnly: true description: Locations of the binary file in file stores. readOnly: true uploadedFile: $ref: '#/components/schemas/UploadedFile' remoteFile: $ref: '#/components/schemas/RemoteFile' fileData: type: string description: Base64 encoded file data for new files. This property can be used instead of uploadedFile for small files format: byte writeOnly: true type: $ref: '#/components/schemas/ClassificationRef' copyrightConfirmation: type: boolean description: Indicates whether this file has been confirmed to adhere to the appropriate copyrights nullable: true caption: $ref: '#/components/schemas/LocalizedString' altText: $ref: '#/components/schemas/LocalizedString' copyrightStatement: $ref: '#/components/schemas/LocalizedString' description: An image file CustomDefinedField: required: - typeDiscriminator type: object properties: typeDiscriminator: type: string description: Map of CustomDefinedField values, where the key is the field identifier nullable: true example: '{ "fieldName1": "typeDiscriminator": "Integer", "value" : 1}' discriminator: propertyName: typeDiscriminator mapping: Integer: '#/components/schemas/CustomDefinedFieldInteger' String: '#/components/schemas/CustomDefinedFieldString' Date: '#/components/schemas/CustomDefinedFieldDate' Classification: '#/components/schemas/CustomDefinedFieldClassification' Boolean: '#/components/schemas/CustomDefinedFieldBoolean' Decimal: '#/components/schemas/CustomDefinedFieldDecimal' PressMediaImpactAssociation: required: - impact type: object properties: impact: $ref: '#/components/schemas/ImpactRef' description: An association to an impact. FormattedLocalizedString: type: object additionalProperties: type: string description: A set of localized strings that support formatting. Invalid locale values will be ignored. nullable: true example: '{"en_GB":"Some text"}' description: A set of localized strings that support formatting. Invalid locale values will be ignored. nullable: true example: en_GB: Some text OrganizationRef: required: - uuid type: object description: A reference to an organization in the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' CustomDefinedFields: type: object additionalProperties: $ref: '#/components/schemas/CustomDefinedField' description: Map of CustomDefinedField values, where the key is the field identifier nullable: true example: '{ "fieldName1": "typeDiscriminator": "Integer", "value" : 1}' ResearchOutputRef: required: - uuid type: object description: A reference to a research output nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 ClassificationSchemeRef: required: - uuid type: object description: A reference to a classification scheme nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ClassificationRefList: type: object properties: classifications: type: array items: $ref: '#/components/schemas/ClassificationRef' description: List of classification references EventRef: required: - uuid type: object description: A reference to an event nullable: true allOf: - $ref: '#/components/schemas/ContentRef' PrizeRef: required: - uuid type: object description: A reference to a prize nullable: true allOf: - $ref: '#/components/schemas/ContentRef' PressMediaStudentThesisAssociation: required: - studentThesis type: object properties: studentThesis: $ref: '#/components/schemas/StudentThesisRef' description: An association to a student thesis. PressMediaResearchOutputAssociation: required: - researchOutput type: object properties: researchOutput: $ref: '#/components/schemas/ResearchOutputRef' description: An association to a research output. 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 APIStringListResult: type: object properties: items: type: array items: type: string count: type: integer format: int32 PressMediaRef: required: - uuid type: object description: A reference to a press/media nullable: true allOf: - $ref: '#/components/schemas/ContentRef' WorkflowListResult: type: object properties: workflows: type: array description: Allowed workflow steps. items: $ref: '#/components/schemas/Workflow' description: List of workflow steps. 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 set to null (default value), which means the keyword group configuration is related to the main type (the target system name) and not a relation of the main type. nullable: true description: A specification of the allowed behavior of a specified keyword group 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 MediaCoverage: required: - coverageType - date 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 coverageType: type: string description: Type value for coverage enum: - CONTRIBUTION - COVERAGE title: $ref: '#/components/schemas/FormattedLocalizedString' description: $ref: '#/components/schemas/LocalizedString' persons: type: array description: Person items: $ref: '#/components/schemas/AbstractPressMediaPersonAssociation' url: type: string description: URL related to the coverage nullable: true medium: type: string description: What medium the coverage is in nullable: true mediaType: $ref: '#/components/schemas/ClassificationRef' degreeOfRecognition: $ref: '#/components/schemas/ClassificationRef' authorProducer: type: string description: The person who authored or produced the coverage nullable: true durationLengthSize: type: string description: The extent of the Duration, length, or size of the coverage nullable: true date: type: string description: The date this coverage referred the story of the press media format: date country: $ref: '#/components/schemas/ClassificationRef' subdivision: $ref: '#/components/schemas/ClassificationRef' organizations: type: array description: Organizations associated with the coverage items: $ref: '#/components/schemas/OrganizationRef' externalOrganizations: type: array description: Organizations associated with the coverage, considered external to the system holder nullable: true items: $ref: '#/components/schemas/ExternalOrganizationRef' description: A press media coverage KeywordGroup: required: - logicalName - 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 logicalName: type: string description: Unique name of the configuration that specifies this keyword group name: $ref: '#/components/schemas/LocalizedString' typeDiscriminator: type: string discriminator: propertyName: typeDiscriminator mapping: ClassificationsKeywordGroup: '#/components/schemas/ClassificationsKeywordGroup' FreeKeywordsKeywordGroup: '#/components/schemas/FreeKeywordsKeywordGroup' FullKeywordGroup: '#/components/schemas/FullKeywordGroup' LocalesList: type: object properties: locales: pattern: /^[a-z]{2}_[A-Z]{2}$/ type: array description: Allowed locale values for use in localized string entities. The locale format consists of lower-case ISO 639 alpha-2 language code and upper-cased ISO 3166 alpha-2 country code. items: pattern: /^[a-z]{2}_[A-Z]{2}$/ type: string description: Allowed locale values for use in localized string entities. The locale format consists of lower-case ISO 639 alpha-2 language code and upper-cased ISO 3166 alpha-2 country code. description: List of available locales NoteListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Notes items: $ref: '#/components/schemas/Note' description: List of notes Workflow: required: - step type: object properties: step: type: string description: Current workflow step description: $ref: '#/components/schemas/SystemLocalizedString' description: Information about workflow OrderingsList: type: object properties: orderings: type: array description: IDs of ways content can be ordered items: type: string description: IDs of ways content can be ordered description: List of available orderings ActivityRef: required: - uuid type: object description: A reference to an activity nullable: true allOf: - $ref: '#/components/schemas/ContentRef' PressMediaQuery: type: object properties: uuids: type: array items: type: string format: uuid size: type: integer format: int32 offset: type: integer format: int32 orderings: type: array items: type: string searchString: type: string description: String used to perform search orderBy: type: string writeOnly: true description: Query for searching press media securitySchemes: api-key: type: apiKey description: Security mechanism for the API name: api-key in: header