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.35.1-2 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: 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 EquipmentListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Equipment items: $ref: '#/components/schemas/Equipment' description: List of equipment. Can contain a subset of all items along with the full count EquipmentDataSetAssociation: required: - dataSet type: object properties: dataSet: $ref: '#/components/schemas/DataSetRef' description: An association to a dataset. 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 StudentThesisRef: required: - uuid type: object description: A reference to student thesis nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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' ClassifiedValue: required: - type - value 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: type: string description: Classified value type: $ref: '#/components/schemas/ClassificationRef' description: A classified value 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 EquipmentPressMediaAssociation: required: - pressMedia type: object properties: pressMedia: $ref: '#/components/schemas/PressMediaRef' description: An association to a press media. EquipmentQuery: 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: Create a query for equipment EquipmentRef: required: - uuid type: object description: A reference to a piece of equipment nullable: true allOf: - $ref: '#/components/schemas/ContentRef' EquipmentPrizeAssociation: required: - prize type: object properties: prize: $ref: '#/components/schemas/PrizeRef' description: An association to a prize. 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 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 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 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' 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 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' Specialization: '#/components/schemas/SpecializationRef' StudentProject: '#/components/schemas/StudentProjectRef' 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 ProjectRef: required: - uuid type: object description: A reference to project nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ImpactRef: required: - uuid type: object description: A reference to impact nullable: true allOf: - $ref: '#/components/schemas/ContentRef' EquipmentProjectAssociation: required: - project type: object properties: project: $ref: '#/components/schemas/ProjectRef' description: An association to a project. 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 EquipmentDetails: required: - name 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 name: $ref: '#/components/schemas/FormattedLocalizedString' identifiers: type: array description: IDs associated with this object. Such as serial number, manufacturer id , internal id. nullable: true items: $ref: '#/components/schemas/Identifier' acquisitionDate: type: string description: Acquisition date format: date nullable: true decommissionDate: type: string description: Decommission date format: date nullable: true value: $ref: '#/components/schemas/SystemCurrencyAmount' manufacturers: type: array description: A collection of manufacturers nullable: true items: $ref: '#/components/schemas/OrganizationOrExternalOrganizationRef' description: Details about a piece of equipment 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' 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 ClassificationSchemeRef: required: - uuid type: object description: A reference to a classification scheme 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 ResearchOutputRef: required: - uuid type: object description: A reference to a research output 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}' PersonRef: required: - uuid type: object description: A reference to a person internal to the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' OrganizationRef: required: - uuid type: object description: A reference to an organization in the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ClassificationRefList: type: object properties: classifications: type: array items: $ref: '#/components/schemas/ClassificationRef' description: List of classification references AbstractEquipmentPersonAssociation: 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 equipment and a person discriminator: propertyName: typeDiscriminator mapping: InternalEquipmentPersonAssociation: '#/components/schemas/InternalEquipmentPersonAssociation' ExternalEquipmentPersonAssociation: '#/components/schemas/ExternalEquipmentPersonAssociation' ClassifiedAddress: required: - addressType 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 addressType: $ref: '#/components/schemas/ClassificationRef' addressLines: type: string description: Address for personal residence nullable: true street: type: string description: The name of the street nullable: true building: type: string description: The name of the building nullable: true postalcode: type: string description: The postal code of the city nullable: true city: type: string description: The name of the city nullable: true country: $ref: '#/components/schemas/ClassificationRef' subdivision: $ref: '#/components/schemas/ClassificationRef' geoLocation: $ref: '#/components/schemas/GeoLocation' description: A physical address SystemCurrencyAmount: required: - value type: object properties: currency: type: string description: 'An ISO-4217 3-letter alphabetic code representing the Pure installation''s system currency as defined by the W3C''s Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-currency' readOnly: true value: type: string description: 'A valid decimal monetary value as defined by the W3C''s Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-value' format: ^-?[0-9]+(\.[0-9]+)?$ description: '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/#paymentcurrencyamount-dictionary' PrizeRef: required: - uuid type: object description: A reference to a prize nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 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. 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 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 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 nullable: true items: $ref: '#/components/schemas/KeywordGroup' type: $ref: '#/components/schemas/ClassificationRef' workflow: $ref: '#/components/schemas/Workflow' images: type: array description: Image files with a maximum file size of 1MB nullable: true items: $ref: '#/components/schemas/ImageFile' persons: type: array description: The persons that the equipment is associated with nullable: true items: $ref: '#/components/schemas/AbstractEquipmentPersonAssociation' researchOutputRelations: type: array description: A collection of research output relations nullable: true items: $ref: '#/components/schemas/ResearchOutputRef' impactRelations: type: array description: A collection of impacts relations nullable: true items: $ref: '#/components/schemas/ImpactRef' studentThesisRelations: type: array description: A collection of student thesis relations nullable: true items: $ref: '#/components/schemas/StudentThesisRef' activityRelations: type: array description: A collection of activity relations nullable: true items: $ref: '#/components/schemas/ActivityRef' prizes: type: array description: A collection of related prizes nullable: true items: $ref: '#/components/schemas/EquipmentPrizeAssociation' projects: type: array description: A collection of related projects nullable: true items: $ref: '#/components/schemas/EquipmentProjectAssociation' datasets: type: array description: A collection of related data sets nullable: true items: $ref: '#/components/schemas/EquipmentDataSetAssociation' parents: type: array description: A collection of parent equipments nullable: true items: $ref: '#/components/schemas/EquipmentRef' category: $ref: '#/components/schemas/ClassificationRef' customDefinedFields: $ref: '#/components/schemas/CustomDefinedFields' identifiers: type: array description: Identifiers related to the Equipment. nullable: true items: $ref: '#/components/schemas/Identifier' systemName: type: string description: The content system name readOnly: true description: An equipment known to an institution Workflow: required: - step type: object properties: step: type: string description: Current workflow step description: $ref: '#/components/schemas/SystemLocalizedString' description: Information about workflow ClassifiedLocalizedValue: 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/LocalizedString' type: $ref: '#/components/schemas/ClassificationRef' description: A classified localized value ActivityRef: required: - uuid type: object description: A reference to an activity nullable: true allOf: - $ref: '#/components/schemas/ContentRef' securitySchemes: api-key: type: apiKey description: Security mechanism for the API name: api-key in: header