Queen's University Belfast equipment API
The equipment API from Queen's University Belfast — 28 operation(s) for equipment.
Queen’s University Belfast equipment API is one of 38 APIs that Queen’s University Belfast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include equipment. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 32 operations across 28 paths, and defines 59 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.
Requests are made against a single base URL, https://pure.qub.ac.uk/ws/api.
32 operations
28 paths
59 schemas
1 DELETE24 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Queen's University Belfast equipment API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as api-key (api-key).
By default, every request must be authenticated.
api-key— Security mechanism for the API
Paths & Operations 32
Across 28 paths, the API surfaces 32 operations — 1 DELETE, 24 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
equipment 32
GET
/equipment
Lists all equipment
PUT
/equipment
Create equipment
GET
/equipment/allowed-address-countries
A list of allowed address countries
GET
/equipment/allowed-address-subdivision
A list of allowed address subdivisions
GET
/equipment/allowed-address-types
A list of allowed address types
GET
/equipment/allowed-categories
A list of allowed categories
GET
/equipment/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/equipment/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the equipment
GET
/equipment/allowed-description-types
A list of allowed classifications for the descriptions property
GET
/equipment/allowed-email-types
A list of allowed e-mail types
GET
/equipment/allowed-image-types
A list of allowed image types
GET
/equipment/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/equipment/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/equipment/allowed-loan-types
A list of allowed loan types
GET
/equipment/allowed-locales
A list of allowed locales in localized strings
GET
/equipment/allowed-persons-roles
A list of allowed persons roles
GET
/equipment/allowed-phone-number-types
A list of allowed phone number types
GET
/equipment/allowed-types
A list of allowed equipment types
GET
/equipment/allowed-web-address-types
A list of allowed web address types
GET
/equipment/allowed-workflow-steps
A list of allowed workflow steps in localized strings
PUT
/equipment/file-uploads
Upload file to a specific equipment
POST
/equipment/search
Query operation for equipment
GET
/equipment/{uuid}
Get equipment
PUT
/equipment/{uuid}
Update equipment
DELETE
/equipment/{uuid}
Delete equipment
POST
/equipment/{uuid}/actions/lock
Lock the content
POST
/equipment/{uuid}/actions/unlock
Unlock the content
GET
/equipment/{uuid}/dependents
Lists all dependents to a piece of equipment
GET
/equipment/{uuid}/files/{fileId}
Get file from the equipment
GET
/equipment/{uuid}/fingerprints
Get the fingerprints for the equipment
GET
/equipment/{uuid}/notes
Lists notes
PUT
/equipment/{uuid}/notes
Create note
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are Equipment (42 properties), ImageFile (15 properties), Fingerprint (13 properties), ClassifiedAddress (10 properties). Each schema is shown below with its type and property counts.
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
UploadedFile
object
Information about the uploaded file
7 properties
1 required
EquipmentListResult
object
List of equipment. Can contain a subset of all items along with the full count
3 properties
EquipmentDataSetAssociation
object
An association to a dataset.
1 property
1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
StudentThesisRef
object
A reference to student thesis
1 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
Identifier
object
1 property
1 required
ClassifiedValue
object
A classified value
3 properties
2 required
DataSetRef
object
A reference to a data set
1 required
Visibility
object
Visibility of an object
2 properties
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
EquipmentPressMediaAssociation
object
An association to a press media.
1 property
1 required
EquipmentQuery
object
Create a query for equipment
6 properties
EquipmentRef
object
A reference to a piece of equipment
1 required
EquipmentPrizeAssociation
object
An association to a prize.
1 property
1 required
Note
object
A note
3 properties
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
ContentRefListResult
object
List of Content Refs
1 property
ProblemDetails
object
RFC7807 Error details
5 properties
GeoLocation
object
Geographical location
3 properties
ContentRef
object
2 properties
2 required
Fingerprint
object
A fingerprint
13 properties
1 required
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
ProjectRef
object
A reference to project
1 required
ImpactRef
object
A reference to impact
1 required
EquipmentProjectAssociation
object
An association to a project.
1 property
1 required
ImageFile
object
An image file
15 properties
2 required
EquipmentDetails
object
Details about a piece of equipment
7 properties
1 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
PageInformation
object
Information about pages
2 properties
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ResearchOutputRef
object
A reference to a research output
1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
PersonRef
object
A reference to a person internal to the institution
1 required
OrganizationRef
object
A reference to an organization in the institution
1 required
ClassificationRefList
object
List of classification references
1 property
AbstractEquipmentPersonAssociation
object
An association between equipment and a person
5 properties
1 required
ConceptRef
object
A reference to a concept
1 required
ClassifiedAddress
object
A physical address
10 properties
1 required
SystemCurrencyAmount
object
A monetary value in the Pure installation's system currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/paymentcurr…
2 properties
1 required
PrizeRef
object
A reference to a prize
1 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
PressMediaRef
object
A reference to a press/media
1 required
WorkflowListResult
object
List of workflow steps.
1 property
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
RankedConcept
object
A ranked concept
4 properties
2 required
KeywordGroup
object
4 properties
2 required
LocalesList
object
List of available locales
1 property
NoteListResult
object
List of notes
3 properties
Equipment
object
An equipment known to an institution
42 properties
7 required
Workflow
object
Information about workflow
2 properties
1 required
FingerprintListResult
object
List of fingerprints. Can contain a subset of all items along with the full count
3 properties
ClassifiedLocalizedValue
object
A classified localized value
3 properties
1 required
ActivityRef
object
A reference to an activity
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Queen's University Belfast 12
Other APIs Queen's University Belfast publishes across the network.
Queen's University Belfast Research Portal (Pure OAI-PMH)
Queen's University Belfast activity API
Queen's University Belfast application API
Queen's University Belfast authorCollaboration API
Queen's University Belfast award API
Queen's University Belfast classificationScheme API
Queen's University Belfast concept API
Queen's University Belfast conferenceSeries API
Queen's University Belfast contract API
Queen's University Belfast course API
Queen's University Belfast dataSet API
Queen's University Belfast education API
#equipment