University of Bath equipment API
The equipment API from University of Bath — 26 operation(s) for equipment.
The equipment API from University of Bath — 26 operation(s) for equipment.
openapi: 3.0.1
info:
title: Pure activity equipment 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: equipment
paths:
/equipment:
get:
tags:
- equipment
summary: Lists all equipment
description: Lists all equipment in the Pure instance. If you need to filter the equipment returned, see the POST version which supports additional filtering.
operationId: equipment_list
parameters:
- name: size
in: query
description: Number of returned equipment 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 /equipment/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EquipmentListResult'
put:
tags:
- equipment
summary: Create equipment
description: Create equipment
operationId: equipment_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/Equipment'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Equipment'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Version conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/equipment/allowed-address-countries:
get:
tags:
- equipment
summary: A list of allowed address countries
description: Get a list of allowed countries that can be used for the 'addresses.country' attribute of equipment
operationId: equipment_getAllowedAddressCountries
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-address-subdivision:
get:
tags:
- equipment
summary: A list of allowed address subdivisions
description: Get a list of allowed subdivisions that can be used for the 'addresses.subdivisions' attribute of equipment
operationId: equipment_getAllowedAddressSubdivisions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-address-types:
get:
tags:
- equipment
summary: A list of allowed address types
description: Get a list of allowed address types that can be used for the 'addresses.type' attribute of equipment
operationId: equipment_getAllowedAddressTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-categories:
get:
tags:
- equipment
summary: A list of allowed categories
description: Get a list of allowed categories on equipment
operationId: equipment_getAllowedCategories
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-classified-identifier-types:
get:
tags:
- equipment
summary: A list of allowed classified identifier types
description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of equipment
operationId: equipment_getAllowedClassifiedIdentifierTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-custom-defined-field-values/{propertyName}/classifications:
get:
tags:
- equipment
summary: Get allowed classifications for the custom-defined field associated with the equipment
description: Get allowed classifications for the custom-defined field associated with the equipment.
operationId: equipment_getAllowedCustomDefinedFieldClassifications
parameters:
- name: propertyName
in: path
description: PropertyName 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'
/equipment/allowed-description-types:
get:
tags:
- equipment
summary: A list of allowed classifications for the descriptions property
description: Get a list of classifications that can be used when submitting a description.
operationId: equipment_getAllowedDescriptionTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-email-types:
get:
tags:
- equipment
summary: A list of allowed e-mail types
description: Get a list of allowed e-mail types that can be used for the 'emails.type' attribute of equipment
operationId: equipment_getAllowedEmailTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-image-types:
get:
tags:
- equipment
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 equipment
operationId: equipment_getAllowedImageTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-keyword-group-configurations:
get:
tags:
- equipment
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: equipment_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/equipment/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- equipment
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: equipment_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'
/equipment/allowed-loan-types:
get:
tags:
- equipment
summary: A list of allowed loan types
description: Get a list of allowed loan types that can be used for the 'loan type' attribute of equipment
operationId: equipment_getAllowedLoanTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-locales:
get:
tags:
- equipment
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: equipment_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/equipment/allowed-persons-roles:
get:
tags:
- equipment
summary: A list of allowed persons roles
description: Get a list of allowed persons roles
operationId: equipment_getAllowedPersonsRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-phone-number-types:
get:
tags:
- equipment
summary: A list of allowed phone number types
description: Get a list of allowed phone number types that can be used for the 'phoneNumbers.type' attribute of equipment
operationId: equipment_getAllowedPhoneNumberTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-types:
get:
tags:
- equipment
summary: A list of allowed equipment types
description: Get a list of allowed types that can be used for the 'type' attribute of equipment
operationId: equipment_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-web-address-types:
get:
tags:
- equipment
summary: A list of allowed web address types
description: Get a list of allowed web address types that can be used for the 'webAddresses.type' attribute of equipment
operationId: equipment_getAllowedWebAddressTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/equipment/allowed-workflow-steps:
get:
tags:
- equipment
summary: A list of allowed workflow steps in localized strings
description: Get a list of allowed workflow steps.
operationId: equipment_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/equipment/file-uploads:
put:
tags:
- equipment
summary: Upload file to a specific equipment
description: Uploads file for the equipment
operationId: equipment_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'
/equipment/search:
post:
tags:
- equipment
summary: Query operation for equipment
description: Lists equipment 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: equipment_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/EquipmentQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EquipmentListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/equipment/{uuid}:
get:
tags:
- equipment
summary: Get equipment
description: Get equipment with specific UUID.
operationId: equipment_get
parameters:
- name: uuid
in: path
description: UUID of the desired equipment
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Equipment'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- equipment
summary: Update equipment
description: Update equipment with specific UUID.
operationId: equipment_update
parameters:
- name: uuid
in: path
description: UUID of the equipment to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/Equipment'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Equipment'
'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'
delete:
tags:
- equipment
summary: Delete equipment
description: Delete equipment with specific UUID.
operationId: equipment_delete
parameters:
- name: uuid
in: path
description: UUID of the equipment
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'
/equipment/{uuid}/actions/lock:
post:
tags:
- equipment
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: equipment_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'
/equipment/{uuid}/actions/unlock:
post:
tags:
- equipment
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: equipment_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'
/equipment/{uuid}/files/{fileId}:
get:
tags:
- equipment
summary: Get file from the equipment
description: Get file from the equipment
operationId: equipment_getFile
parameters:
- name: uuid
in: path
description: UUID of the equipment
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
/equipment/{uuid}/notes:
get:
tags:
- equipment
summary: Lists notes
description: Lists notes associated with an equipment ordered by date (nulls last)
operationId: equipment_listNotes
parameters:
- name: uuid
in: path
description: UUID of the equipment 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: Application not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- equipment
summary: Create note
description: Create note and associate it with the equipment
operationId: equipment_createNote
parameters:
- name: uuid
in: path
description: UUID of the equipment to add note to
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The note to create
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
components:
schemas:
Visibility:
required:
- key
type: object
properties:
key:
type: string
description: Visibility value
enum:
- FREE
- CAMPUS
- BACKEND
- CONFIDENTIAL
description:
$ref: '#/components/schemas/SystemLocalizedString'
description: Visibility of an object
ContentRef:
required:
- systemName
- uuid
type: object
properties:
uuid:
type: string
description: UUID of the referred content
format: uuid
systemName:
type: string
nullable: true
discriminator:
propertyName: systemName
mapping:
AccessDefinition: '#/components/schemas/AccessDefinitionRef'
Activity: '#/components/schemas/ActivityRef'
Application: '#/components/schemas/ApplicationRef'
AuthorCollaboration: '#/components/schemas/AuthorCollaborationRef'
Award: '#/components/schemas/AwardRef'
ClassificationScheme: '#/components/schemas/ClassificationSchemeRef'
ConferenceSeries: '#/components/schemas/ConferenceSeriesRef'
DataSet: '#/components/schemas/DataSetRef'
Equipment: '#/components/schemas/EquipmentRef'
Event: '#/components/schemas/EventRef'
ExternalOrganization: '#/components/schemas/ExternalOrganizationRef'
ExternalPerson: '#/components/schemas/ExternalPersonRef'
Impact: '#/components/schemas/ImpactRef'
Journal: '#/components/schemas/JournalRef'
Organization: '#/components/schemas/OrganizationRef'
Person: '#/components/schemas/PersonRef'
Publisher: '#/components/schemas/PublisherRef'
PressMedia: '#/components/schemas/PressMediaRef'
Prize: '#/components/schemas/PrizeRef'
Project: '#/components/schemas/ProjectRef'
ResearchOutput: '#/components/schemas/ResearchOutputRef'
StudentThesis: '#/components/schemas/StudentThesisRef'
FundingOpportunity: '#/components/schemas/FundingOpportunityRef'
EthicalReview: '#/components/schemas/EthicalReviewRef'
ApplicationCluster: '#/components/schemas/ApplicationClusterRef'
AwardCluster: '#/components/schemas/AwardClusterRef'
User: '#/components/schemas/UserRef'
ERA2018FieldOfResearch: '#/components/schemas/Anzsrc2008FieldOfResearchRef'
UnitOfAssessmentREF2014: '#/components/schemas/Ref2014UnitOfAssessmentRef'
UnitOfAssessmentREF2020: '#/components/schemas/Ref2020UnitOfAssessmentRef'
ANZSRCTypeOfActivity: '#/components/schemas/Anzsrc2020TypeOfActivityRef'
ANZSRCFieldOfResearch: '#/components/schemas/Anzsrc2020FieldOfResearchRef'
ANZSRCSocioEconomicObjective: '#/components/schemas/Anzsrc2020SocioEconomicObjectiveRef'
Semester: '#/components/schemas/SemesterRef'
Education: '#/components/schemas/EducationRef'
Course: '#/components/schemas/CourseRef'
CurriculumVitae: '#/components/schemas/CurriculumVitaeRef'
CustomDefinedFieldConfiguration: '#/components/schemas/CustomDefinedFieldConfigurationRef'
KeywordGroupConfiguration: '#/components/schemas/KeywordGroupConfigurationRef'
Review: '#/components/schemas/ReviewRef'
GenericContentRef: '#/components/schemas/GenericContentRef'
UserProfile: '#/components/schemas/UserProfileRef'
Thesaurus: '#/components/schemas/ThesaurusRef'
Concept: '#/components/schemas/ConceptRef'
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
OrganizationOrExternalOrganizationRef:
type: object
properties:
organizationRef:
$ref: '#/components/schemas/OrganizationRef'
externalOrganizationRef:
$ref: '#/components/schemas/ExternalOrganizationRef'
description: A reference to an organization in the institution or an external organization
nullable: true
OrganizationRef:
required:
- uuid
type: object
description: A reference to an organization in the institution
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
GeoLocation:
type: object
properties:
point:
type: string
description: Location expressed as a point
nullable: true
polygon:
type: string
description: Location expressed as a polygon
nullable: true
calculatedPoint:
type: string
description: Used to determine whether or not we may update the point. An end-user has not entered a point manually if the value of the calculated point is the same as point
readOnly: true
description: Geographical location
nullable: true
Equipment:
required:
- loanType
- managingOrganization
- organizations
- 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
title:
$ref: '#/components/schemas/FormattedLocalizedString'
descriptions:
type: array
description: A collection of descriptions about or related to the equipment
nullable: true
items:
$ref: '#/components/schemas/ClassifiedFormattedLocalizedValue'
details:
type: array
description: A collection of details bout or related to the equipment
nullable: true
items:
$ref: '#/components/schemas/EquipmentDetails'
organizations:
type: array
description: A collection of affiliated organizations
items:
$ref: '#/components/schemas/OrganizationRef'
externalOrganizations:
type: array
description: A collection of external organization affiliations
nullable: true
items:
$ref: '#/components/schemas/ExternalOrganizationRef'
managingOrganization:
$ref: '#/components/schemas/OrganizationRef'
contactPersons:
type: array
description: A collection of contact persons
nullable: true
items:
$ref: '#/components/schemas/PersonRef'
addresses:
type: array
description: A collection of classified addresses
nullable: true
items:
$ref: '#/components/schemas/ClassifiedAddress'
phoneNumbers:
type: array
description: A collection of classified phone numbers
nullable: true
items:
$ref: '#/components/schemas/ClassifiedValue'
emails:
type: array
description: A collection of classified e-mail addresses
nullable: true
items:
$ref: '#/components/schemas/ClassifiedValue'
webAddresses:
type: array
description: A collection of classified web addresses
nullable: true
items:
$ref: '#/components/schemas/ClassifiedLocalizedValue'
loanType:
$ref: '#/components/schemas/ClassificationRef'
loanTerms:
$ref: '#/components/schemas/FormattedLocalizedString'
pressMedia:
type: array
description: A collection of related press media
nullable: true
items:
$ref: '#/components/schemas/EquipmentPressMediaAssociation'
visibility:
$ref: '#/components/schemas/Visibility'
keywordGroups:
type: array
description: A group for each type of keyword present
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-bath/refs/heads/main/openapi/university-of-bath-equipment-api-openapi.yml