openapi: 3.0.3 info: title: Pure Web Service 524 activities impacts API description: 'This is the Pure Web Service. Listed below are all available endpoints, along with a short description.

In order to use the Pure Web Service, you must enter an API key. These are generated in the Administrator tab of Pure, and issued with a given set of available endpoints.
To enter your API key and begin your use, press the ''Authorize'' button to at the top of this page.
You are then presented with two options for entering the API key:
  1. Use the API key in query format.
  2. Use the API key in a header.

    3. For further documentation, see Web Service Documentation.

    This is final version of the legacy versioned Web Service, and will be available until otherwise announced in release notes.
    Please note that when doing new development it is advised to investigate the new Pure API - to see if relevant endpoints are available for your use case.
    If enabled, you can can see documentation here API Documentation.

    ' version: '524' contact: name: Elsevier servers: - url: https://api.research-repository.uwa.edu.au/ws/api/524 security: - apiKey: [] - api-key: [] tags: - name: impacts paths: /impacts: get: tags: - impacts summary: Lists all impacts description: Lists all impacts in the Pure instance. If you need to filter the impacts returned, see the POST version which supports additional filtering. operationId: listImpacts security: - apiKey: [] - api-key: [] parameters: - name: q in: query required: false description: Free text search string using Lucene query syntax. Read more... schema: type: string - name: fields in: query required: false description: Limit the fields included in the response. E.g. 'nameVariants.nameVariant' will only return the name variants. Read more... schema: type: array items: type: string - name: order in: query required: false description: 'Specify the ordering of content in the result. Default: ID ascending. Read more...' schema: type: array enum: - date - created - rating - name - modified items: type: string - name: orderBy in: query required: false description: 'Choose the directionality of the result. If set, this will override direction on ''Order''. Read more about order elements and direction here: Read more...' schema: type: string enum: - ascending - descending - name: locale in: query required: false description: Enter the desired locale. E.g. 'en_GB' will only return the English text strings. Read more... schema: type: array enum: - en_GB items: type: string - name: fallbackLocale in: query required: false description: Fallback locale string. Syntax is 'Locale1=>Locale2' to map Locale1 to Locale2. E.g. 'da_DK=>en_GB'. Locale1 must be equal to the locale provided in the locale string. Read more... schema: type: array items: type: string - name: rendering in: query required: false description: HTML rendering formats. If rendering formats are specified, the content will be returned in these formats instead of XML. If XML is also wanted, it can be included using the fields parameter. Read more... schema: type: array enum: - ddp_metadata - system - expertKeywordGroupsPortal - short - long items: type: string - name: linkingStrategy in: query required: false description: Specify the linking strategy to use when creating HTML renderings. Read more... schema: type: string enum: - documentLinkingStrategy - portalLinkingStrategy - ddpLinkingStrategy - noLinkingStrategy - externalSourceIdLinkingStrategy - name: returnUsedContent in: query required: false description: If 'true', the IDs of the content used to create HTML renderings are returned as part of the result. Read more... schema: type: boolean - name: navigationLink in: query required: false description: 'Include navigation links for paging and content. Default: true. Read more...' schema: type: boolean - name: size in: query required: false description: 'Enter the number of results per window. Default: 10. Read more...' schema: type: integer - name: offset in: query required: false description: 'Enter the offset into the total result set where items should be returned from. Default: 0. Read more...' schema: type: integer - name: page in: query required: false description: Enter the desired page number. Read more... schema: type: integer - name: pageSize in: query required: false description: Enter the desired number of results per page. Read more... schema: type: integer responses: '200': description: Successful operation content: application/xml: schema: &id001 $ref: '#/components/schemas/WSImpactListResult' application/json: schema: *id001 post: tags: - impacts summary: Complex operation for impacts description: Lists impacts in the Pure instance, similar to the GET version, instead of using parameters to alter the response, an XML document is posted with the request. The XML document contains fields for all the parameters available for the GET version, but also additional filtering options. For documentation of the XML format see Impact documentation. operationId: listImpacts_1 security: - apiKey: [] - api-key: [] requestBody: content: application/xml: schema: &id002 $ref: '#/components/schemas/WSImpactsQuery' application/json: schema: *id002 responses: '200': description: Successful operation content: application/xml: schema: &id003 $ref: '#/components/schemas/WSImpactListResult' application/json: schema: *id003 /impacts-meta/orderings: get: tags: - impacts summary: Lists available orderings description: Lists all orderings available to the impacts endpoint. These values can be used by the order parameter. operationId: getAvailableOrderings_14 security: - apiKey: [] - api-key: [] responses: '200': description: Successful operation content: application/xml: schema: &id004 $ref: '#/components/schemas/WSOrderingsList' application/json: schema: *id004 /impacts-meta/renderings: get: tags: - impacts summary: Lists available renderings description: Lists all renderings available to the impacts endpoint. These values can be used by the rendering parameter. operationId: getAvailableRenderings_14 security: - apiKey: [] - api-key: [] responses: '200': description: Successful operation content: application/xml: schema: &id005 $ref: '#/components/schemas/WSRenderingsList' application/json: schema: *id005 /impacts/{id}: get: tags: - impacts summary: Get impacts description: Get impacts with specific ID (path parameter). operationId: getImpact security: - apiKey: [] - api-key: [] parameters: - name: id in: path required: true description: ID of the desired impacts schema: type: string - name: idClassificationType in: query required: false description: Give an optional classification type used to specify which type of ID should be used in the match. Read more... schema: type: string - name: idClassification in: query required: false description: Give an optional classification used to specify which type of ID should be used in the match. Read more... schema: type: string - name: fields in: query required: false description: Limit the fields included in the response. E.g. 'nameVariants.nameVariant' will only return the name variants. Read more... schema: type: array items: type: string - name: locale in: query required: false description: Enter the desired locale. E.g. 'en_GB' will only return the English text strings. Read more... schema: type: array enum: - en_GB items: type: string - name: fallbackLocale in: query required: false description: Fallback locale string. Syntax is 'Locale1=>Locale2' to map Locale1 to Locale2. E.g. 'da_DK=>en_GB'. Locale1 must be equal to the locale provided in the locale string. Read more... schema: type: array items: type: string - name: rendering in: query required: false description: HTML rendering formats. If rendering formats are specified, the content will be returned in these formats instead of XML. If XML is also wanted, it can be included using the fields parameter. Read more... schema: type: array enum: - ddp_metadata - system - expertKeywordGroupsPortal - short - long items: type: string - name: returnUsedContent in: query required: false description: If 'true', the IDs of the content used to create HTML renderings are returned as part of the result. Read more... schema: type: boolean - name: navigationLink in: query required: false description: 'Include navigation links for paging and content. Default: true. Read more...' schema: type: boolean responses: '200': description: Successful operation content: application/xml: schema: &id006 $ref: '#/components/schemas/WSImpact' application/json: schema: *id006 '404': description: Resource not found content: application/xml: schema: &id007 $ref: '#/components/schemas/WSErrorResult' application/json: schema: *id007 components: schemas: WSApplicationRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSApplication' WSFundingOpportunityEligibility: type: object properties: eligibilityType: $ref: '#/components/schemas/WSClassification' eligibilityFulfillmentType: $ref: '#/components/schemas/WSEligibilityFulfillmentType' WSAwardMilestone: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' milestoneDeadline: type: string format: date-time completed: type: boolean completedDate: type: string format: date-time award: $ref: '#/components/schemas/WSAwardRef' milestoneState: $ref: '#/components/schemas/WSClassification' title: $ref: '#/components/schemas/WSLocalizedString' description: $ref: '#/components/schemas/WSLocalizedString' reminders: type: array xml: wrapped: true items: xml: name: reminder $ref: '#/components/schemas/WSAwardMilestoneReminder' administrativeRole: type: string academicRole: $ref: '#/components/schemas/WSClassification' category: $ref: '#/components/schemas/WSClassification' milestoneType: type: string enum: - ACADEMIC - ADMINISTRATIVE info: $ref: '#/components/schemas/WSContentInformation' xml: name: awardMilestone WSPublisherRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSPublisher' WSCompoundDate: type: object properties: year: type: integer format: int32 month: type: integer format: int32 day: type: integer format: int32 WSVisitingScholarOrganisationAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' affiliationId: type: string addresses: type: array xml: wrapped: true items: xml: name: address $ref: '#/components/schemas/WSClassifiedAddress' emails: type: array xml: wrapped: true items: xml: name: email $ref: '#/components/schemas/WSClassifiedValue' phoneNumbers: type: array xml: wrapped: true items: xml: name: phoneNumber $ref: '#/components/schemas/WSClassifiedValue' employmentType: $ref: '#/components/schemas/WSClassification' webAddresses: type: array xml: wrapped: true items: xml: name: webAddress $ref: '#/components/schemas/WSClassifiedLocalizedValue' organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' purposeOfStay: type: string visitorFrom: $ref: '#/components/schemas/WSExternalOrganisationRef' jobDescription: $ref: '#/components/schemas/WSLocalizedString' jobTitle: $ref: '#/components/schemas/WSClassification' primaryAssociation: type: boolean WSPersonEducationSupervisorAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true supervisor: $ref: '#/components/schemas/WSPersonRef' externalSupervisor: $ref: '#/components/schemas/WSExternalPersonRef' WSPersonExpertise: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true areasOfExpertise: type: array xml: wrapped: true items: type: string xml: name: areaOfExpertise areaOfExpertiseClassifications: type: array xml: wrapped: true items: xml: name: areaOfExpertiseClassification $ref: '#/components/schemas/WSClassification' willingnessToMedia: type: boolean moderatedWillingnessToMedia: type: boolean type: $ref: '#/components/schemas/WSClassification' WSUuidList: type: object properties: family: type: string xml: attribute: true uuids: type: array xml: wrapped: true items: type: string xml: name: uuid WSAwardMilestoneRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSAwardMilestone' WSStudentOrganisationAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' affiliationId: type: string addresses: type: array xml: wrapped: true items: xml: name: address $ref: '#/components/schemas/WSClassifiedAddress' emails: type: array xml: wrapped: true items: xml: name: email $ref: '#/components/schemas/WSClassifiedValue' phoneNumbers: type: array xml: wrapped: true items: xml: name: phoneNumber $ref: '#/components/schemas/WSClassifiedValue' employmentType: $ref: '#/components/schemas/WSClassification' webAddresses: type: array xml: wrapped: true items: xml: name: webAddress $ref: '#/components/schemas/WSClassifiedLocalizedValue' organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' fte: type: number format: double startYear: type: string studentTypeDescription: $ref: '#/components/schemas/WSClassification' programme: type: string expectedStudyDuration: type: integer format: int32 minStudyDuration: type: integer format: int32 maxStudyDuration: type: integer format: int32 programmeYear: type: string initialSubmissionsDate: type: string format: date-time expectedEndDate: type: string format: date-time nationality: $ref: '#/components/schemas/WSClassification' studentResidencyFlag: $ref: '#/components/schemas/WSResidencyFlag' countryOfDomicile: $ref: '#/components/schemas/WSClassification' awardGained: type: string projectTitle: $ref: '#/components/schemas/WSLocalizedString' awardDate: type: string format: date-time status: $ref: '#/components/schemas/WSClassification' primaryAssociation: type: boolean WSYearlyBudget: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true year: type: integer format: int32 budget: type: number format: double WSGender: type: object properties: key: type: string xml: attribute: true enum: - MALE - FEMALE - UNKNOWN value: $ref: '#/components/schemas/WSLocalizedString' WSDataSet: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' temporalCoveragePeriod: $ref: '#/components/schemas/WSCompoundDateRange' dataProductionPeriod: $ref: '#/components/schemas/WSCompoundDateRange' classifiedSources: type: array xml: name: associatedIds wrapped: true items: xml: name: associatedId $ref: '#/components/schemas/WSClassifiedValue' geographicalCoverage: $ref: '#/components/schemas/WSLocalizedString' geoLocation: $ref: '#/components/schemas/WSGeoLocation' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedDataSetPersonAssociation' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' publisher: $ref: '#/components/schemas/WSPublisherRef' doi: type: string documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDataSetDocument' physicalDatas: type: array xml: wrapped: true items: xml: name: physicalData $ref: '#/components/schemas/WSDataSetPhysicalData' contactPerson: $ref: '#/components/schemas/WSPersonRef' legalConditions: type: array xml: wrapped: true items: xml: name: legalCondition $ref: '#/components/schemas/WSDataSetLegalCondition' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' publicationDate: $ref: '#/components/schemas/WSCompoundDate' openAccessPermission: $ref: '#/components/schemas/WSClassification' relatedDataSets: type: array xml: wrapped: true items: xml: name: relatedDataSets $ref: '#/components/schemas/WSDataSetRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProjects $ref: '#/components/schemas/WSUPMProjectRef' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedStudentThesis: type: array xml: name: relatedStudentTheses wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' natureTypes: type: array xml: wrapped: true items: xml: name: natureType $ref: '#/components/schemas/WSClassification' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' workflow: $ref: '#/components/schemas/WSWorkflow' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' visibility: $ref: '#/components/schemas/WSVisibility' confidential: type: boolean info: $ref: '#/components/schemas/WSContentInformation' openAccessEmbargoMonths: type: integer format: int32 openAccessEmbargoDate: type: string format: date-time xml: name: embargoEndDate xml: name: dataSet WSActivityRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSAbstractActivity' WSRenderingsList: type: object properties: renderings: type: array xml: wrapped: true items: type: string xml: name: rendering xml: name: renderings WSExternalOrganisationRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSExternalOrganisation' WSUsedContent: type: object properties: rendering: type: string xml: attribute: true locale: type: string xml: attribute: true usedContent: type: array xml: name: uuids wrapped: true items: xml: name: uuid $ref: '#/components/schemas/WSUuidList' WSImpact: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' status: $ref: '#/components/schemas/WSClassification' period: $ref: '#/components/schemas/WSCompoundDateRange' descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' categories: type: array xml: wrapped: true items: xml: name: category $ref: '#/components/schemas/WSClassification' level: $ref: '#/components/schemas/WSClassification' classifiedSources: type: array xml: name: associatedIds wrapped: true items: xml: name: associatedId $ref: '#/components/schemas/WSClassifiedValue' participants: type: array xml: wrapped: true items: xml: name: participant $ref: '#/components/schemas/WSImpactClassifiedParticipantAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' evidenceList: type: array xml: wrapped: true items: xml: name: evidence $ref: '#/components/schemas/WSImpactEvidence' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' relatedImpacts: type: array xml: wrapped: true items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedStudentTheses: type: array xml: wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the Dataset module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' visibility: $ref: '#/components/schemas/WSVisibility' confidential: type: boolean keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: impact WSReference: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true type: $ref: '#/components/schemas/WSReferenceType' title: $ref: '#/components/schemas/WSLocalizedString' description: $ref: '#/components/schemas/WSLocalizedString' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedPersonAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' date: type: string format: date-time url: type: string medium: type: string mediaType: $ref: '#/components/schemas/WSClassification' degreeOfRecognition: $ref: '#/components/schemas/WSClassification' country: $ref: '#/components/schemas/WSClassification' subdivision: $ref: '#/components/schemas/WSClassification' author: type: string extent: type: string newsfloFragment: type: string description: Only available when Newsflo integration is enabled newsfloRank: description: Only available when Newsflo integration is enabled $ref: '#/components/schemas/WSClassification' WSResearchOutputMetric: type: object properties: value: type: integer format: int32 year: type: integer format: int32 WSEvidenceContactInformation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true contactName: type: string contactDetails: type: string corroborateText: type: string consentObtained: type: boolean WSProfessionalQualification: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true qualification: $ref: '#/components/schemas/WSLocalizedString' abbreviatedQualification: $ref: '#/components/schemas/WSLocalizedString' period: $ref: '#/components/schemas/WSCompoundDateRange' WSGeoLocation: type: object properties: point: type: string polygon: type: string calculatedPoint: type: string WSFileRef: type: object properties: fileName: type: string mimeType: type: string size: type: integer format: int64 fileURL: type: string pureId: type: integer format: int64 WSPressMediaRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSPressMedia' WSPublisher: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' name: type: string type: $ref: '#/components/schemas/WSClassification' alternativeNames: type: array xml: wrapped: true items: type: string xml: name: alternativeName keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' countries: type: array xml: wrapped: true items: xml: name: country $ref: '#/components/schemas/WSClassification' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: publisher WSLocalizedString: type: object properties: formatted: type: boolean xml: attribute: true text: type: array items: xml: name: text $ref: '#/components/schemas/WSLocalizedText' WSEthicalReview: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' reply: $ref: '#/components/schemas/WSEthicalReviewReply' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' relatedApplication: $ref: '#/components/schemas/WSApplicationRef' relatedAward: $ref: '#/components/schemas/WSAwardRef' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedPersonAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSEthicalReviewDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' confidential: type: boolean visibility: $ref: '#/components/schemas/WSVisibility' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: ethicalReview WSPersonsNestedQuery: type: object properties: uuids: type: array xml: wrapped: true items: type: string xml: name: uuid size: type: integer format: int32 offset: type: integer format: int32 linkingStrategy: type: string locales: type: array xml: wrapped: true items: type: string xml: name: locale fallbackLocales: type: array xml: wrapped: true items: type: string xml: name: fallbackLocale renderings: type: array xml: wrapped: true items: type: string xml: name: rendering fields: type: array xml: wrapped: true items: type: string xml: name: field orderings: type: array xml: wrapped: true items: type: string xml: name: ordering returnUsedContent: type: boolean navigationLink: type: boolean ids: type: array xml: wrapped: true items: type: string xml: name: id idClassification: type: string idClassificationType: type: string modifiedAfter: type: string format: date-time modifiedBefore: type: string format: date-time createdAfter: type: string format: date-time createdBefore: type: string format: date-time employmentTypeUris: type: array xml: wrapped: true items: type: string xml: name: employmentTypeUri employmentStatus: type: string enum: - ACTIVE - FORMER employmentPeriod: $ref: '#/components/schemas/WSCompoundDateRange' personOrganisationAssociationTypes: type: array xml: wrapped: true items: type: string xml: name: associationType enum: - STAFF - STUDENTS - VISITING_SCHOLARS - HONORARY_STAFF forOrganisations: $ref: '#/components/schemas/WSOrganisationsNestedQuery' academicStaff: type: boolean keywordURIs: type: array xml: name: keywordUris wrapped: true items: type: string xml: name: keywordUri freeKeywords: type: array xml: wrapped: true items: type: string xml: name: freeKeyword highlightedContent: type: boolean description: Only available when the DDP module is enabled xml: name: personsNestedQuery WSHonoraryStaffOrganisationAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' affiliationId: type: string addresses: type: array xml: wrapped: true items: xml: name: address $ref: '#/components/schemas/WSClassifiedAddress' emails: type: array xml: wrapped: true items: xml: name: email $ref: '#/components/schemas/WSClassifiedValue' phoneNumbers: type: array xml: wrapped: true items: xml: name: phoneNumber $ref: '#/components/schemas/WSClassifiedValue' employmentType: $ref: '#/components/schemas/WSClassification' webAddresses: type: array xml: wrapped: true items: xml: name: webAddress $ref: '#/components/schemas/WSClassifiedLocalizedValue' organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' jobDescription: $ref: '#/components/schemas/WSLocalizedString' jobTitle: $ref: '#/components/schemas/WSClassification' primaryAssociation: type: boolean WSPageInformation: type: object properties: offset: type: integer format: int32 size: type: integer format: int32 xml: name: pageInformation WSDataSetRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSDataSet' WSPrizeRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSPrize' WSStudentThesisDocument: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true title: type: string documentType: $ref: '#/components/schemas/WSClassification' url: type: string documentLicense: $ref: '#/components/schemas/WSClassification' visibleOnPortalDate: type: string format: date-time visibility: $ref: '#/components/schemas/WSVisibility' creator: type: string created: type: string format: date-time documentVersionType: $ref: '#/components/schemas/WSClassification' embargoReason: $ref: '#/components/schemas/WSClassification' rightsStatement: type: string embargoDate: type: string format: date-time WSFundingOpportunityRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSFundingOpportunity' WSOrderingsList: type: object properties: orderings: type: array xml: wrapped: true items: type: string xml: name: ordering xml: name: orderings WSClassifiedApplicantAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' externalPerson: $ref: '#/components/schemas/WSExternalPersonRef' authorCollaboration: $ref: '#/components/schemas/WSAuthorCollaborationRef' name: $ref: '#/components/schemas/WSName' personRole: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' academicOwnershipPercentage: type: number format: double plannedResearcherCommitmentPercentage: type: number format: double researcherCommitments: type: array xml: wrapped: true items: xml: name: researcherCommitment $ref: '#/components/schemas/WSResearcherCommitment' WSERA2015FieldOfResearchAssociation: type: object properties: fieldsOfResearch: xml: name: fieldOfResearch $ref: '#/components/schemas/WSClassification' splitPercentage: type: number format: double pureId: type: integer format: int64 xml: attribute: true WSResearchOutputRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSResearchOutput' WSPublicationStatus: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true current: type: boolean xml: attribute: true publicationStatus: $ref: '#/components/schemas/WSClassification' publicationDate: $ref: '#/components/schemas/WSCompoundDate' WSPerson: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' name: $ref: '#/components/schemas/WSName' gender: description: Only available if it is made public $ref: '#/components/schemas/WSClassification' dateOfBirth: type: string format: date-time description: Only available if it is made public nationality: $ref: '#/components/schemas/WSClassification' nameVariants: type: array xml: wrapped: true items: xml: name: nameVariant $ref: '#/components/schemas/WSClassifiedName' titles: type: array xml: wrapped: true items: xml: name: title $ref: '#/components/schemas/WSClassifiedLocalizedValue' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' orcid: type: string profilePhotos: type: array xml: wrapped: true items: xml: name: profilePhoto $ref: '#/components/schemas/WSClassifiedFileRef' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' startDateAsResearcher: type: string format: date-time retirementDate: type: string format: date-time profiled: type: boolean description: Only available when the Author Profile module is enabled scopusHIndex: type: integer format: int32 profileInformations: type: array xml: wrapped: true items: xml: name: profileInformation $ref: '#/components/schemas/WSClassifiedLocalizedValue' studentOrganisationAssociations: type: array xml: wrapped: true items: xml: name: studentOrganisationAssociation $ref: '#/components/schemas/WSStudentOrganisationAssociation' staffOrganisationAssociations: type: array xml: wrapped: true items: xml: name: staffOrganisationAssociation $ref: '#/components/schemas/WSStaffOrganisationAssociation' visitingScholarOrganisationAssociations: type: array xml: wrapped: true items: xml: name: visitingScholarOrganisationAssociation $ref: '#/components/schemas/WSVisitingScholarOrganisationAssociation' honoraryStaffOrganisationAssociations: type: array xml: wrapped: true items: xml: name: honoraryStaffOrganisationAssociation $ref: '#/components/schemas/WSHonoraryStaffOrganisationAssociation' supervisorForRelations: type: array xml: wrapped: true items: xml: name: supervisorForRelation $ref: '#/components/schemas/WSPersonSupervisorAssociation' supervisedByRelations: type: array xml: wrapped: true items: xml: name: supervisedByRelation $ref: '#/components/schemas/WSPersonSupervisorAssociation' leavesOfAbsence: type: array xml: name: leavesOfAbsences wrapped: true description: Only available when the proper configuration is enabled items: xml: name: leavesOfAbsence $ref: '#/components/schemas/WSPersonClassifiedLeaveOfAbsence' employeeStartDate: type: string format: date-time employeeEndDate: type: string format: date-time fte: type: number format: double affiliationNote: type: string description: Only available when the proper configuration is enabled externalPositions: type: array xml: wrapped: true items: xml: name: externalPosition $ref: '#/components/schemas/WSPersonExternalPosition' educations: type: array xml: wrapped: true items: xml: name: education $ref: '#/components/schemas/WSPersonEducation' professionalQualifications: type: array xml: wrapped: true description: Only available when the proper configuration is enabled items: xml: name: professionalQualification $ref: '#/components/schemas/WSProfessionalQualification' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' fieldOfResearchAssociations: type: array xml: wrapped: true description: Only available when the ERA module is enabled items: xml: name: fieldOfResearchAssociation $ref: '#/components/schemas/WSERA2015FieldOfResearchAssociation' willTakePhdStudents: type: boolean description: Only available when the proper configuration is enabled phdResearchProjects: type: string description: Only available when the proper configuration is enabled privateAddress: description: Only available when the proper configuration is enabled $ref: '#/components/schemas/WSClassifiedAddress' personExpertise: description: Only available when the Person Expertise module is enabled $ref: '#/components/schemas/WSPersonExpertise' visibility: $ref: '#/components/schemas/WSVisibility' info: $ref: '#/components/schemas/WSContentInformation' expert: type: boolean xml: name: person WSFundingOpportunity: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' type: $ref: '#/components/schemas/WSClassification' natureTypes: type: array xml: wrapped: true items: xml: name: natureType $ref: '#/components/schemas/WSClassification' academicLabels: type: array xml: wrapped: true items: xml: name: academicLabel $ref: '#/components/schemas/WSLabel' labels: type: array xml: wrapped: true items: xml: name: label $ref: '#/components/schemas/WSLabel' title: $ref: '#/components/schemas/WSLocalizedString' description: $ref: '#/components/schemas/WSLocalizedString' classifiedSources: type: array xml: name: associatedIds wrapped: true items: xml: name: associatedId $ref: '#/components/schemas/WSClassifiedValue' descriptionOfApplicationProcess: type: string announcementUrl: type: string urlToApplicationSite: type: string emailAddressForApplication: type: string fundingOrganisations: type: array xml: wrapped: true items: xml: name: fundingOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' openingDate: type: string format: date-time letterOfIntentDate: type: string format: date-time deadline: type: string format: date-time active: type: boolean recurring: type: boolean awardCeiling: type: number format: double awardCeilingCurrency: $ref: '#/components/schemas/WSClassification' estimatedFunding: type: number format: double estimatedFundingCurrency: $ref: '#/components/schemas/WSClassification' eligibilities: type: array xml: wrapped: true items: xml: name: eligibility $ref: '#/components/schemas/WSFundingOpportunityEligibility' academicDegreeEligibilities: type: array xml: wrapped: true items: xml: name: academicDegreeEligibility $ref: '#/components/schemas/WSFundingOpportunityEligibility' limitedSubmission: type: boolean numberOfAnnualApplicationsPerHEI: type: integer format: int32 numberOfAwards: type: integer format: int32 openAccessRequirements: type: boolean applications: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: application $ref: '#/components/schemas/WSApplicationRef' associatedApplicationCount: type: integer format: int32 description: Only available when the Unified Project Model module is enabled visibility: $ref: '#/components/schemas/WSVisibility' confidential: type: boolean keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' info: $ref: '#/components/schemas/WSContentInformation' xml: name: fundingOpportunity WSEthicalReviewRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSEthicalReview' WSClassifiedDataSetPersonAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' externalPerson: $ref: '#/components/schemas/WSExternalPersonRef' authorCollaboration: $ref: '#/components/schemas/WSAuthorCollaborationRef' name: $ref: '#/components/schemas/WSName' personRole: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' WSElectronicVersionAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true accessType: $ref: '#/components/schemas/WSClassification' versionType: $ref: '#/components/schemas/WSClassification' embargoPeriod: $ref: '#/components/schemas/WSDateRange' licenseType: $ref: '#/components/schemas/WSClassification' userDefinedLicense: type: string visibleOnPortalDate: type: string format: date-time creator: type: string created: type: string format: date-time WSDataSetPhysicalData: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true title: type: string storageLocation: type: string accessDescription: type: string media: type: string type: $ref: '#/components/schemas/WSClassification' WSOrganisation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' nameVariants: type: array xml: wrapped: true items: xml: name: nameVariant $ref: '#/components/schemas/WSClassifiedLocalizedValue' profileInformations: type: array xml: wrapped: true items: xml: name: profileInformation $ref: '#/components/schemas/WSClassifiedLocalizedValue' photos: type: array xml: wrapped: true items: xml: name: photo $ref: '#/components/schemas/WSClassifiedFileRef' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' addresses: type: array xml: wrapped: true items: xml: name: address $ref: '#/components/schemas/WSClassifiedAddress' phoneNumbers: type: array xml: wrapped: true items: xml: name: phoneNumber $ref: '#/components/schemas/WSClassifiedValue' emails: type: array xml: wrapped: true items: xml: name: email $ref: '#/components/schemas/WSClassifiedValue' webAddresses: type: array xml: wrapped: true items: xml: name: webAddress $ref: '#/components/schemas/WSClassifiedLocalizedValue' period: $ref: '#/components/schemas/WSDateRange' takenOverBy: $ref: '#/components/schemas/WSOrganisationRef' parents: type: array xml: wrapped: true items: xml: name: parent $ref: '#/components/schemas/WSOrganisationRef' contactPersons: type: array xml: wrapped: true items: xml: name: contactPerson $ref: '#/components/schemas/WSPersonRef' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' costCenters: type: array xml: wrapped: true description: Only available on the DK and UK bases items: xml: name: costCenter $ref: '#/components/schemas/WSClassification' visibility: $ref: '#/components/schemas/WSVisibility' info: $ref: '#/components/schemas/WSContentInformation' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' xml: name: organisationalUnit WSAccount: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true costCenter: $ref: '#/components/schemas/WSClassification' classification: $ref: '#/components/schemas/WSClassification' entries: type: array xml: wrapped: true items: xml: name: entry $ref: '#/components/schemas/WSAccountEntry' specification: type: string budget: type: number format: double recoveryPercentage: type: number format: double funderContribution: type: number format: double yearlyBudgets: type: array xml: wrapped: true items: xml: name: yearlyBudget $ref: '#/components/schemas/WSYearlyBudget' WSEthicalReviewReply: type: object properties: key: type: string xml: attribute: true enum: - PENDING - APPROVED - DECLINED - EXTENDED - WITHDRAWN - EXPIRED value: $ref: '#/components/schemas/WSLocalizedString' WSVisibility: type: object properties: key: type: string xml: attribute: true enum: - FREE - CAMPUS - BACKEND value: $ref: '#/components/schemas/WSLocalizedString' WSEligibilityFulfillmentType: type: object properties: key: type: string xml: attribute: true enum: - RECOMMENDATION - REQUIREMENT value: $ref: '#/components/schemas/WSLocalizedString' WSElectronicVersionAdditionalFileAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true licenseType: $ref: '#/components/schemas/WSClassification' userDefinedLicense: type: string visibleOnPortalDate: type: string format: date-time creator: type: string created: type: string format: date-time file: $ref: '#/components/schemas/WSFileRef' title: type: string accessType: $ref: '#/components/schemas/WSClassification' embargoStartDate: type: string format: date-time embargoEndDate: type: string format: date-time WSEquipmentDetails: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true name: $ref: '#/components/schemas/WSLocalizedString' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' acquisitionDate: type: string format: date-time decommissionDate: type: string format: date-time value: type: number format: double manufacturers: type: array xml: wrapped: true items: xml: name: manufacturer $ref: '#/components/schemas/WSInternalExternalOrganisationAssociation' WSAuthorCollaborationRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSAuthorCollaboration' WSCompoundDateRange: type: object properties: startDate: $ref: '#/components/schemas/WSCompoundDate' endDate: $ref: '#/components/schemas/WSCompoundDate' WSApplicationFundingAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true funder: $ref: '#/components/schemas/WSExternalOrganisationRef' fundingClassifications: type: array xml: wrapped: true items: xml: name: fundingClassification $ref: '#/components/schemas/WSClassification' fundingProjectScheme: type: string financial: type: boolean estimatedValue: type: number format: double nonFinancialDescription: type: string appliedAmountInAppliedCurrency: type: number format: double appliedCurrency: $ref: '#/components/schemas/WSClassification' appliedAmount: type: number format: double institutionalEstimatedValue: type: number format: double institutionalPart: type: number format: double institutionalContribution: type: number format: double institutionalFEC: type: number format: double fundingCollaborators: type: array xml: wrapped: true items: xml: name: fundingCollaborator $ref: '#/components/schemas/WSFundingCollaboratorAssociation' budgetAndExpenditures: type: array xml: wrapped: true items: xml: name: budgetAndExpenditure $ref: '#/components/schemas/WSFundingExpenditureAssociation' costCode: type: string visibility: $ref: '#/components/schemas/WSVisibility' fecpercentage: type: number format: double WSAwardStatusDetailsStatus: type: object properties: key: type: string xml: attribute: true enum: - ContractNegotiation - InternallyApproved - Terminated - ExtendedNoCost value: $ref: '#/components/schemas/WSLocalizedString' WSDocument: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true title: type: string documentType: $ref: '#/components/schemas/WSClassification' url: type: string documentLicense: $ref: '#/components/schemas/WSClassification' visibleOnPortalDate: type: string format: date-time visibility: $ref: '#/components/schemas/WSVisibility' creator: type: string created: type: string format: date-time WSPersonExternalPosition: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true appointment: $ref: '#/components/schemas/WSClassification' appointmentValue: $ref: '#/components/schemas/WSLocalizedString' externalOrganisation: $ref: '#/components/schemas/WSExternalOrganisationRef' period: $ref: '#/components/schemas/WSCompoundDateRange' WSAward: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' natureTypes: type: array xml: wrapped: true items: xml: name: natureType $ref: '#/components/schemas/WSClassification' status: $ref: '#/components/schemas/WSAwardStatus' statusDetails: description: Only available when the Award Management module is enabled $ref: '#/components/schemas/WSAwardStatusDetails' shortTitle: $ref: '#/components/schemas/WSLocalizedString' acronym: type: string descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' awardholders: type: array xml: wrapped: true items: xml: name: awardholder $ref: '#/components/schemas/WSClassifiedAwardholderAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' coManagingOrganisationalUnits: type: array xml: wrapped: true items: xml: name: coManagingOrganisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' collaborative: type: boolean collaborators: type: array xml: wrapped: true items: xml: name: collaborator $ref: '#/components/schemas/WSCollaboratorAssociation' totalAcademicOwnershipPercentage: type: number format: double fundings: type: array xml: wrapped: true items: xml: name: funding $ref: '#/components/schemas/WSAwardFundingAssociation' totalAwardedAmount: type: number format: double totalSpendAmount: type: number format: double actualPeriod: $ref: '#/components/schemas/WSDateRange' expectedPeriod: $ref: '#/components/schemas/WSDateRange' awardDate: type: string format: date-time curtailed: type: boolean curtailDate: type: string format: date-time curtailReason: type: string extended: type: boolean extendedEndDate: type: string format: date-time dateOfExtension: type: string format: date-time documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' relatedProject: $ref: '#/components/schemas/WSUPMProjectRef' relatedApplications: type: array xml: wrapped: true items: xml: name: relatedApplication $ref: '#/components/schemas/WSApplicationRef' relatedEthicalReviews: type: array xml: name: relatedEthicalReview wrapped: true items: xml: name: relatedEthicalReview $ref: '#/components/schemas/WSEthicalReviewRef' relatedAwards: type: array xml: wrapped: true items: xml: name: relatedAward $ref: '#/components/schemas/WSAwardRef' fieldOfResearchAssociations: type: array xml: wrapped: true description: Only available when the ERA module is enabled items: xml: name: fieldOfResearchAssociation $ref: '#/components/schemas/WSERA2015FieldOfResearchAssociation' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' visibility: $ref: '#/components/schemas/WSVisibility' confidential: type: boolean workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' milestones: type: array items: $ref: '#/components/schemas/WSAwardMilestoneRef' xml: name: award WSAwardStatusDetails: type: object properties: status: $ref: '#/components/schemas/WSAwardStatusDetailsStatus' internallyApprovedDate: type: string format: date-time declined: type: boolean declinationDate: type: string format: date-time declinedReason: type: string relinquished: type: boolean relinquishmentDate: type: string format: date-time relinquishmentReason: type: string WSInternalExternalOrganisationAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisation: xml: name: externalOrganisationalUnit $ref: '#/components/schemas/WSExternalOrganisationRef' WSAddress: type: object properties: address1: type: string address2: type: string address3: type: string address4: type: string address5: type: string postalCode: type: string city: type: string country: $ref: '#/components/schemas/WSClassification' subdivision: $ref: '#/components/schemas/WSClassification' state: type: string geoLocation: $ref: '#/components/schemas/WSGeoLocation' xml: name: address WSStaffOrganisationAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' affiliationId: type: string addresses: type: array xml: wrapped: true items: xml: name: address $ref: '#/components/schemas/WSClassifiedAddress' emails: type: array xml: wrapped: true items: xml: name: email $ref: '#/components/schemas/WSClassifiedValue' phoneNumbers: type: array xml: wrapped: true items: xml: name: phoneNumber $ref: '#/components/schemas/WSClassifiedValue' employmentType: $ref: '#/components/schemas/WSClassification' webAddresses: type: array xml: wrapped: true items: xml: name: webAddress $ref: '#/components/schemas/WSClassifiedLocalizedValue' organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' contractType: $ref: '#/components/schemas/WSClassification' staffType: $ref: '#/components/schemas/WSClassification' jobDescription: $ref: '#/components/schemas/WSLocalizedString' jobTitle: $ref: '#/components/schemas/WSClassification' fte: type: number format: double primaryAssociation: type: boolean WSKeyword: type: object properties: pureId: type: integer format: int64 xml: attribute: true locale: type: string xml: attribute: true freeKeywords: type: array xml: wrapped: true items: type: string xml: name: freeKeyword WSUPMProjectStatus: type: object properties: key: type: string xml: attribute: true enum: - NOT_STARTED - RUNNING - FINISHED - CURTAILED value: $ref: '#/components/schemas/WSLocalizedString' WSImpactListResult: type: object properties: count: type: integer format: int32 pageInformation: $ref: '#/components/schemas/WSPageInformation' navigationLinks: type: array xml: wrapped: true items: xml: name: navigationLink $ref: '#/components/schemas/WSNavigationLink' items: type: array xml: wrapped: true items: $ref: '#/components/schemas/WSImpact' xml: name: result WSEquipment: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' category: $ref: '#/components/schemas/WSClassification' descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' equipmentDetails: type: array xml: wrapped: true items: xml: name: equipmentDetail $ref: '#/components/schemas/WSEquipmentDetails' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedPersonAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' contactPersons: type: array xml: wrapped: true items: xml: name: contactPerson $ref: '#/components/schemas/WSPersonRef' addresses: type: array xml: wrapped: true items: xml: name: address $ref: '#/components/schemas/WSClassifiedAddress' phoneNumbers: type: array xml: wrapped: true items: xml: name: phoneNumber $ref: '#/components/schemas/WSClassifiedValue' emails: type: array xml: wrapped: true items: xml: name: email $ref: '#/components/schemas/WSClassifiedValue' webAddresses: type: array xml: wrapped: true items: xml: name: webAddress $ref: '#/components/schemas/WSClassifiedLocalizedValue' loanType: $ref: '#/components/schemas/WSClassification' loanTerm: $ref: '#/components/schemas/WSLocalizedString' photos: type: array xml: wrapped: true items: xml: name: photo $ref: '#/components/schemas/WSClassifiedFileRef' parents: type: array xml: wrapped: true items: xml: name: parent $ref: '#/components/schemas/WSEquipmentRef' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the DataSet module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedStudentThesis: type: array xml: name: relatedStudentTheses wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' visibility: $ref: '#/components/schemas/WSVisibility' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: equipment WSAwardFundingAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true funder: $ref: '#/components/schemas/WSExternalOrganisationRef' fundingClassifications: type: array xml: wrapped: true items: xml: name: fundingClassification $ref: '#/components/schemas/WSClassification' fundingProjectScheme: type: string financial: type: boolean estimatedValue: type: number format: double nonFinancialDescription: type: string awardedAmountInAwardedCurrency: type: number format: double awardedCurrency: $ref: '#/components/schemas/WSClassification' awardedAmount: type: number format: double institutionalEstimatedValue: type: number format: double institutionalPart: type: number format: double institutionalContribution: type: number format: double institutionalFEC: type: number format: double fundingCollaborators: type: array xml: wrapped: true items: xml: name: fundingCollaborator $ref: '#/components/schemas/WSFundingCollaboratorAssociation' budgetAndExpenditures: type: array xml: wrapped: true items: xml: name: budgetAndExpenditure $ref: '#/components/schemas/WSFundingExpenditureAssociation' costCode: type: string visibility: $ref: '#/components/schemas/WSVisibility' fecpercentage: type: number format: double WSApplication: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' natureTypes: type: array xml: wrapped: true items: xml: name: natureType $ref: '#/components/schemas/WSClassification' statuses: type: array xml: wrapped: true description: Not available when the Award Management module is enabled items: xml: name: status $ref: '#/components/schemas/WSApplicationStatus' shortTitle: $ref: '#/components/schemas/WSLocalizedString' acronym: type: string descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' fundingOpportunity: description: Not available when the Award Management module is disabled $ref: '#/components/schemas/WSFundingOpportunityRef' applicants: type: array xml: wrapped: true items: xml: name: applicant $ref: '#/components/schemas/WSClassifiedApplicantAssociation' documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSApplicationDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' budgetDifference: type: number format: double organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' coManagingOrganisationalUnits: type: array xml: wrapped: true items: xml: name: coManagingOrganisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' collaborative: type: boolean collaborators: type: array xml: wrapped: true items: xml: name: collaborator $ref: '#/components/schemas/WSCollaboratorAssociation' totalAcademicOwnershipPercentage: type: number format: double fundings: type: array xml: wrapped: true items: xml: name: funding $ref: '#/components/schemas/WSApplicationFundingAssociation' totalAppliedAmount: type: number format: double expectedPeriod: $ref: '#/components/schemas/WSDateRange' relatedProject: $ref: '#/components/schemas/WSUPMProjectRef' relatedApplications: type: array xml: wrapped: true items: xml: name: relatedApplication $ref: '#/components/schemas/WSApplicationRef' relatedAwards: type: array xml: wrapped: true items: xml: name: relatedAward $ref: '#/components/schemas/WSAwardRef' relatedEthicalReviews: type: array xml: wrapped: true description: Only available when the Award Management module is enabled items: xml: name: relatedEthicalReview $ref: '#/components/schemas/WSEthicalReviewRef' fieldOfResearchAssociations: type: array xml: wrapped: true description: Only available when the ERA module is enabled items: xml: name: fieldOfResearchAssociation $ref: '#/components/schemas/WSERA2015FieldOfResearchAssociation' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' visibility: $ref: '#/components/schemas/WSVisibility' confidential: type: boolean workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' submissionDate: type: string format: date-time description: Only available when the Award Management module is enabled submissionDeadline: type: string format: date-time description: Only available when the Award Management module is enabled awardDate: type: string format: date-time description: Only available when the Award Management module is enabled funderReply: type: string description: Only available when the Award Management module is enabled rejectedDate: type: string format: date-time description: Only available when the Award Management module is enabled xml: name: application WSApplicationDocument: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true title: type: string documentType: $ref: '#/components/schemas/WSClassification' url: type: string documentLicense: $ref: '#/components/schemas/WSClassification' visibleOnPortalDate: type: string format: date-time visibility: $ref: '#/components/schemas/WSVisibility' creator: type: string created: type: string format: date-time documentVersionType: $ref: '#/components/schemas/WSClassification' WSCollaboratorAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true type: $ref: '#/components/schemas/WSClassification' leadCollaborator: type: boolean organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisation: $ref: '#/components/schemas/WSExternalOrganisationRef' WSAwardStatus: type: object properties: key: type: string xml: attribute: true enum: - NO_STATUS - NOT_STARTED - RUNNING - FINISHED - CURTAILED - DECLINED - INTERNALLY_APPROVED - IN_CONTRACT_NEGOTIATION - EXTENDED_NO_COST value: $ref: '#/components/schemas/WSLocalizedString' WSWorkflow: type: object properties: workflowStep: type: string xml: attribute: true value: $ref: '#/components/schemas/WSLocalizedString' WSId: type: object properties: id: type: string idSource: type: string xml: attribute: true WSEthicalReviewDocument: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true title: type: string documentType: $ref: '#/components/schemas/WSClassification' url: type: string documentLicense: $ref: '#/components/schemas/WSClassification' visibleOnPortalDate: type: string format: date-time visibility: $ref: '#/components/schemas/WSVisibility' creator: type: string created: type: string format: date-time documentVersionType: $ref: '#/components/schemas/WSClassification' WSErrorResult: type: object properties: code: type: integer format: int32 type: type: string title: type: string description: type: string xml: name: error WSImpactEvidence: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true evidenceTitle: xml: name: title $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' evidenceIndicator: xml: name: indicator $ref: '#/components/schemas/WSClassification' evidenceSummary: xml: name: summary $ref: '#/components/schemas/WSLocalizedString' evidenceContactInformations: type: array xml: wrapped: true items: xml: name: evidenceContactInformation $ref: '#/components/schemas/WSEvidenceContactInformation' period: $ref: '#/components/schemas/WSCompoundDateRange' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' WSPrize: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' category: $ref: '#/components/schemas/WSClassification' descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' awardDate: $ref: '#/components/schemas/WSCompoundDate' degreeOfRecognition: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' grantingOrganisations: type: array xml: wrapped: true items: xml: name: grantingOrganisation $ref: '#/components/schemas/WSInternalExternalOrganisationAssociation' event: xml: name: awardedAtEvent $ref: '#/components/schemas/WSEventRef' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' receiversOfPrize: type: array xml: wrapped: true items: xml: name: receiverOfPrize $ref: '#/components/schemas/WSClassifiedPersonAssociation' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' relatedPrizes: type: array xml: wrapped: true items: xml: name: relatedPrizes $ref: '#/components/schemas/WSPrizeRef' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the DataSet module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedStudentThesis: type: array xml: name: relatedStudentTheses wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' visibility: $ref: '#/components/schemas/WSVisibility' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: prize WSStudentThesis: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' type: $ref: '#/components/schemas/WSClassification' language: $ref: '#/components/schemas/WSClassification' title: type: string subTitle: type: string translatedTitle: $ref: '#/components/schemas/WSLocalizedString' translatedSubTitle: $ref: '#/components/schemas/WSLocalizedString' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedAuthorAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' supervisors: type: array xml: wrapped: true items: xml: name: supervisor $ref: '#/components/schemas/WSClassifiedPersonAssociation' supervisorOrganisations: type: array xml: name: supervisorOrganisationalUnits wrapped: true items: xml: name: supervisorOrganisationalUnit $ref: '#/components/schemas/WSOrganisationRef' supervisorExternalOrganisations: type: array xml: wrapped: true items: xml: name: supervisorExternalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' awardDate: $ref: '#/components/schemas/WSCompoundDate' awardingInstitutions: type: array xml: wrapped: true items: xml: name: awardingInstitution $ref: '#/components/schemas/WSInternalExternalOrganisationAssociation' sponsors: type: array xml: wrapped: true items: xml: name: sponsor $ref: '#/components/schemas/WSExternalOrganisationRef' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSStudentThesisDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' bibliographicalNote: $ref: '#/components/schemas/WSLocalizedString' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivities $ref: '#/components/schemas/WSActivityRef' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the DataSet module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' workflow: $ref: '#/components/schemas/WSWorkflow' confidential: type: boolean visibility: $ref: '#/components/schemas/WSVisibility' info: $ref: '#/components/schemas/WSContentInformation' abstract: $ref: '#/components/schemas/WSLocalizedString' xml: name: studentThesis WSDataSetLegalCondition: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true type: $ref: '#/components/schemas/WSClassification' description: type: string WSNavigationLink: type: object properties: ref: type: string xml: attribute: true href: type: string xml: attribute: true WSFundingExpenditureAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' costCenter: $ref: '#/components/schemas/WSClassification' accounts: type: array xml: wrapped: true items: xml: name: account $ref: '#/components/schemas/WSAccount' costCode: type: string WSClassifiedParticipantAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' externalPerson: $ref: '#/components/schemas/WSExternalPersonRef' authorCollaboration: $ref: '#/components/schemas/WSAuthorCollaborationRef' name: $ref: '#/components/schemas/WSName' personRole: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' academicOwnershipPercentage: type: number format: double plannedResearcherCommitmentPercentage: type: number format: double researcherCommitments: type: array xml: wrapped: true items: xml: name: researcherCommitment $ref: '#/components/schemas/WSResearcherCommitment' samePeriodAsProject: type: boolean WSLink: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true url: type: string description: $ref: '#/components/schemas/WSLocalizedString' linkType: $ref: '#/components/schemas/WSClassification' WSKeywordContainer: type: object properties: pureId: type: integer format: int64 xml: attribute: true structuredKeyword: $ref: '#/components/schemas/WSClassification' freeKeywords: type: array xml: wrapped: true items: xml: name: freeKeyword $ref: '#/components/schemas/WSKeyword' WSLocalizedText: type: object properties: locale: type: string xml: attribute: true value: type: string WSClassifiedAuthorAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' externalPerson: $ref: '#/components/schemas/WSExternalPersonRef' authorCollaboration: $ref: '#/components/schemas/WSAuthorCollaborationRef' name: $ref: '#/components/schemas/WSName' personRole: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' contributionDescription: type: string contributionPercentage: type: number format: double country: $ref: '#/components/schemas/WSClassification' correspondingAuthor: type: boolean hidden: type: boolean WSEquipmentRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSEquipment' WSPersonClassifiedLeaveOfAbsence: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true typesOfLeave: xml: name: typeOfLeave $ref: '#/components/schemas/WSClassification' period: $ref: '#/components/schemas/WSDateRange' WSExternalPersonRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSExternalPerson' WSResidencyFlag: type: object properties: key: type: string enum: - UNKNOWN - HOME - OVERSEAS value: $ref: '#/components/schemas/WSLocalizedString' WSLabel: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true value: type: string WSClassifiedLocalizedValue: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true value: $ref: '#/components/schemas/WSLocalizedString' classification: xml: name: type $ref: '#/components/schemas/WSClassification' WSClassifiedPersonAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' externalPerson: $ref: '#/components/schemas/WSExternalPersonRef' authorCollaboration: $ref: '#/components/schemas/WSAuthorCollaborationRef' name: $ref: '#/components/schemas/WSName' personRole: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' WSAwardMilestoneReminder: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true value: type: integer format: int32 timeUnit: type: string enum: - MONTH - WEEK - DAY WSPersonOrganisationAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' affiliationId: type: string addresses: type: array xml: wrapped: true items: xml: name: address $ref: '#/components/schemas/WSClassifiedAddress' emails: type: array xml: wrapped: true items: xml: name: email $ref: '#/components/schemas/WSClassifiedValue' phoneNumbers: type: array xml: wrapped: true items: xml: name: phoneNumber $ref: '#/components/schemas/WSClassifiedValue' employmentType: $ref: '#/components/schemas/WSClassification' webAddresses: type: array xml: wrapped: true items: xml: name: webAddress $ref: '#/components/schemas/WSClassifiedLocalizedValue' organisation: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' primaryAssociation: type: boolean WSPersonSupervisorAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true supervisor: $ref: '#/components/schemas/WSPersonRef' externalSupervisor: $ref: '#/components/schemas/WSExternalPersonRef' supervisionPercentage: type: integer format: int32 period: $ref: '#/components/schemas/WSDateRange' supervisorRole: $ref: '#/components/schemas/WSClassification' student: $ref: '#/components/schemas/WSPersonOrganisationAssociation' WSClassifiedValue: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true value: $ref: '#/components/schemas/WSValue' classification: xml: name: type $ref: '#/components/schemas/WSClassification' WSEventRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSEvent' WSPersonEducation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true period: $ref: '#/components/schemas/WSCompoundDateRange' fieldOfStudy: $ref: '#/components/schemas/WSClassification' qualification: $ref: '#/components/schemas/WSClassification' awardDate: type: string format: date-time organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSInternalExternalOrganisationAssociation' projectTitle: $ref: '#/components/schemas/WSLocalizedString' distinction: $ref: '#/components/schemas/WSClassification' supervisor: $ref: '#/components/schemas/WSPersonEducationSupervisorAssociation' WSOrganisationsNestedQuery: type: object properties: uuids: type: array xml: wrapped: true items: type: string xml: name: uuid size: type: integer format: int32 offset: type: integer format: int32 linkingStrategy: type: string locales: type: array xml: wrapped: true items: type: string xml: name: locale fallbackLocales: type: array xml: wrapped: true items: type: string xml: name: fallbackLocale renderings: type: array xml: wrapped: true items: type: string xml: name: rendering fields: type: array xml: wrapped: true items: type: string xml: name: field orderings: type: array xml: wrapped: true items: type: string xml: name: ordering returnUsedContent: type: boolean navigationLink: type: boolean ids: type: array xml: wrapped: true items: type: string xml: name: id idClassification: type: string idClassificationType: type: string modifiedAfter: type: string format: date-time modifiedBefore: type: string format: date-time createdAfter: type: string format: date-time createdBefore: type: string format: date-time organisationalUnitTypeUris: type: array xml: wrapped: true items: type: string xml: name: organisationalUnitTypeUri organisationPeriodStatus: type: string xml: name: organisationalUnitPeriodStatus enum: - ACTIVE - FORMER hierarchyDepth: type: integer format: int32 hierarchyStrategy: type: string keywordURIs: type: array xml: name: keywordUris wrapped: true items: type: string xml: name: keywordUri freeKeywords: type: array xml: wrapped: true items: type: string xml: name: freeKeyword xml: name: organisationalUnitsNestedQuery WSAbstractActivity: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' category: $ref: '#/components/schemas/WSClassification' descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' period: $ref: '#/components/schemas/WSCompoundDateRange' degreeOfRecognition: $ref: '#/components/schemas/WSClassification' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedPersonAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' indicators: type: array xml: wrapped: true items: xml: name: indicator $ref: '#/components/schemas/WSClassification' documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' confidential: type: boolean fieldOfResearchAssociations: type: array xml: wrapped: true description: Only available when the ERA module is enabled items: xml: name: fieldOfResearchAssociation $ref: '#/components/schemas/WSERA2015FieldOfResearchAssociation' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the Dataset module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedStudentThesis: type: array xml: name: relatedStudentTheses wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' visibility: $ref: '#/components/schemas/WSVisibility' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: activity WSExternalPerson: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' name: $ref: '#/components/schemas/WSName' type: $ref: '#/components/schemas/WSClassification' title: $ref: '#/components/schemas/WSLocalizedString' country: $ref: '#/components/schemas/WSClassification' gender: $ref: '#/components/schemas/WSGender' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: externalPerson WSFundingCollaboratorAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true collaborator: $ref: '#/components/schemas/WSExternalOrganisationRef' institutionalPart: type: number format: double estimatedValue: type: number format: double WSUPMProjectAssociation: type: object properties: relationType: $ref: '#/components/schemas/WSClassification' project: $ref: '#/components/schemas/WSUPMProjectRef' WSAuthorCollaboration: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' name: $ref: '#/components/schemas/WSLocalizedString' nameVariants: type: array xml: wrapped: true items: type: string xml: name: nameVariant externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' classifiedSources: type: array xml: wrapped: true items: xml: name: classifiedSource $ref: '#/components/schemas/WSClassifiedValue' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: authorcollaboration WSEvent: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' subTitle: $ref: '#/components/schemas/WSLocalizedString' abbreviatedTitle: $ref: '#/components/schemas/WSLocalizedString' conferenceNumber: type: string description: $ref: '#/components/schemas/WSLocalizedString' period: $ref: '#/components/schemas/WSDateRange' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' degreeOfRecognition: $ref: '#/components/schemas/WSClassification' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' relatedEvents: type: array xml: wrapped: true items: xml: name: relatedEvent $ref: '#/components/schemas/WSEventRef' location: type: string city: type: string country: $ref: '#/components/schemas/WSClassification' subdivision: $ref: '#/components/schemas/WSClassification' organisers: type: array xml: wrapped: true items: xml: name: organiser $ref: '#/components/schemas/WSInternalExternalOrganisationAssociation' sponsorOrganisations: type: array xml: wrapped: true items: xml: name: sponsorOrganisation $ref: '#/components/schemas/WSInternalExternalOrganisationAssociation' geoLocation: $ref: '#/components/schemas/WSGeoLocation' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' fieldOfResearchAssociations: type: array xml: wrapped: true description: Only available when the ERA module is enabled items: xml: name: fieldOfResearchAssociation $ref: '#/components/schemas/WSERA2015FieldOfResearchAssociation' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: event WSImpactsQuery: type: object properties: uuids: type: array xml: wrapped: true items: type: string xml: name: uuid size: type: integer format: int32 offset: type: integer format: int32 linkingStrategy: type: string locales: type: array xml: wrapped: true items: type: string xml: name: locale fallbackLocales: type: array xml: wrapped: true items: type: string xml: name: fallbackLocale renderings: type: array xml: wrapped: true items: type: string xml: name: rendering fields: type: array xml: wrapped: true items: type: string xml: name: field orderings: type: array xml: wrapped: true items: type: string xml: name: ordering returnUsedContent: type: boolean navigationLink: type: boolean ids: type: array xml: wrapped: true items: type: string xml: name: id idClassification: type: string idClassificationType: type: string modifiedAfter: type: string format: date-time modifiedBefore: type: string format: date-time createdAfter: type: string format: date-time createdBefore: type: string format: date-time searchString: type: string natureClassificationUris: type: array xml: wrapped: true items: type: string xml: name: natureClassificationUri statuses: type: array xml: wrapped: true items: type: string xml: name: status period: $ref: '#/components/schemas/WSCompoundDateRange' excludeByTypeUri: type: boolean typeUris: type: array xml: wrapped: true items: type: string xml: name: typeUri workflowSteps: type: array xml: wrapped: true items: type: string xml: name: workflowStep forPersons: $ref: '#/components/schemas/WSPersonsNestedQuery' forOrganisationalUnits: $ref: '#/components/schemas/WSOrganisationsNestedQuery' keywordURIs: type: array xml: name: keywordUris wrapped: true items: type: string xml: name: keywordUri freeKeywords: type: array xml: wrapped: true items: type: string xml: name: freeKeyword xml: name: impactsQuery WSClassification: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uri: type: string xml: attribute: true term: $ref: '#/components/schemas/WSLocalizedString' disabled: type: boolean xml: attribute: true description: $ref: '#/components/schemas/WSLocalizedString' classificationRelations: type: array xml: wrapped: true items: xml: name: classificationRelation $ref: '#/components/schemas/WSClassificationRelation' WSExternalOrganisation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' natureTypes: type: array xml: wrapped: true items: xml: name: natureType $ref: '#/components/schemas/WSClassification' parent: $ref: '#/components/schemas/WSExternalOrganisationRef' acronym: type: string alternativeNames: type: array xml: wrapped: true items: type: string xml: name: alternativeName classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' address: $ref: '#/components/schemas/WSAddress' phoneNumber: type: string mobilePhoneNumber: type: string fax: type: string email: type: string bankAccountNumber: type: string vatNumber: type: string documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' note: type: string visibility: $ref: '#/components/schemas/WSVisibility' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: externalOrganisation WSClassifiedFileRef: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true classification: xml: name: type $ref: '#/components/schemas/WSClassification' url: type: string filename: type: string mimetype: type: string size: type: integer format: int64 WSClassifiedAddress: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true addressType: $ref: '#/components/schemas/WSClassification' addressLines: type: string street: type: string building: type: string postalcode: type: string city: type: string country: $ref: '#/components/schemas/WSClassification' subdivision: $ref: '#/components/schemas/WSClassification' geoLocation: $ref: '#/components/schemas/WSGeoLocation' WSClassificationRelation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true relatedTo: $ref: '#/components/schemas/WSClassification' relationType: $ref: '#/components/schemas/WSClassification' WSApplicationStatus: type: object properties: status: $ref: '#/components/schemas/WSClassification' date: type: string format: date-time documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' WSImpactRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSImpact' WSName: type: object properties: firstName: type: string lastName: type: string WSPressMedia: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' category: $ref: '#/components/schemas/WSClassification' descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' references: type: array xml: wrapped: true items: xml: name: reference $ref: '#/components/schemas/WSReference' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedPersonAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' event: $ref: '#/components/schemas/WSEventRef' relatedPressMedia: type: array xml: wrapped: true items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the DataSet module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedStudentThesis: type: array xml: name: relatedStudentTheses wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' visibility: $ref: '#/components/schemas/WSVisibility' workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: pressMedia WSUPMProjectRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSUPMProject' WSAccountEntry: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true yearMonth: $ref: '#/components/schemas/WSCompoundDate' amount: type: number format: double WSImpactClassifiedParticipantAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' externalPerson: $ref: '#/components/schemas/WSExternalPersonRef' authorCollaboration: $ref: '#/components/schemas/WSAuthorCollaborationRef' name: $ref: '#/components/schemas/WSName' personRole: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' email: type: string externalNote: type: string externalOrganisation: type: string phone: type: string sector: $ref: '#/components/schemas/WSClassification' country: $ref: '#/components/schemas/WSClassification' academicOwnershipPercentage: type: number format: double WSPersonRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSPerson' WSKeywordGroup: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true logicalName: type: string xml: attribute: true type: $ref: '#/components/schemas/WSClassification' keywordContainers: type: array xml: wrapped: true items: xml: name: keywordContainer $ref: '#/components/schemas/WSKeywordContainer' WSClassifiedName: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true name: $ref: '#/components/schemas/WSName' type: $ref: '#/components/schemas/WSClassification' WSAwardRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSAward' WSReferenceType: type: object properties: key: type: string xml: attribute: true enum: - CONTRIBUTION - COVERAGE value: $ref: '#/components/schemas/WSLocalizedString' WSContentInformation: type: object properties: createdBy: type: string createdDate: type: string format: date-time modifiedBy: type: string modifiedDate: type: string format: date-time portalUrl: type: string prettyUrlIdentifiers: type: array xml: name: prettyURLIdentifiers wrapped: true items: type: string xml: name: prettyURLIdentifier additionalExternalIds: type: array xml: wrapped: true items: xml: name: id $ref: '#/components/schemas/WSId' usedContent: type: array xml: name: usedContents wrapped: true items: xml: name: usedContent $ref: '#/components/schemas/WSUsedContent' previousUuids: type: array xml: wrapped: true items: type: string xml: name: previousUuid WSOrganisationRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSOrganisation' WSUPMProject: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' natureTypes: type: array xml: wrapped: true items: xml: name: natureType $ref: '#/components/schemas/WSClassification' status: $ref: '#/components/schemas/WSUPMProjectStatus' shortTitle: $ref: '#/components/schemas/WSLocalizedString' acronym: type: string descriptions: type: array xml: wrapped: true items: xml: name: description $ref: '#/components/schemas/WSClassifiedLocalizedValue' classifiedSources: type: array xml: name: ids wrapped: true items: xml: name: id $ref: '#/components/schemas/WSClassifiedValue' participants: type: array xml: wrapped: true items: xml: name: participant $ref: '#/components/schemas/WSClassifiedParticipantAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' coManagingOrganisationalUnits: type: array xml: wrapped: true items: xml: name: coManagingOrganisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' collaborative: type: boolean collaborators: type: array xml: wrapped: true items: xml: name: collaborator $ref: '#/components/schemas/WSCollaboratorAssociation' totalAcademicOwnershipPercentage: type: number format: double period: $ref: '#/components/schemas/WSDateRange' curtailed: type: boolean curtailDate: type: string format: date-time curtailReason: type: string documents: type: array xml: wrapped: true items: xml: name: document $ref: '#/components/schemas/WSDocument' links: type: array xml: wrapped: true items: xml: name: link $ref: '#/components/schemas/WSLink' relatedApplications: type: array xml: wrapped: true items: xml: name: relatedApplication $ref: '#/components/schemas/WSApplicationRef' relatedAwards: type: array xml: wrapped: true items: xml: name: relatedAward $ref: '#/components/schemas/WSAwardRef' relatedProjects: type: array xml: wrapped: true items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectAssociation' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the DataSet module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedStudentThesis: type: array xml: name: relatedStudentTheses wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' fieldOfResearchAssociations: type: array xml: wrapped: true description: Only available when the ERA module is enabled items: xml: name: fieldOfResearchAssociation $ref: '#/components/schemas/WSERA2015FieldOfResearchAssociation' visibility: $ref: '#/components/schemas/WSVisibility' confidential: type: boolean workflow: $ref: '#/components/schemas/WSWorkflow' info: $ref: '#/components/schemas/WSContentInformation' xml: name: project WSResearcherCommitment: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true yearMonth: $ref: '#/components/schemas/WSCompoundDate' plannedResearcherCommitment: type: number format: double actualResearcherCommitment: type: number format: double WSHtmlRendering: type: object properties: format: type: string xml: attribute: true locale: type: string xml: attribute: true error: type: boolean xml: attribute: true html: type: string WSStudentThesisRef: type: object properties: uuid: type: string xml: attribute: true link: $ref: '#/components/schemas/WSNavigationLink' name: $ref: '#/components/schemas/WSLocalizedString' type: $ref: '#/components/schemas/WSClassification' externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true ref: $ref: '#/components/schemas/WSStudentThesis' WSValue: type: object properties: formatted: type: boolean xml: attribute: true value: type: string WSDateRange: type: object properties: startDate: type: string format: date-time endDate: type: string format: date-time WSClassifiedAwardholderAssociation: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true person: $ref: '#/components/schemas/WSPersonRef' externalPerson: $ref: '#/components/schemas/WSExternalPersonRef' authorCollaboration: $ref: '#/components/schemas/WSAuthorCollaborationRef' name: $ref: '#/components/schemas/WSName' personRole: $ref: '#/components/schemas/WSClassification' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' period: $ref: '#/components/schemas/WSDateRange' academicOwnershipPercentage: type: number format: double plannedResearcherCommitmentPercentage: type: number format: double researcherCommitments: type: array xml: wrapped: true items: xml: name: researcherCommitment $ref: '#/components/schemas/WSResearcherCommitment' samePeriodAsAward: type: boolean WSResearchOutput: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true uuid: type: string xml: attribute: true renderings: type: array xml: wrapped: true items: xml: name: rendering $ref: '#/components/schemas/WSHtmlRendering' title: $ref: '#/components/schemas/WSValue' subTitle: $ref: '#/components/schemas/WSValue' type: $ref: '#/components/schemas/WSClassification' category: $ref: '#/components/schemas/WSClassification' peerReview: type: boolean internationalPeerReview: type: boolean publicationStatuses: type: array xml: wrapped: true items: xml: name: publicationStatus $ref: '#/components/schemas/WSPublicationStatus' language: $ref: '#/components/schemas/WSClassification' translatedTitle: $ref: '#/components/schemas/WSLocalizedString' translatedSubTitle: $ref: '#/components/schemas/WSLocalizedString' numberOfPages: type: integer format: int32 fieldOfResearchAssociations: type: array xml: wrapped: true description: Only available when the ERA module is enabled items: xml: name: fieldOfResearchAssociation $ref: '#/components/schemas/WSERA2015FieldOfResearchAssociation' personAssociations: type: array xml: wrapped: true items: xml: name: personAssociation $ref: '#/components/schemas/WSClassifiedAuthorAssociation' organisationalUnits: type: array xml: wrapped: true items: xml: name: organisationalUnit $ref: '#/components/schemas/WSOrganisationRef' externalOrganisations: type: array xml: wrapped: true items: xml: name: externalOrganisation $ref: '#/components/schemas/WSExternalOrganisationRef' totalNumberOfAuthors: type: integer format: int32 managingOrganisationalUnit: $ref: '#/components/schemas/WSOrganisationRef' openAccessPermission: $ref: '#/components/schemas/WSClassification' embargoMonths: type: integer format: int32 embargoEndDate: type: string format: date-time submissionYear: type: integer format: int32 description: Only available when this field has been enabled mainResearchArea: description: Only available when the BFI module is enabled $ref: '#/components/schemas/WSClassification' electronicVersions: type: array xml: wrapped: true items: xml: name: electronicVersion $ref: '#/components/schemas/WSElectronicVersionAssociation' additionalFiles: type: array xml: wrapped: true items: xml: name: additionalFile $ref: '#/components/schemas/WSElectronicVersionAdditionalFileAssociation' additionalLinks: type: array xml: wrapped: true items: xml: name: additionalLink $ref: '#/components/schemas/WSLink' articleProcessingChargePaid: type: boolean articleProcessingChargeAmountInArticleProcessingChargeCurrency: type: number format: double articleProcessingChargeCurrency: $ref: '#/components/schemas/WSClassification' articleProcessingChargeAmount: type: number format: double keywordGroups: type: array xml: wrapped: true items: xml: name: keywordGroup $ref: '#/components/schemas/WSKeywordGroup' bibliographicalNote: $ref: '#/components/schemas/WSLocalizedString' descriptions: type: array xml: wrapped: true items: xml: name: descriptions $ref: '#/components/schemas/WSClassifiedLocalizedValue' relatedResearchOutputs: type: array xml: wrapped: true items: xml: name: relatedResearchOutput $ref: '#/components/schemas/WSResearchOutputRef' relatedActivities: type: array xml: wrapped: true description: Only available when the Activity module is enabled items: xml: name: relatedActivity $ref: '#/components/schemas/WSActivityRef' relatedPressMedia: type: array xml: wrapped: true description: Only available when the Press / Media module is enabled items: xml: name: relatedPressMedia $ref: '#/components/schemas/WSPressMediaRef' relatedImpacts: type: array xml: wrapped: true description: Only available when the Impact module is enabled items: xml: name: relatedImpact $ref: '#/components/schemas/WSImpactRef' relatedProjects: type: array xml: wrapped: true description: Only available when the Unified Project Model module is enabled items: xml: name: relatedProject $ref: '#/components/schemas/WSUPMProjectRef' relatedDataSets: type: array xml: wrapped: true description: Only available when the DataSet module is enabled items: xml: name: relatedDataSet $ref: '#/components/schemas/WSDataSetRef' relatedPrizes: type: array xml: wrapped: true description: Only available when the Prize module is enabled items: xml: name: relatedPrize $ref: '#/components/schemas/WSPrizeRef' relatedStudentTheses: type: array xml: wrapped: true description: Only available when the Student Thesis module is enabled items: xml: name: relatedStudentThesis $ref: '#/components/schemas/WSStudentThesisRef' relatedEquipment: type: array xml: wrapped: true description: Only available when the Equipment module is enabled items: xml: name: relatedEquipment $ref: '#/components/schemas/WSEquipmentRef' confidential: type: boolean visibility: $ref: '#/components/schemas/WSVisibility' workflow: $ref: '#/components/schemas/WSWorkflow' assessmentType: description: Only available when the FIA module is enabled $ref: '#/components/schemas/WSClassification' info: $ref: '#/components/schemas/WSContentInformation' totalScopusCitations: type: integer format: int32 fieldWeightedCitationImpact: type: number format: double scopusMetrics: type: array xml: wrapped: true items: xml: name: scopusMetric $ref: '#/components/schemas/WSResearchOutputMetric' includedOnStaffPages: type: boolean abstract: $ref: '#/components/schemas/WSLocalizedString' xml: name: researchOutput WSDataSetDocument: type: object properties: pureId: type: integer format: int64 xml: attribute: true externalId: type: string xml: attribute: true externalIdSource: type: string xml: attribute: true externallyManaged: type: boolean xml: attribute: true title: type: string documentType: $ref: '#/components/schemas/WSClassification' url: type: string documentLicense: $ref: '#/components/schemas/WSClassification' visibleOnPortalDate: type: string format: date-time visibility: $ref: '#/components/schemas/WSVisibility' creator: type: string created: type: string format: date-time embargoDate: type: string format: date-time securitySchemes: apiKey: type: apiKey name: apiKey in: query api-key: type: apiKey name: api-key in: header