openapi: 3.0.1 info: title: Pure activity award API description: The Pure API provides a secure and complete web services API for using and managing research information data in Pure. The API enables a broad range of use-cases for interacting with research information, from anonymous Open Data scenarios to enabling the next generation Pure admin. termsOfService: '' contact: name: '' url: '' email: pure-support@elsevier.com license: name: '' url: '' version: 5.33.3-3 servers: - url: /ws/api security: - api-key: [] tags: - name: award paths: /awards: get: tags: - award summary: Lists all awards description: Lists all awards in the Pure instance. If you need to filter the awards returned, see the POST version which supports additional filtering. operationId: award_list parameters: - name: size in: query description: Number of returned awards per request. schema: maximum: 1000 type: integer format: int32 default: 10 - name: offset in: query description: The offset for the returned list. 0 or null value is from the start schema: type: integer format: int32 default: 0 - name: order in: query description: The order of the list, must be a value from award_getOrderings schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AwardListResult' put: tags: - award summary: Create award description: Create award operationId: award_create requestBody: description: The content to create content: application/json: schema: $ref: '#/components/schemas/Award' required: true responses: '201': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Award' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /awards/allowed-awardholder-roles: get: tags: - award summary: A list of allowed award holder roles description: Get a list of allowed roles for award holders on awards operationId: award_getAllowedAwardHolderRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-budget-account-classifications: get: tags: - award summary: A list of allowed account classifications description: Get a list of allowed account classifications for award budgets operationId: award_getAllowedBudgetAccountClassifications responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-classified-identifier-types: get: tags: - award summary: A list of allowed classified identifier types description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of awards operationId: award_getAllowedClassifiedIdentifierTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-collaborator-types: get: tags: - award summary: A list of allowed collaborator types description: Get a list of allowed types for collaborators on awards operationId: award_getAllowedCollaboratorTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-custom-defined-field-values/{propertyName}/classifications: get: tags: - award summary: Get allowed classifications for the custom-defined field associated with the award description: Get allowed classifications for the custom-defined field associated with the award. operationId: award_getAllowedCustomDefinedFieldClassifications parameters: - name: propertyName in: path description: PropertyName for the desired custom-defined field required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /awards/allowed-description-types: get: tags: - award summary: A list of allowed description types description: Get a list of allowed types for descriptions on awards operationId: award_getAllowedDescriptionTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-document-licenses: get: tags: - award summary: A list of allowed document licenses description: Get a list of allowed document licenses for awards operationId: award_getAllowedDocumentLicenses responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-document-types: get: tags: - award summary: A list of allowed document types description: Get a list of allowed types for documents on awards operationId: award_getAllowedDocumentTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-document-version-types: get: tags: - award summary: A list of allowed document version types description: Get a list of allowed version types for documents on awards operationId: award_getAllowedDocumentVersionTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-funding-classifications: get: tags: - award summary: A list of allowed funding classifications description: Get a list of allowed funding classifications for fundings on awards operationId: award_getAllowedFundingClassifications responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-keyword-group-configurations: get: tags: - award summary: A list of keyword group configurations description: Get a list of allowed keyword group configurations that can be used when submitting keyword groups. operationId: award_getAllowedKeywordGroupConfigurations responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList' /awards/allowed-keyword-group-configurations/{id}/classifications: get: tags: - award summary: A list of allowed classifications for the specified keyword group description: Get a list of allowed classifications that can be used when submitting a specified keyword group. operationId: award_getAllowedKeywordGroupConfigurationClassifications parameters: - name: id in: path description: Pure id of the keyword group configuration required: true schema: type: integer format: int64 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-link-types: get: tags: - award summary: A list of allowed link types description: Get a list of allowed link types that can be used for the 'links.linkType' attribute of awards operationId: award_getAllowedLinkTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-locales: get: tags: - award summary: A list of allowed locales in localized strings description: Get a list of allowed locales that can be used when submitting localized string entities. operationId: award_getAllowedLocales responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LocalesList' /awards/allowed-nature-types: get: tags: - award summary: A list of allowed nature types description: Get a list of allowed nature types for awards operationId: award_getAllowedNatureTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-templates: get: tags: - award summary: A list of allowed award templates description: Get a list of allowed templates that can be used for awards. Some of the templates that exists in the API specification may be disabled for the Pure installation. operationId: award_getAllowedTemplates responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllowedTemplateListResult' /awards/allowed-types: get: tags: - award summary: A list of allowed award types description: Get a list of allowed types that can be used for the 'type' attribute of awards operationId: award_getAllowedTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /awards/allowed-workflow-steps: get: tags: - award summary: A list of allowed workflow steps description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of awards operationId: award_getAllowedWorkflowSteps responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/WorkflowListResult' /awards/disciplines/allowed-discipline-schemes: get: tags: - award summary: A list of allowed discipline schemes description: Get a list fo a allowed discipline schemes for awards operationId: award_getAllowedDisciplineSchemes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult' /awards/disciplines/{discipline-scheme}/allowed-disciplines: get: tags: - award summary: A list of allowed disciplines for a specific discipline scheme description: Get a list of a allowed disciplines for specific discipline scheme for awards operationId: award_getAllowedDisciplines parameters: - name: discipline-scheme in: path description: Identifier for the discipline scheme for award required: true schema: type: string - name: size in: query description: Number of returned disciplines per request schema: maximum: 1000 type: integer format: int32 default: 10 - name: offset in: query description: The offset for the returned list. 0 or null value is from the start schema: type: integer format: int32 default: 0 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesDisciplineListResult' /awards/disciplines/{discipline-scheme}/search: post: tags: - award summary: Query operation for disciplines associated with awards description: Lists disciplines from the discipline scheme associated with awards in the Pure instance that matches the provided query. operationId: award_listDisciplineAssociations parameters: - name: discipline-scheme in: path description: Identifier for the discipline scheme required: true schema: type: string requestBody: description: The query to perform content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociationsQuery' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociationListResult' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /awards/file-uploads: put: tags: - award summary: Upload file to a specific award description: Uploads file for the award operationId: award_fileUploads parameters: - name: Content-Type in: header description: Set the mime type for the file schema: type: string requestBody: content: '*/*': schema: type: string format: binary required: true responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/UploadedFile' application/xml: schema: $ref: '#/components/schemas/UploadedFile' /awards/orderings: get: tags: - award summary: Lists available orderings description: Lists all orderings available to the award endpoint. These values can be used by the order parameter. operationId: award_getOrderings responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/OrderingsList' /awards/search: post: tags: - award summary: Query operation for awards description: Lists awards in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options. operationId: award_query requestBody: description: The query to perform content: application/json: schema: $ref: '#/components/schemas/AwardsQuery' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AwardListResult' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /awards/{uuid}: get: tags: - award summary: Get award description: Get award with specific UUID. operationId: award_get parameters: - name: uuid in: path description: UUID of the desired award required: true schema: pattern: .+ type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Award' '301': description: The requested content have changed UUID '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - award summary: Update award description: Update award with specific UUID. operationId: award_update parameters: - name: uuid in: path description: UUID of the award to update required: true schema: pattern: .+ type: string format: uuid requestBody: description: The content to update content: application/json: schema: $ref: '#/components/schemas/Award' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Award' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Version conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' delete: tags: - award summary: Delete award description: Delete award with specific UUID. operationId: award_delete parameters: - name: uuid in: path description: UUID of the award required: true schema: pattern: .+ type: string format: uuid responses: '204': description: Successful operation '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' /awards/{uuid}/actions/lock: post: tags: - award summary: Lock the content description: Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API. operationId: award_lock parameters: - name: uuid in: path description: UUID of the content to lock required: true schema: pattern: .+ type: string format: uuid responses: '204': description: Content marked as locked '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Content already locked content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' /awards/{uuid}/actions/unlock: post: tags: - award summary: Unlock the content description: Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API. operationId: award_unlock parameters: - name: uuid in: path description: UUID of the content to unlock required: true schema: pattern: .+ type: string format: uuid responses: '204': description: Content marked as unlocked '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Content already unlocked content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' /awards/{uuid}/budgets: get: tags: - award summary: Get the budgets for the award description: Get the budgets for the award with the specified UUID. operationId: award_getBudgets parameters: - name: uuid in: path description: UUID of the award required: true schema: pattern: .+ type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AwardBudgetResult' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' /awards/{uuid}/budgets/{id}: get: tags: - award summary: Get a specific budget for the award description: Get a specific budget for the award with the specified UUID. operationId: award_getBudget parameters: - name: uuid in: path description: UUID of the award required: true schema: pattern: .+ type: string format: uuid - name: id in: path description: ID of the budget required: true schema: type: integer format: int64 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AwardBudget' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - award summary: Update budget for an award description: Update budget for an award with specific UUID. operationId: award_updateBudget parameters: - name: uuid in: path description: UUID of the award with the budget required: true schema: pattern: .+ type: string format: uuid - name: id in: path description: ID of the budget to update required: true schema: type: integer format: int64 requestBody: description: The content to update content: application/json: schema: $ref: '#/components/schemas/AwardBudget' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AwardBudget' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Version conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' /awards/{uuid}/cluster: get: tags: - award summary: Get the award cluster for the award description: Get the award cluster for the award with the specified UUID. operationId: award_getCluster parameters: - name: uuid in: path description: UUID of the award required: true schema: pattern: .+ type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AwardCluster' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' /awards/{uuid}/dependents: get: tags: - award summary: Lists all dependents to an award description: 'Lists all dependents to an award with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. ' operationId: award_dependents parameters: - name: uuid in: path description: UUID of the award required: true schema: pattern: .+ type: string format: uuid - name: verbose in: query description: 'Default: false. Setting this to true will add links and names to the output but will also have an impact on performance. Use with caution.' schema: type: boolean default: false responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ContentRefListResult' /awards/{uuid}/disciplines/{discipline-scheme}: get: tags: - award summary: Get disciplines from the discipline scheme associated with the award description: Get disciplines from the discipline scheme associated with the award with specific UUID. operationId: award_getDisciplineAssociation parameters: - name: uuid in: path description: UUID of the desired award required: true schema: pattern: .+ type: string format: uuid - name: discipline-scheme in: path description: Identifier for the discipline scheme required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociation' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - award summary: Update disciplines from the discipline scheme associated with the award description: Update disciplines from the discipline scheme associated with the award with specific UUID. operationId: award_putDisciplineAssociation parameters: - name: uuid in: path description: UUID of the award to update required: true schema: pattern: .+ type: string format: uuid - name: discipline-scheme in: path description: Identifier for the discipline scheme required: true schema: type: string requestBody: description: The disciplines association to create content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociation' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociation' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /awards/{uuid}/files/{fileId}: get: tags: - award summary: Get file from the award description: Get file from the award operationId: award_getFile parameters: - name: uuid in: path description: UUID of the award required: true schema: pattern: .+ type: string format: uuid - name: fileId in: path description: 'File id ' required: true schema: pattern: .+ type: string responses: '200': description: Successful operation content: '*/*': schema: type: string format: binary /awards/{uuid}/notes: get: tags: - award summary: Lists notes description: Lists notes associated with an award ordered by date (nulls last) operationId: award_listNotes parameters: - name: uuid in: path description: UUID of the award to get notes for required: true schema: pattern: .+ type: string format: uuid - name: size in: query description: Number of returned notes per request schema: maximum: 1000 type: integer format: int32 default: 10 - name: offset in: query description: The offset for the returned list. 0 or null value is from the start schema: type: integer format: int32 default: 0 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/NoteListResult' '404': description: Award not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - award summary: Create note description: Create note and associate it with the award operationId: award_createNote parameters: - name: uuid in: path description: UUID of the award to add note to required: true schema: pattern: .+ type: string format: uuid requestBody: description: The note to create content: application/json: schema: $ref: '#/components/schemas/Note' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Note' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' components: schemas: DisciplinesAssociation: required: - disciplineAssignments type: object properties: content: $ref: '#/components/schemas/ContentRef' disciplineScheme: type: string description: The discipline scheme these disciplines are assigned from readOnly: true disciplineAssignments: type: array description: A collection of assigned disciplines items: $ref: '#/components/schemas/DisciplinesDisciplineAssignment' description: An association between a content and a number of discipline assignments Visibility: required: - key type: object properties: key: type: string description: Visibility value enum: - FREE - CAMPUS - BACKEND - CONFIDENTIAL description: $ref: '#/components/schemas/SystemLocalizedString' description: Visibility of an object ContentRef: required: - systemName - uuid type: object properties: uuid: type: string description: UUID of the referred content format: uuid systemName: type: string nullable: true discriminator: propertyName: systemName mapping: AccessDefinition: '#/components/schemas/AccessDefinitionRef' Activity: '#/components/schemas/ActivityRef' Application: '#/components/schemas/ApplicationRef' AuthorCollaboration: '#/components/schemas/AuthorCollaborationRef' Award: '#/components/schemas/AwardRef' ClassificationScheme: '#/components/schemas/ClassificationSchemeRef' ConferenceSeries: '#/components/schemas/ConferenceSeriesRef' DataSet: '#/components/schemas/DataSetRef' Equipment: '#/components/schemas/EquipmentRef' Event: '#/components/schemas/EventRef' ExternalOrganization: '#/components/schemas/ExternalOrganizationRef' ExternalPerson: '#/components/schemas/ExternalPersonRef' Impact: '#/components/schemas/ImpactRef' Journal: '#/components/schemas/JournalRef' Organization: '#/components/schemas/OrganizationRef' Person: '#/components/schemas/PersonRef' Publisher: '#/components/schemas/PublisherRef' PressMedia: '#/components/schemas/PressMediaRef' Prize: '#/components/schemas/PrizeRef' Project: '#/components/schemas/ProjectRef' ResearchOutput: '#/components/schemas/ResearchOutputRef' StudentThesis: '#/components/schemas/StudentThesisRef' FundingOpportunity: '#/components/schemas/FundingOpportunityRef' EthicalReview: '#/components/schemas/EthicalReviewRef' ApplicationCluster: '#/components/schemas/ApplicationClusterRef' AwardCluster: '#/components/schemas/AwardClusterRef' User: '#/components/schemas/UserRef' ERA2018FieldOfResearch: '#/components/schemas/Anzsrc2008FieldOfResearchRef' UnitOfAssessmentREF2014: '#/components/schemas/Ref2014UnitOfAssessmentRef' UnitOfAssessmentREF2020: '#/components/schemas/Ref2020UnitOfAssessmentRef' ANZSRCTypeOfActivity: '#/components/schemas/Anzsrc2020TypeOfActivityRef' ANZSRCFieldOfResearch: '#/components/schemas/Anzsrc2020FieldOfResearchRef' ANZSRCSocioEconomicObjective: '#/components/schemas/Anzsrc2020SocioEconomicObjectiveRef' Semester: '#/components/schemas/SemesterRef' Education: '#/components/schemas/EducationRef' Course: '#/components/schemas/CourseRef' CurriculumVitae: '#/components/schemas/CurriculumVitaeRef' CustomDefinedFieldConfiguration: '#/components/schemas/CustomDefinedFieldConfigurationRef' KeywordGroupConfiguration: '#/components/schemas/KeywordGroupConfigurationRef' Review: '#/components/schemas/ReviewRef' GenericContentRef: '#/components/schemas/GenericContentRef' UserProfile: '#/components/schemas/UserProfileRef' Thesaurus: '#/components/schemas/ThesaurusRef' Concept: '#/components/schemas/ConceptRef' PageInformation: type: object properties: offset: type: integer description: Offset that returned items start at format: int32 size: type: integer description: The requested number of items. May be higher than the actual number of items in the result if there are fewer items in the store than requested format: int32 description: Information about pages Award: required: - awardDate - fundings - managingOrganization - organizations - title - type - typeDiscriminator type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true uuid: type: string description: UUID, this is the primary identity of the entity format: uuid readOnly: true createdBy: type: string description: Username of creator readOnly: true createdDate: type: string description: Date and time of creation format: date-time readOnly: true modifiedBy: type: string description: Username of the user that performed a modification readOnly: true modifiedDate: type: string description: Date and time of last modification format: date-time readOnly: true portalUrl: type: string description: URL of the content on the Pure Portal readOnly: true prettyUrlIdentifiers: type: array description: All pretty URLs readOnly: true items: type: string description: All pretty URLs readOnly: true previousUuids: type: array description: UUIDs of other content items which have been merged into this content item (or similar) readOnly: true items: type: string description: UUIDs of other content items which have been merged into this content item (or similar) readOnly: true version: type: string description: Used to guard against conflicting updates. For new content this is null, and for existing content the current value. The property should never be modified by a client, except in the rare case where the client wants to perform an update irrespective of if other clients have made updates in the meantime, also known as a "dirty write". A dirty write is performed by not including the property value or setting the property to null nullable: true acronym: type: string description: The acronym of the award nullable: true awardHolders: type: array description: Related award holders and their affiliations. items: $ref: '#/components/schemas/AbstractAwardHolderAssociation' externalOrganizations: type: array description: A collection of external organization affiliations. nullable: true items: $ref: '#/components/schemas/ExternalOrganizationRef' awardDate: type: string description: The date the award was granted by the funder. format: date awards: type: array description: A collection of related grants. nullable: true items: $ref: '#/components/schemas/AwardRef' budgetAwardedAmountDifference: $ref: '#/components/schemas/DeprecatedSystemCurrencyAmount' coManagingOrganizations: type: array description: A collection of co-managing organizational unit affiliations. nullable: true items: $ref: '#/components/schemas/OrganizationRef' collaborators: type: array description: A collection of collaborators. nullable: true items: $ref: '#/components/schemas/CollaboratorAssociation' descriptions: type: array description: A collection of descriptions for the award. Query the /awards/allowed-description-types endpoint for allowed types. nullable: true items: $ref: '#/components/schemas/ClassifiedFormattedLocalizedValue' actualPeriod: $ref: '#/components/schemas/DateRange' expectedPeriod: $ref: '#/components/schemas/DateRange' effectivePeriod: $ref: '#/components/schemas/DeprecatedDateRange' identifiers: type: array description: Identifiers related to the award. nullable: true items: $ref: '#/components/schemas/Identifier' fundings: type: array description: A collection of funding information for the award. items: $ref: '#/components/schemas/AwardFundingAssociation' natureTypes: type: array description: Nature of activity types for the award. nullable: true items: $ref: '#/components/schemas/ClassificationRef' organizations: type: array description: A collection of organizational unit affiliations. items: $ref: '#/components/schemas/OrganizationRef' managingOrganization: $ref: '#/components/schemas/OrganizationRef' applications: type: array description: A collection of related applications. nullable: true items: $ref: '#/components/schemas/ApplicationRef' shortTitle: $ref: '#/components/schemas/LocalizedString' title: $ref: '#/components/schemas/LocalizedString' totalAcademicOwnership: type: number description: DEPRECATED - Total academic ownership of the award. format: double readOnly: true deprecated: true totalAwardedAmount: $ref: '#/components/schemas/DeprecatedSystemCurrencyAmount' totalSpentAmount: $ref: '#/components/schemas/DeprecatedSystemCurrencyAmount' type: $ref: '#/components/schemas/ClassificationRef' workflow: $ref: '#/components/schemas/Workflow' visibility: $ref: '#/components/schemas/Visibility' links: type: array description: Links associated with the award. nullable: true items: $ref: '#/components/schemas/Link' keywordGroups: type: array description: Groups of keywords associated with the award. nullable: true items: $ref: '#/components/schemas/KeywordGroup' cluster: $ref: '#/components/schemas/AwardClusterRef' documents: type: array description: A collection of documents related to the award. nullable: true items: $ref: '#/components/schemas/AwardDocument' customDefinedFields: $ref: '#/components/schemas/CustomDefinedFields' systemName: type: string description: The content system name readOnly: true typeDiscriminator: type: string description: Awards exists in two variations depending on the functionality enabled in the Pure installation. discriminator: propertyName: typeDiscriminator mapping: BasicAward: '#/components/schemas/BasicAward' AwardManagementAward: '#/components/schemas/AwardManagementAward' AwardsQuery: type: object properties: uuids: type: array items: type: string format: uuid size: type: integer format: int32 offset: type: integer format: int32 orderings: type: array items: type: string searchString: type: string description: String used to perform search orderBy: type: string writeOnly: true description: Create a query for awards OrganizationRef: required: - uuid type: object description: A reference to an organization in the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' YearMonth: required: - month - year type: object properties: year: maximum: 4000 minimum: 0 type: integer format: int32 month: maximum: 12 minimum: 1 type: integer format: int32 description: A date that can be defined by only year and month nullable: true AwardDocument: required: - fileName - mimeType - type - versionType - visibility type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true fileId: type: string description: The id of the file readOnly: true fileName: type: string description: The documents file name mimeType: type: string description: The documents mime type size: type: integer description: The documents size in bytes format: int64 url: type: string description: Download url for the binary file readOnly: true fileStoreLocations: type: object additionalProperties: type: string description: Locations of the binary file in file stores. readOnly: true description: Locations of the binary file in file stores. readOnly: true uploadedFile: $ref: '#/components/schemas/UploadedFile' remoteFile: $ref: '#/components/schemas/RemoteFile' fileData: type: string description: Base64 encoded file data for new files. This property can be used instead of uploadedFile for small files format: byte writeOnly: true title: type: string description: Document title nullable: true type: $ref: '#/components/schemas/ClassificationRef' license: $ref: '#/components/schemas/ClassificationRef' visibleOnPortalDate: type: string description: The date the document will be available on the portal format: date readOnly: true visibility: $ref: '#/components/schemas/Visibility' creator: type: string description: The user that created the document readOnly: true created: type: string description: Create date for the document format: date-time readOnly: true versionType: $ref: '#/components/schemas/ClassificationRef' description: An award document. ProjectRef: required: - uuid type: object description: A reference to project nullable: true allOf: - $ref: '#/components/schemas/ContentRef' AwardBudget: required: - visibility type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true budgets: type: array description: Individual entries of the budget. nullable: true items: $ref: '#/components/schemas/AwardFundingBudgetAssociation' visibility: $ref: '#/components/schemas/Visibility' description: A budget for an award. ClassificationRef: required: - uri type: object properties: uri: type: string description: Classification URI of the referred classification term: $ref: '#/components/schemas/SystemLocalizedString' description: A reference to a classification value nullable: true Link: required: - url type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true url: type: string description: The URL (Uniform Resource Locator) of the link alias: type: string description: A user-friendly text to show instead of the URL nullable: true description: $ref: '#/components/schemas/LocalizedString' linkType: $ref: '#/components/schemas/ClassificationRef' description: A hyperlink describing a location on the web. UploadedFile: required: - key type: object properties: digest: type: string description: The calculated digest for the file in Pure readOnly: true digestType: type: string description: The digest type readOnly: true size: type: integer description: The file size of the file in Pure format: int64 readOnly: true mimeType: type: string description: The mime type detected for the file readOnly: true timeStamp: type: string description: The timestamp Pure received the file format: date-time readOnly: true expires: type: string description: The timestamp where Pure deletes the uploaded file if it has not been attached to any content format: date-time readOnly: true key: type: string description: Pure key identifer for the file upload readOnly: true description: Information about the uploaded file Account: type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true budget: $ref: '#/components/schemas/SystemCurrencyAmount' classification: $ref: '#/components/schemas/ClassificationRef' costCenter: $ref: '#/components/schemas/ClassificationRef' entries: type: array description: Associated account entries of the account. nullable: true items: $ref: '#/components/schemas/AccountEntry' funderContribution: $ref: '#/components/schemas/SystemCurrencyAmount' recoveryPercentage: type: number description: The recovery percentage of the budget. format: double nullable: true specification: type: string description: The specification of the budget. nullable: true yearlyBudgets: type: array description: Yearly budgets of the account. nullable: true items: $ref: '#/components/schemas/YearlyBudget' description: An account of a budget. DateRange: type: object properties: startDate: type: string description: Start date format: date nullable: true endDate: type: string description: End date format: date nullable: true description: A date range ApplicationRef: required: - uuid type: object description: A reference to an application nullable: true allOf: - $ref: '#/components/schemas/ContentRef' DisciplinesDisciplineAssignment: required: - disciplineId - splitPercentage type: object properties: disciplineId: type: string description: The assigned discipline splitPercentage: type: number description: The split percentages within an assigned discipline scheme must sum up to 100% format: double description: The assigned discipline and its split percentage DisciplinesDisciplineScheme: required: - disciplineScheme - title type: object properties: disciplineScheme: type: string description: The discipline scheme identifier title: type: string description: The discipline title description: A discipline scheme LocalizedString: type: object additionalProperties: type: string description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.' nullable: true example: '{"en_GB":"Some text"}' description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.' nullable: true example: en_GB: Some text AwardRef: required: - uuid type: object description: A reference to an award nullable: true allOf: - $ref: '#/components/schemas/ContentRef' DeprecatedSystemCurrencyAmount: required: - value type: object properties: currency: type: string description: 'An ISO-4217 3-letter alphabetic code representing the Pure installation''s system currency as defined by the W3C''s Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-currency' readOnly: true value: type: string description: 'A valid decimal monetary value as defined by the W3C''s Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-value' format: ^-?[0-9]+(\.[0-9]+)?$ description: Deprecated version of SystemCurrencyAmount deprecated: true Workflow: required: - step type: object properties: step: type: string description: Current workflow step description: $ref: '#/components/schemas/SystemLocalizedString' description: Information about workflow DeprecatedDateRange: type: object properties: startDate: type: string description: Start date format: date nullable: true endDate: type: string description: End date format: date nullable: true description: Deprecated version of DateRange deprecated: true ClassifiedFormattedLocalizedValue: required: - type type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true value: $ref: '#/components/schemas/FormattedLocalizedString' type: $ref: '#/components/schemas/ClassificationRef' description: A classified formatted localized value ResearcherCommitment: required: - yearMonth type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true actualResearcherCommitment: maximum: 1 minimum: 0 type: number description: The actual researcher commitment. format: double nullable: true plannedResearcherCommitment: maximum: 1 minimum: 0 type: number description: The planned researcher commitment. format: double nullable: true yearMonth: $ref: '#/components/schemas/YearMonth' description: Planned and actual research commitment. AllowedKeywordGroupConfiguration: required: - targetSystemName type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true targetSystemName: type: string description: The content system name this configuration applies to keywordGroupType: type: string description: The OpenAPI schema type of this keyword configuration readOnly: true name: $ref: '#/components/schemas/LocalizedString' description: $ref: '#/components/schemas/FormattedLocalizedString' classificationScheme: $ref: '#/components/schemas/ClassificationSchemeRef' allowUserdefinedKeywords: type: boolean description: Defines if user defined keywords are allowed limitToLeafSelection: type: boolean logicalName: type: string relationType: type: string description: The schema name of the type (with the ability to associate keywords) on which the keyword group configuration is related to, e.g. StaffOrganizationAssociation. It can also be set to null (default value), which means the keyword group configuration is related to the main type (the target system name) and not a relation of the main type. nullable: true description: A specification of the allowed behavior of a specified keyword group ClassificationSchemeRef: required: - uuid type: object description: A reference to a classification scheme nullable: true allOf: - $ref: '#/components/schemas/ContentRef' SystemLocalizedString: type: object additionalProperties: type: string description: A set of localized string values each for a specific UI locale. nullable: true example: '{"en_GB":"Some text"}' description: A set of localized string values each for a specific UI locale. nullable: true example: en_GB: Some text CustomDefinedFields: type: object additionalProperties: $ref: '#/components/schemas/CustomDefinedField' description: Map of CustomDefinedField values, where the key is the field identifier nullable: true example: '{ "fieldName1": "typeDiscriminator": "Integer", "value" : 1}' DisciplinesAssociationListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Discipline associations items: $ref: '#/components/schemas/DisciplinesAssociation' description: List of discipline associations. Can contain a subset of all items along with the full count AwardCluster: type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true uuid: type: string description: UUID, this is the primary identity of the entity format: uuid readOnly: true createdBy: type: string description: Username of creator readOnly: true createdDate: type: string description: Date and time of creation format: date-time readOnly: true modifiedBy: type: string description: Username of the user that performed a modification readOnly: true modifiedDate: type: string description: Date and time of last modification format: date-time readOnly: true portalUrl: type: string description: URL of the content on the Pure Portal readOnly: true prettyUrlIdentifiers: type: array description: All pretty URLs readOnly: true items: type: string description: All pretty URLs readOnly: true previousUuids: type: array description: UUIDs of other content items which have been merged into this content item (or similar) readOnly: true items: type: string description: UUIDs of other content items which have been merged into this content item (or similar) readOnly: true version: type: string description: Used to guard against conflicting updates. For new content this is null, and for existing content the current value. The property should never be modified by a client, except in the rare case where the client wants to perform an update irrespective of if other clients have made updates in the meantime, also known as a "dirty write". A dirty write is performed by not including the property value or setting the property to null nullable: true title: type: string description: The title of the award cluster. readOnly: true containedAwards: type: array description: The awards grouped in the award cluster. Awards are automatically added when related to other awards in this cluster. readOnly: true items: $ref: '#/components/schemas/AwardRef' project: $ref: '#/components/schemas/ProjectRef' systemName: type: string description: The content system name readOnly: true description: An award cluster groups related awards from their individual relations. KeywordGroup: required: - logicalName - typeDiscriminator type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true logicalName: type: string description: Unique name of the configuration that specifies this keyword group name: $ref: '#/components/schemas/LocalizedString' typeDiscriminator: type: string discriminator: propertyName: typeDiscriminator mapping: ClassificationsKeywordGroup: '#/components/schemas/ClassificationsKeywordGroup' FreeKeywordsKeywordGroup: '#/components/schemas/FreeKeywordsKeywordGroup' FullKeywordGroup: '#/components/schemas/FullKeywordGroup' AllowedKeywordGroupConfigurationList: type: object properties: configurations: type: array items: $ref: '#/components/schemas/AllowedKeywordGroupConfiguration' description: List of allowed keyword group configurations WorkflowListResult: type: object properties: workflows: type: array description: Allowed workflow steps. items: $ref: '#/components/schemas/Workflow' description: List of workflow steps. ClassificationRefList: type: object properties: classifications: type: array items: $ref: '#/components/schemas/ClassificationRef' description: List of classification references LocalesList: type: object properties: locales: pattern: /^[a-z]{2}_[A-Z]{2}$/ type: array description: Allowed locale values for use in localized string entities. The locale format consists of lower-case ISO 639 alpha-2 language code and upper-cased ISO 3166 alpha-2 country code. items: pattern: /^[a-z]{2}_[A-Z]{2}$/ type: string description: Allowed locale values for use in localized string entities. The locale format consists of lower-case ISO 639 alpha-2 language code and upper-cased ISO 3166 alpha-2 country code. description: List of available locales AwardClusterRef: required: - uuid type: object description: A reference to an award cluster nullable: true allOf: - $ref: '#/components/schemas/ContentRef' AwardBudgetResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: AwardBudgets items: $ref: '#/components/schemas/AwardBudget' description: List of award budgets. Can contain a subset of all items along with the full count FormattedLocalizedString: type: object additionalProperties: type: string description: A set of localized strings that support formatting. Invalid locale values will be ignored. nullable: true example: '{"en_GB":"Some text"}' description: A set of localized strings that support formatting. Invalid locale values will be ignored. nullable: true example: en_GB: Some text ExternalOrganizationRef: required: - uuid type: object description: A reference to an organization external to the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' CustomDefinedField: required: - typeDiscriminator type: object properties: typeDiscriminator: type: string description: Map of CustomDefinedField values, where the key is the field identifier nullable: true example: '{ "fieldName1": "typeDiscriminator": "Integer", "value" : 1}' discriminator: propertyName: typeDiscriminator mapping: Integer: '#/components/schemas/CustomDefinedFieldInteger' String: '#/components/schemas/CustomDefinedFieldString' Date: '#/components/schemas/CustomDefinedFieldDate' Classification: '#/components/schemas/CustomDefinedFieldClassification' Boolean: '#/components/schemas/CustomDefinedFieldBoolean' Decimal: '#/components/schemas/CustomDefinedFieldDecimal' NoteListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Notes items: $ref: '#/components/schemas/Note' description: List of notes AwardListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Applications items: $ref: '#/components/schemas/Award' description: List of awards. Can contain a subset of all items along with the full count Note: required: - text type: object properties: date: type: string description: Date and time of when the note was created, an event occurred or similar. Can be any point in time, but is normally preferred format: date-time nullable: true username: type: string description: Username related to the note. Usually a username of the user creating the note. Does not have to be a username of a Pure user nullable: true text: type: string description: Note text description: A note AllowedTemplate: type: object properties: name: type: string description: The name of the template. readOnly: true description: type: string description: The description of the template. readOnly: true description: An allowed template, such as 'ContributionToJournal' or 'BookAnthology' for research outputs. OrderingsList: type: object properties: orderings: type: array description: IDs of ways content can be ordered items: type: string description: IDs of ways content can be ordered description: List of available orderings AccountEntry: type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true amount: $ref: '#/components/schemas/SystemCurrencyAmount' yearMonth: $ref: '#/components/schemas/YearMonth' commitment: type: boolean description: Is the entry only a commitment? description: An account entry of an account. AwardFundingBudgetAssociation: required: - visibility type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true accounts: type: array description: Associated accounts of the budget. nullable: true items: $ref: '#/components/schemas/Account' costCenter: $ref: '#/components/schemas/ClassificationRef' costCode: type: string description: The cost code of the budget. nullable: true organization: $ref: '#/components/schemas/OrganizationRef' visibility: $ref: '#/components/schemas/Visibility' description: A budget for a financial funding of an award. AwardFundingAssociation: required: - typeDiscriminator type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true costCode: type: string description: The cost code of the funding. nullable: true funder: $ref: '#/components/schemas/ExternalOrganizationRef' internalFunder: $ref: '#/components/schemas/OrganizationRef' classifications: type: array description: Related classifications of the funding. nullable: true items: $ref: '#/components/schemas/ClassificationRef' fundingProjectScheme: type: string description: The funding project scheme of the funding, also known as research program. nullable: true visibility: $ref: '#/components/schemas/Visibility' typeDiscriminator: type: string description: Funding associations exists in two variants, financial or non-financial. discriminator: propertyName: typeDiscriminator mapping: AwardFinancialFundingAssociation: '#/components/schemas/AwardFinancialFundingAssociation' AwardNonFinancialFundingAssociation: '#/components/schemas/AwardNonFinancialFundingAssociation' DisciplinesDisciplineSchemeListResult: type: object properties: count: type: integer description: The amount of discipline schemes format: int32 items: type: array description: Discipline schemes items: $ref: '#/components/schemas/DisciplinesDisciplineScheme' description: List of discipline schemes DisciplinesDiscipline: type: object properties: disciplineId: type: string description: The discipline identifier readOnly: true title: type: string description: The discipline title readOnly: true description: type: string description: The discipline description readOnly: true description: A discipline within a specific discipline scheme Name: type: object properties: firstName: type: string lastName: type: string description: A name describing a person, made up of given- and family name ProblemDetails: type: object properties: type: type: string description: A URI reference [RFC3986] that identifies the problem type. title: type: string description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). status: type: integer description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. description: RFC7807 Error details discriminator: propertyName: type mapping: /error: '#/components/schemas/GenericProblemDetails' /validation-error: '#/components/schemas/ValidationProblemDetails' /dependency-violation-error: '#/components/schemas/DependencyViolationProblemDetails' RemoteFile: required: - fileId - fileState - sourceId - storeName type: object properties: sourceId: type: string description: The remote source ID storeName: type: string description: The name of the remote store timeStamp: type: string description: The timestamp at which the file was stored format: date-time fileId: type: string description: The remote file ID fileState: type: string description: The remote file state enum: - AWAITING_CREATION - CREATION_IN_PROGRESS - CREATION_FAILED - STORED - AWAITING_DELETE - DELETE_IN_PROGRESS - DELETE_FAILED - DELETED metadataUpdateRequired: type: boolean description: Whether the file's metadata should be updated default: false description: Information about a remote file (Elsevier only) SystemCurrencyAmount: required: - value type: object properties: currency: type: string description: 'An ISO-4217 3-letter alphabetic code representing the Pure installation''s system currency as defined by the W3C''s Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-currency' readOnly: true value: type: string description: 'A valid decimal monetary value as defined by the W3C''s Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-value' format: ^-?[0-9]+(\.[0-9]+)?$ description: 'A monetary value in the Pure installation''s system currency as defined by the W3C''s Payment Request standard: https://www.w3.org/TR/payment-request/#paymentcurrencyamount-dictionary' Identifier: required: - typeDiscriminator type: object properties: typeDiscriminator: type: string discriminator: propertyName: typeDiscriminator mapping: ClassifiedId: '#/components/schemas/ClassifiedId' PrimaryId: '#/components/schemas/PrimaryId' Id: '#/components/schemas/Id' ConflictProblemDetails: type: object properties: type: type: string description: A URI reference [RFC3986] that identifies the problem type. title: type: string description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). status: type: integer description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. modified: type: string format: date-time modifiedBy: type: string description: Problem details for state conflict failures YearlyBudget: type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true budget: $ref: '#/components/schemas/SystemCurrencyAmount' year: type: integer description: The year of the yearly budget. format: int32 nullable: true description: A yearly budget of an account. AbstractAwardHolderAssociation: required: - role - typeDiscriminator type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true externalOrganizations: type: array description: A collection of external organization affiliations. nullable: true items: $ref: '#/components/schemas/ExternalOrganizationRef' academicOwnershipPercentage: maximum: 1 minimum: 0 type: number description: Academic ownership of the applicant. format: double nullable: true plannedResearcherCommitmentPercentage: maximum: 1 minimum: 0 type: number description: Planned researcher commitment of the applicant. format: double nullable: true researcherCommitments: type: array description: Planned and actual research commitment for the applicant. nullable: true items: $ref: '#/components/schemas/ResearcherCommitment' period: $ref: '#/components/schemas/DateRange' name: $ref: '#/components/schemas/Name' role: $ref: '#/components/schemas/ClassificationRef' typeDiscriminator: type: string description: An association between an award and a person that was awarded it. discriminator: propertyName: typeDiscriminator mapping: InternalAwardHolderAssociation: '#/components/schemas/InternalAwardHolderAssociation' ExternalAwardHolderAssociation: '#/components/schemas/ExternalAwardHolderAssociation' CollaboratorAssociation: required: - typeDiscriminator type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true type: $ref: '#/components/schemas/ClassificationRef' leadCollaborator: type: boolean description: Whether this collaborator is lead collaborator or not. nullable: true typeDiscriminator: type: string description: A collaborator associated with the content. discriminator: propertyName: typeDiscriminator mapping: InternalCollaboratorAssociation: '#/components/schemas/InternalCollaboratorAssociation' ExternalCollaboratorAssociation: '#/components/schemas/ExternalCollaboratorAssociation' DisciplinesAssociationsQuery: type: object properties: uuids: type: array items: type: string format: uuid size: type: integer format: int32 offset: type: integer format: int32 description: Create a query for discipline associations ContentRefListResult: type: object properties: items: type: array items: $ref: '#/components/schemas/ContentRef' description: List of Content Refs DisciplinesDisciplineListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Disciplines items: $ref: '#/components/schemas/DisciplinesDiscipline' description: List of disciplines for a specific discipline scheme AllowedTemplateListResult: type: object properties: items: type: array description: Allowed templates. items: $ref: '#/components/schemas/AllowedTemplate' description: List of allowed templates. securitySchemes: api-key: type: apiKey description: Security mechanism for the API name: api-key in: header