University of Bath publisher API
The publisher API from University of Bath — 18 operation(s) for publisher.
OpenAPI Specification
openapi: 3.0.1
info:
title: Pure activity publisher 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.33.3-3
servers:
- url: /ws/api
security:
- api-key: []
tags:
- name: publisher
paths:
/publishers:
get:
tags:
- publisher
summary: Lists all publishers
description: Lists all publishers in the Pure instance. If you need to filter the publishers returned, see the POST version which supports additional filtering.
operationId: publisher_list
parameters:
- name: size
in: query
description: Number of returned publishers 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 /publishers/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublisherListResult'
put:
tags:
- publisher
summary: Create publisher
description: Create publisher
operationId: publisher_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/Publisher'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Publisher'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/publishers/allowed-countries:
get:
tags:
- publisher
summary: A list of allowed countries
description: Get a list of allowed countries that can be used for the 'countries' attribute of publishers
operationId: publishers_getAllowedCountries
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/publishers/allowed-keyword-group-configurations:
get:
tags:
- publisher
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: publisher_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/publishers/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- publisher
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: publisher_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'
/publishers/allowed-locales:
get:
tags:
- publisher
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: publisher_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/publishers/allowed-types:
get:
tags:
- publisher
summary: A list of allowed publisher types
description: Get a list of allowed types that can be used for the 'type' attribute of publishers
operationId: publisher_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/publishers/allowed-workflow-steps:
get:
tags:
- publisher
summary: A list of allowed workflow steps
description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of publishers
operationId: publisher_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/publishers/disciplines/allowed-discipline-schemes:
get:
tags:
- publisher
summary: A list of allowed discipline schemes
description: Get a list fo a allowed discipline schemes for publishers
operationId: publisher_getAllowedDisciplineSchemes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
/publishers/disciplines/{discipline-scheme}/allowed-disciplines:
get:
tags:
- publisher
summary: A list of allowed disciplines for a specific discipline scheme
description: Get a list of a allowed disciplines for specific discipline scheme for publishers
operationId: publisher_getAllowedDisciplines
parameters:
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme for publishers
required: true
schema:
type: string
- name: size
in: query
description: Number of returned disciplines per request
schema:
maximum: 1000
type: integer
format: int32
default: 10
- name: offset
in: query
description: The offset for the returned list. 0 or null value is from the start
schema:
type: integer
format: int32
default: 0
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesDisciplineListResult'
/publishers/disciplines/{discipline-scheme}/search:
post:
tags:
- publisher
summary: Query operation for disciplines associated with publishers
description: Lists disciplines from the discipline scheme associated with publishers in the Pure instance that matches the provided query.
operationId: publisher_listDisciplineAssociations
parameters:
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociationsQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociationListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/publishers/orderings:
get:
tags:
- publisher
summary: Lists available orderings
description: Lists all orderings available to the publisher endpoint. These values can be used by the order parameter.
operationId: publisher_getOrderings
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OrderingsList'
/publishers/search:
post:
tags:
- publisher
summary: Query operation for publishers
description: Lists publishers 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: publisher_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/PublishersQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublisherListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/publishers/{uuid}:
get:
tags:
- publisher
summary: Get publisher
description: Get publisher with specific UUID.
operationId: publisher_get
parameters:
- name: uuid
in: path
description: UUID of the desired publisher
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Publisher'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- publisher
summary: Update publishers
description: Update publishers with specific UUID.
operationId: publisher_update
parameters:
- name: uuid
in: path
description: UUID of the publisher to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/Publisher'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Publisher'
'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:
- publisher
summary: Delete publisher
description: Delete publisher with specific UUID.
operationId: publisher_delete
parameters:
- name: uuid
in: path
description: UUID of the publisher
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'
/publishers/{uuid}/actions/lock:
post:
tags:
- publisher
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: publisher_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'
/publishers/{uuid}/actions/unlock:
post:
tags:
- publisher
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: publisher_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'
/publishers/{uuid}/dependents:
get:
tags:
- publisher
summary: Lists all dependents to a publisher
description: 'Lists all dependents to a publisher with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: publisher_dependents
parameters:
- name: uuid
in: path
description: UUID of the publisher
required: true
schema:
pattern: .+
type: string
format: uuid
- name: verbose
in: query
description: 'Default: false. Setting this to true will add links and names to the output but will also have an impact on performance. use with caution.'
schema:
type: boolean
default: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ContentRefListResult'
/publishers/{uuid}/disciplines/{discipline-scheme}:
get:
tags:
- publisher
summary: Get disciplines from the discipline scheme associated with the publisher
description: Get disciplines from the discipline scheme associated with the publisher with specific UUID.
operationId: publisher_getDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the desired publisher
required: true
schema:
pattern: .+
type: string
format: uuid
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- publisher
summary: Update disciplines from the discipline scheme associated with the publisher
description: Update disciplines from the discipline scheme associated with the publisher with specific UUID.
operationId: publisher_putDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the publisher to update
required: true
schema:
pattern: .+
type: string
format: uuid
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
requestBody:
description: The disciplines association to create
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/publishers/{uuid}/notes:
get:
tags:
- publisher
summary: Lists notes
description: Lists notes associated with a publisher ordered by date (nulls last)
operationId: publisher_listNotes
parameters:
- name: uuid
in: path
description: UUID of the publisher 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: Publisher not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- publisher
summary: Create note
description: Create note and associate it with a publisher
operationId: publisher_createNote
parameters:
- name: uuid
in: path
description: UUID of the publisher to add note to
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The note to create
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
components:
schemas:
DisciplinesAssociation:
required:
- disciplineAssignments
type: object
properties:
content:
$ref: '#/components/schemas/ContentRef'
disciplineScheme:
type: string
description: The discipline scheme these disciplines are assigned from
readOnly: true
disciplineAssignments:
type: array
description: A collection of assigned disciplines
items:
$ref: '#/components/schemas/DisciplinesDisciplineAssignment'
description: An association between a content and a number of discipline assignments
ContentRef:
required:
- systemName
- uuid
type: object
properties:
uuid:
type: string
description: UUID of the referred content
format: uuid
systemName:
type: string
nullable: true
discriminator:
propertyName: systemName
mapping:
AccessDefinition: '#/components/schemas/AccessDefinitionRef'
Activity: '#/components/schemas/ActivityRef'
Application: '#/components/schemas/ApplicationRef'
AuthorCollaboration: '#/components/schemas/AuthorCollaborationRef'
Award: '#/components/schemas/AwardRef'
ClassificationScheme: '#/components/schemas/ClassificationSchemeRef'
ConferenceSeries: '#/components/schemas/ConferenceSeriesRef'
DataSet: '#/components/schemas/DataSetRef'
Equipment: '#/components/schemas/EquipmentRef'
Event: '#/components/schemas/EventRef'
ExternalOrganization: '#/components/schemas/ExternalOrganizationRef'
ExternalPerson: '#/components/schemas/ExternalPersonRef'
Impact: '#/components/schemas/ImpactRef'
Journal: '#/components/schemas/JournalRef'
Organization: '#/components/schemas/OrganizationRef'
Person: '#/components/schemas/PersonRef'
Publisher: '#/components/schemas/PublisherRef'
PressMedia: '#/components/schemas/PressMediaRef'
Prize: '#/components/schemas/PrizeRef'
Project: '#/components/schemas/ProjectRef'
ResearchOutput: '#/components/schemas/ResearchOutputRef'
StudentThesis: '#/components/schemas/StudentThesisRef'
FundingOpportunity: '#/components/schemas/FundingOpportunityRef'
EthicalReview: '#/components/schemas/EthicalReviewRef'
ApplicationCluster: '#/components/schemas/ApplicationClusterRef'
AwardCluster: '#/components/schemas/AwardClusterRef'
User: '#/components/schemas/UserRef'
ERA2018FieldOfResearch: '#/components/schemas/Anzsrc2008FieldOfResearchRef'
UnitOfAssessmentREF2014: '#/components/schemas/Ref2014UnitOfAssessmentRef'
UnitOfAssessmentREF2020: '#/components/schemas/Ref2020UnitOfAssessmentRef'
ANZSRCTypeOfActivity: '#/components/schemas/Anzsrc2020TypeOfActivityRef'
ANZSRCFieldOfResearch: '#/components/schemas/Anzsrc2020FieldOfResearchRef'
ANZSRCSocioEconomicObjective: '#/components/schemas/Anzsrc2020SocioEconomicObjectiveRef'
Semester: '#/components/schemas/SemesterRef'
Education: '#/components/schemas/EducationRef'
Course: '#/components/schemas/CourseRef'
CurriculumVitae: '#/components/schemas/CurriculumVitaeRef'
CustomDefinedFieldConfiguration: '#/components/schemas/CustomDefinedFieldConfigurationRef'
KeywordGroupConfiguration: '#/components/schemas/KeywordGroupConfigurationRef'
Review: '#/components/schemas/ReviewRef'
GenericContentRef: '#/components/schemas/GenericContentRef'
UserProfile: '#/components/schemas/UserProfileRef'
Thesaurus: '#/components/schemas/ThesaurusRef'
Concept: '#/components/schemas/ConceptRef'
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
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
DisciplinesDisciplineAssignment:
required:
- disciplineId
- splitPercentage
type: object
properties:
disciplineId:
type: string
description: The assigned discipline
splitPercentage:
type: number
description: The split percentages within an assigned discipline scheme must sum up to 100%
format: double
description: The assigned discipline and its split percentage
DisciplinesDisciplineScheme:
required:
- disciplineScheme
- title
type: object
properties:
disciplineScheme:
type: string
description: The discipline scheme identifier
title:
type: string
description: The discipline title
description: A discipline scheme
LocalizedString:
type: object
additionalProperties:
type: string
description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
nullable: true
example: '{"en_GB":"Some text"}'
description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
nullable: true
example:
en_GB: Some text
Workflow:
required:
- step
type: object
properties:
step:
type: string
description: Current workflow step
description:
$ref: '#/components/schemas/SystemLocalizedString'
description: Information about workflow
AllowedKeywordGroupConfiguration:
required:
- targetSystemName
type: object
properties:
pureId:
type: integer
description: Pure database ID of the object, prefer using the UUID if it is present on the entity
format: int64
readOnly: true
targetSystemName:
type: string
description: The content 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
ClassificationSchemeRef:
required:
- uuid
type: object
description: A reference to a classification scheme
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
DisciplinesAssociationListResult:
type: object
properties:
count:
type: integer
description: The full count, ignoring paging
format: int32
pageInformation:
$ref: '#/components/schemas/PageInformation'
items:
type: array
description: Discipline associations
items:
$ref: '#/components/schemas/DisciplinesAssociation'
description: List of discipline associations. Can contain a subset of all items along with the full count
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
PublisherListResult:
type: object
properties:
count:
type: integer
description: The full count, ignoring paging
format: int32
pageInformation:
$ref: '#/components/schemas/PageInformation'
items:
type: array
description: Publishers
items:
$ref: '#/components/schemas/Publisher'
description: List of publishers. Can contain a subset of all items along with the full count
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'
AllowedKeywordGroupConfigurationList:
type: object
properties:
configurations:
type: array
items:
$ref: '#/components/schemas/AllowedKeywordGroupConfiguration'
description: List of allowed keyword group configurations
WorkflowListResult:
type: object
properties:
workflows:
type: array
description: Allowed workflow steps.
items:
$ref: '#/components/schemas/Workflow'
description: List of workflow steps.
ClassificationRefList:
type: object
properties:
classifications:
type: array
items:
$ref: '#/components/schemas/ClassificationRef'
description: List of classification references
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: /
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-bath/refs/heads/main/openapi/university-of-bath-publisher-api-openapi.yml