openapi: 3.0.3
info:
title: Pure Web Service 524
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:
- Use
the API key in query format.
- Use the API key in a header.
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
tags:
- name: datasets
- name: activities
- name: author-collaborations
- name: changes
- name: classification-schemes
- name: courses
- name: curricula-vitae
- name: ddp
- name: downloads
- name: equipments
- name: events
- name: external-organisations
- name: external-persons
- name: concepts
- name: fingerprints
- name: semantic-groups
- name: thesauri
- name: impacts
- name: journals
- name: keyword-group-configuration
- name: metadata
- name: organisational-units
- name: persons
- name: press-media
- name: prizes
- name: publishers
- name: research-outputs
- name: applications
- name: awards
- name: projects
paths:
/datasets:
get:
tags:
- datasets
summary: Lists all datasets
description: Lists all datasets in the Pure instance. If additional filtering of the amount of datasets returned, see
the POST version which supports additional filtering.
operationId: listDataSets
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:
- created
- dateAvailable
- rating
- modified
- title
- dataProduction
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/WSDataSetListResult'
application/json:
schema: *id001
post:
tags:
- datasets
summary: Complex operation for datasets
description: Lists datasets 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 Prize
documentation.
operationId: listDataSets_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id002
$ref: '#/components/schemas/WSDataSetsQuery'
application/json:
schema: *id002
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id003
$ref: '#/components/schemas/WSDataSetListResult'
application/json:
schema: *id003
/datasets/{id}:
get:
tags:
- datasets
summary: Get dataset
description: Get dataset with specific ID (path parameter).
operationId: getDataSet
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired dataset
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: &id004
$ref: '#/components/schemas/WSDataSet'
application/json:
schema: *id004
'404':
description: Resource not found
content:
application/xml:
schema: &id005
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id005
/datasets-meta/orderings:
get:
tags:
- datasets
summary: Lists available orderings
description: Lists all orderings available to the dataset endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id006
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id006
/datasets-meta/renderings:
get:
tags:
- datasets
summary: Lists available renderings
description: Lists all renderings available to the dataset endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id007
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id007
/activities:
get:
tags:
- activities
summary: Lists all activities
description: Lists all activities in the Pure instance. If you need to filter the activities returned, see the POST
version which supports additional filtering.
operationId: listActivities
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:
- created
- rating
- modified
- type
- title
- startDate
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: &id008
$ref: '#/components/schemas/WSActivityListResult'
application/json:
schema: *id008
post:
tags:
- activities
summary: Complex operation for activities
description: Lists activities 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 Activity
documentation.
operationId: listActivities_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id009
$ref: '#/components/schemas/WSActivityQuery'
application/json:
schema: *id009
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id010
$ref: '#/components/schemas/WSActivityListResult'
application/json:
schema: *id010
/activities-meta/orderings:
get:
tags:
- activities
summary: Lists available orderings
description: Lists all orderings available to the activity endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_1
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id011
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id011
/activities-meta/renderings:
get:
tags:
- activities
summary: Lists available renderings
description: Lists all renderings available to the activity endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_1
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id012
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id012
/activities/{id}:
get:
tags:
- activities
summary: Returns an activity
description: Returns an activity with specific ID (path parameter).
operationId: getActivity
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired activity
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: &id013
$ref: '#/components/schemas/WSAbstractActivity'
application/json:
schema: *id013
'404':
description: Resource not found
content:
application/xml:
schema: &id014
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id014
/author-collaborations:
get:
tags:
- author-collaborations
summary: Lists all author collaborations
description: Lists all author collaborations in the Pure instance. If filtering of the returned author collaborations
is required, see the POST version which supports additional filtering.
operationId: listAuthorCollaborations
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:
- created
- name
- rating
- 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
- 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: &id015
$ref: '#/components/schemas/WSAuthorCollaborationListResult'
application/json:
schema: *id015
post:
tags:
- author-collaborations
summary: Complex operation for author collaborations
description: Lists author collaborations 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 Author
Collaboration documentation
operationId: listAuthorCollaborations_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id016
$ref: '#/components/schemas/WSAuthorCollaborationsQuery'
application/json:
schema: *id016
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id017
$ref: '#/components/schemas/WSAuthorCollaborationListResult'
application/json:
schema: *id017
/author-collaborations/{id}:
get:
tags:
- author-collaborations
summary: Get author collaboration
description: Get author collaboration with specific ID (path parameter).
operationId: getAuthorCollaboration
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired author collaboration
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
- 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: &id018
$ref: '#/components/schemas/WSAuthorCollaboration'
application/json:
schema: *id018
'404':
description: Resource not found
content:
application/xml:
schema: &id019
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id019
/author-collaborations-meta/orderings:
get:
tags:
- author-collaborations
summary: Lists available orderings
description: Lists all orderings available to the author collaboration endpoint. These values can be used by the order
parameter.
operationId: getAvailableOrderings_2
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id020
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id020
/author-collaborations-meta/renderings:
get:
tags:
- author-collaborations
summary: Lists available renderings
description: Lists all renderings available to the author collaboration endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_2
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id021
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id021
/changes/{tokenOrDate}:
get:
tags:
- changes
summary: Get changes
description: Get changes from specific audit resumption token or date in the yyyy-MM-dd or yyyy-MM-dd_HH-mm-ss
format (e.g. 2017-04-24 or 2017-04-24_13-30-00) and onwards. In this endpoint a new event type exists that is called
'metricValueChange'. This indicated metric values has changed for the listed content. A change of metric values are
no longer considered a change of the pure content item and contentChange events will no longer be generated when metrics
values are updated. As a consumer you can choose to ignore the metric updates and only react upon the contentChange
events. Or if its important to listen for metric values changes, listen for both ContentChange and metricValueChange.
operationId: getChanges
security:
- apiKey: []
- api-key: []
parameters:
- name: tokenOrDate
in: path
required: true
description: Resumption token or date (in yyyy-MM-dd or yyyy-MM-dd_HH-mm-ss format) of the earliest audit entry
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
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
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: &id022
$ref: '#/components/schemas/WSChangeListResult'
application/json:
schema: *id022
'404':
description: Resource not found
content:
application/xml:
schema: &id023
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id023
/classification-schemes:
get:
tags:
- classification-schemes
summary: Lists all classification schemes
description: Lists all classification schemes in the Pure instance. If you need to filter the classification schemes
returned, see the POST version which supports additional filtering.
operationId: listClassificationSchemes
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:
- rating
- modified
- description
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
- short
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: &id024
$ref: '#/components/schemas/WSClassificationSchemeListResult'
application/json:
schema: *id024
post:
tags:
- classification-schemes
summary: Complex operation for classification schemes
description: Lists classification schemes 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 Classification
Scheme documentation.
operationId: listClassificationSchemes_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id025
$ref: '#/components/schemas/WSClassificationSchemesQuery'
application/json:
schema: *id025
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id026
$ref: '#/components/schemas/WSClassificationSchemeListResult'
application/json:
schema: *id026
/classification-schemes/{id}:
get:
tags:
- classification-schemes
summary: Returns a classification scheme
description: Returns a classification scheme with specific URI (path parameter).
operationId: getClassificationScheme
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired classification scheme
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
- short
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: &id027
$ref: '#/components/schemas/WSClassificationScheme'
application/json:
schema: *id027
'404':
description: Resource not found
content:
application/xml:
schema: &id028
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id028
/classification-schemes-meta/orderings:
get:
tags:
- classification-schemes
summary: Lists available orderings
description: Lists all orderings available to the classification scheme endpoint. These values can be used by the order
parameter.
operationId: getAvailableOrderings_3
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id029
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id029
/classification-schemes-meta/renderings:
get:
tags:
- classification-schemes
summary: Lists available renderings
description: Lists all renderings available to the classification scheme endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_3
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id030
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id030
/courses/active:
get:
tags:
- courses
summary: Lists active courses
description: Lists active courses.
operationId: listActiveCourses
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:
- endDate
- created
- rating
- modified
- title
- startDate
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: &id031
$ref: '#/components/schemas/WSCourseListResult'
application/json:
schema: *id031
/courses/inactive:
get:
tags:
- courses
summary: Lists inactive courses
description: Lists inactive courses.
operationId: listFormerCourses
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:
- endDate
- created
- rating
- modified
- title
- startDate
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: &id032
$ref: '#/components/schemas/WSCourseListResult'
application/json:
schema: *id032
/courses:
get:
tags:
- courses
summary: Lists all courses
description: Lists all courses in the Pure instance. If you need to filter the courses returned, see the POST version
which supports additional filtering.
operationId: listCourses
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:
- endDate
- created
- rating
- modified
- title
- startDate
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: &id033
$ref: '#/components/schemas/WSCourseListResult'
application/json:
schema: *id033
post:
tags:
- courses
summary: Complex operation for courses
description: Lists courses 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 Course
documentation.
operationId: listCourses_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id034
$ref: '#/components/schemas/WSCoursesQuery'
application/json:
schema: *id034
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id035
$ref: '#/components/schemas/WSCourseListResult'
application/json:
schema: *id035
/courses/{id}:
get:
tags:
- courses
summary: Get course
description: Get course with specific ID (path parameter).
operationId: getCourse
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired course
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: &id036
$ref: '#/components/schemas/WSCourse'
application/json:
schema: *id036
'404':
description: Resource not found
content:
application/xml:
schema: &id037
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id037
/courses-meta/orderings:
get:
tags:
- courses
summary: Lists available orderings
description: Lists all orderings available to the courses endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_4
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id038
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id038
/courses-meta/renderings:
get:
tags:
- courses
summary: Lists available renderings
description: Lists all renderings available to the courses endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_4
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id039
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id039
'404':
description: Resource not found
content:
application/xml:
schema: &id040
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id040
/curricula-vitae/{id}:
get:
tags:
- curricula-vitae
summary: Returns a curriculum vitae
description: Gets a curriculum vitae with specific ID (path parameter).
operationId: getCurriculumVitae
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired curriculum vitae
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:
- standard
- ddp_metadata
- cv_relations
- system
- inline
- 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: &id041
$ref: '#/components/schemas/WSCurriculumVitae'
application/json:
schema: *id041
'404':
description: Resource not found
content:
application/xml:
schema: &id042
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id042
/curricula-vitae:
get:
tags:
- curricula-vitae
summary: Lists all curricula vitae
description: Lists all curricula vitae in the Pure instance. If you need to filter the curricula vitae returned, see
the POST version which supports additional filtering.
operationId: listCurriculumVitae
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:
- created
- rating
- modified
- title
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:
- standard
- ddp_metadata
- cv_relations
- system
- inline
- 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: &id043
$ref: '#/components/schemas/WSCurriculumVitaeListResult'
application/json:
schema: *id043
post:
tags:
- curricula-vitae
summary: Complex operation for curricula vitae
description: Lists curricula vitae 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 Curriculum
Vitae documentation.
operationId: listCurriculumVitae_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id044
$ref: '#/components/schemas/WSCurriculumVitaeQuery'
application/json:
schema: *id044
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id045
$ref: '#/components/schemas/WSCurriculumVitaeListResult'
application/json:
schema: *id045
/curricula-vitae-meta/orderings:
get:
tags:
- curricula-vitae
summary: Lists available orderings
description: Lists all orderings available to the curricula vitae endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_5
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id046
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id046
/curricula-vitae-meta/renderings:
get:
tags:
- curricula-vitae
summary: Lists available renderings
description: Lists all renderings available to the curricula vitae endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_5
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id047
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id047
/downloads/{id}:
get:
tags:
- downloads
summary: Lists a summary of downloads
description: Lists all downloads in the Pure instance. If you need to filter the downloads returned, see the POST version
which supports additional filtering.
operationId: listDownloads
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: Name of the content in Pure to fetch download statistic for, e.g. ResearchOutput, Activity, Award, Project,
Application
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
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: &id048
$ref: '#/components/schemas/WSDownloadInformationCountListResult'
application/json:
schema: *id048
/downloads:
post:
tags:
- downloads
summary: Lists a summary of downloads
description: Lists all downloads in the Pure instance. If you need to filter the downloads returned, see the POST version
which supports additional filtering.
operationId: listDownloads_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id049
$ref: '#/components/schemas/WSDownloadsQuery'
application/json:
schema: *id049
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id050
$ref: '#/components/schemas/WSDownloadInformationCountListResult'
application/json:
schema: *id050
/downloads-meta/family:
get:
tags:
- downloads
summary: Lists available content types (families)
description: Lists all content types available to the download information endpoint. These values can be used by the
family parameter.
operationId: getAvailableFamilies
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id051
$ref: '#/components/schemas/WSStringListResult'
application/json:
schema: *id051
/equipments:
get:
tags:
- equipments
summary: Lists all equipment
description: Lists all equipment in the Pure instance. If you need to filter the equipment returned, see the POST version
which supports additional filtering.
operationId: listEquipment
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:
- created
- rating
- modified
- title
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
- fingerprint
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: &id052
$ref: '#/components/schemas/WSEquipmentListResult'
application/json:
schema: *id052
post:
tags:
- equipments
summary: Complex operation for equipment
description: Lists equipment 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 Equipment
documentation.
operationId: listEquipment_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id053
$ref: '#/components/schemas/WSEquipmentsQuery'
application/json:
schema: *id053
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id054
$ref: '#/components/schemas/WSEquipmentListResult'
application/json:
schema: *id054
/equipments/{id}/fingerprints:
get:
tags:
- equipments
summary: Lists fingerprints on an equipment
description: Lists all fingerprints associated to the equipment specified by an ID (supplied as path parameter).
operationId: listEquipmentFingerprints
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
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
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
- 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: &id055
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id055
'404':
description: Resource not found
content:
application/xml:
schema: &id056
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id056
/equipments/{id}:
get:
tags:
- equipments
summary: Get equipment
description: Get equipment with specific ID (path parameter).
operationId: getEquipment
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired equipment
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
- fingerprint
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: &id057
$ref: '#/components/schemas/WSEquipment'
application/json:
schema: *id057
'404':
description: Resource not found
content:
application/xml:
schema: &id058
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id058
/equipments-meta/orderings:
get:
tags:
- equipments
summary: Lists available orderings
description: Lists all orderings available to the equipment endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_6
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id059
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id059
/equipments-meta/renderings:
get:
tags:
- equipments
summary: Lists available renderings
description: Lists all renderings available to the equipment endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_6
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id060
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id060
/events:
get:
tags:
- events
summary: Lists all events
description: Lists all events in the Pure instance. If you need to filter the events returned, see the POST version
which supports additional filtering.
operationId: listEvents
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:
- created
- rating
- modified
- title
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: &id061
$ref: '#/components/schemas/WSEventListResult'
application/json:
schema: *id061
post:
tags:
- events
summary: Complex operation for events
description: Lists events 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 Event
documentation.
operationId: listEvents_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id062
$ref: '#/components/schemas/WSEventsQuery'
application/json:
schema: *id062
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id063
$ref: '#/components/schemas/WSEventListResult'
application/json:
schema: *id063
/events-meta/orderings:
get:
tags:
- events
summary: Lists available orderings
description: Lists all orderings available to the event endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_7
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id064
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id064
/events-meta/renderings:
get:
tags:
- events
summary: Lists available renderings
description: Lists all renderings available to the event endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_7
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id065
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id065
/events/{id}:
get:
tags:
- events
summary: Get event
description: Get an event with a specific ID (path parameter).
operationId: getEvent
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired event
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: &id066
$ref: '#/components/schemas/WSEvent'
application/json:
schema: *id066
'404':
description: Resource not found
content:
application/xml:
schema: &id067
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id067
/external-organisations:
get:
tags:
- external-organisations
summary: Lists all external organizations
description: Lists all external organizations in the Pure instance. If you need to filter the external organizations
returned, see the POST version which supports additional filtering.
operationId: listExternalOrganisations
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:
- name
- rating
- modified
- type
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: &id068
$ref: '#/components/schemas/WSExternalOrganisationListResult'
application/json:
schema: *id068
post:
tags:
- external-organisations
summary: Complex operation for external organizations
description: Lists external organizations 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 External
Organization documentation.
operationId: listExternalOrganisations_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id069
$ref: '#/components/schemas/WSExternalOrganisationsQuery'
application/json:
schema: *id069
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id070
$ref: '#/components/schemas/WSExternalOrganisationListResult'
application/json:
schema: *id070
/external-organisations/{id}:
get:
tags:
- external-organisations
summary: Get external organization
description: Get external organization with specific ID (path parameter).
operationId: getExternalOrganisation
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired external organization
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: &id071
$ref: '#/components/schemas/WSExternalOrganisation'
application/json:
schema: *id071
'404':
description: Resource not found
content:
application/xml:
schema: &id072
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id072
/external-organisations-meta/orderings:
get:
tags:
- external-organisations
summary: Lists available orderings
description: Lists all orderings available to the external organization endpoint. These values can be used by the order
parameter.
operationId: getAvailableOrderings_8
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id073
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id073
/external-organisations-meta/renderings:
get:
tags:
- external-organisations
summary: Lists available renderings
description: Lists all renderings available to the external organization endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_8
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id074
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id074
/external-persons:
get:
tags:
- external-persons
summary: Lists all external persons
description: Lists all external persons in the Pure instance. If you need to filter the external persons returned, see
the POST version which supports additional filtering.
operationId: listExternalPersons
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:
- lastName
- created
- rating
- 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: &id075
$ref: '#/components/schemas/WSExternalPersonListResult'
application/json:
schema: *id075
post:
tags:
- external-persons
summary: Complex operation for external persons
description: Lists external persons 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 External
person documentation.
operationId: listExternalPersons_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id076
$ref: '#/components/schemas/WSExternalPersonsQuery'
application/json:
schema: *id076
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id077
$ref: '#/components/schemas/WSExternalPersonListResult'
application/json:
schema: *id077
/external-persons/{id}:
get:
tags:
- external-persons
summary: Get external person
description: Get external person with specific ID (path parameter).
operationId: getExternalPerson
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired external person
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: &id078
$ref: '#/components/schemas/WSExternalPerson'
application/json:
schema: *id078
'404':
description: Resource not found
content:
application/xml:
schema: &id079
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id079
/external-persons-meta/orderings:
get:
tags:
- external-persons
summary: Lists available orderings
description: Lists all orderings available to the external person endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_9
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id080
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id080
/external-persons-meta/renderings:
get:
tags:
- external-persons
summary: Lists available renderings
description: Lists all renderings available to the external person endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_9
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id081
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id081
/concepts:
get:
tags:
- concepts
summary: Lists all concepts
description: Lists all concepts in the Pure instance.
operationId: listConcepts
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:
- rating
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
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: &id082
$ref: '#/components/schemas/WSConceptListResult'
application/json:
schema: *id082
post:
tags:
- concepts
summary: Complex operation for concepts
description: Lists concepts 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 Concept
documentation.
operationId: listConcepts_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id083
$ref: '#/components/schemas/WSConceptsQuery'
application/json:
schema: *id083
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id084
$ref: '#/components/schemas/WSConceptListResult'
application/json:
schema: *id084
/concepts/{id}:
get:
tags:
- concepts
summary: Get concept
description: Get concept with specific ID (path parameter).
operationId: getConcept
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired concept
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
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: &id085
$ref: '#/components/schemas/WSConcept'
application/json:
schema: *id085
'404':
description: Resource not found
content:
application/xml:
schema: &id086
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id086
/concepts-meta/orderings:
get:
tags:
- concepts
summary: Lists available orderings
description: Lists all orderings available to the concepts endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_10
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id087
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id087
/concepts-meta/renderings:
get:
tags:
- concepts
summary: Lists available renderings
description: Lists all renderings available to the concepts endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_10
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id088
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id088
/fingerprints:
get:
tags:
- fingerprints
summary: Lists all fingerprints
description: Lists all fingerprints in the Pure instance. If you need to filter the fingerprints returned, see the POST
version which supports additional filtering.
operationId: listFingerprints
security:
- apiKey: []
- api-key: []
parameters:
- 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
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
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: &id089
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id089
post:
tags:
- fingerprints
summary: Complex operation for fingerprints
description: Lists fingerprints 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 Fingerprint
documentation.
operationId: listFingerprints_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id090
$ref: '#/components/schemas/WSFingerprintsQuery'
application/json:
schema: *id090
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id091
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id091
/fingerprints-meta/orderings:
get:
tags:
- fingerprints
summary: Lists available orderings
description: Lists all orderings available to the fingerprints endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_11
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id092
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id092
/fingerprints-meta/renderings:
get:
tags:
- fingerprints
summary: Lists available renderings
description: Lists all renderings available to the fingerprints endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_11
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id093
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id093
/fingerprints/{id}:
get:
tags:
- fingerprints
summary: Get fingerprint
description: Get fingerprint with specific ID (path parameter).
operationId: getFingerprint
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired fingerprint
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
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: &id094
$ref: '#/components/schemas/WSFingerprint'
application/json:
schema: *id094
'404':
description: Resource not found
content:
application/xml:
schema: &id095
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id095
/semantic-groups/{id}:
get:
tags:
- semantic-groups
summary: Get semantic group
description: Get semantic group with specific ID (path parameter).
operationId: getSemanticGroup
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired semantic group
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
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: &id096
$ref: '#/components/schemas/WSSemanticGroup'
application/json:
schema: *id096
'404':
description: Resource not found
content:
application/xml:
schema: &id097
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id097
/semantic-groups:
get:
tags:
- semantic-groups
summary: Lists all semantic groups
description: Lists all semantic groups in the Pure instance.
operationId: listSemanticGroups
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:
- rating
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
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: &id098
$ref: '#/components/schemas/WSSemanticGroupListResult'
application/json:
schema: *id098
post:
tags:
- semantic-groups
summary: Complex operation for semantic groups
description: Lists semantic groups 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 Semantic
Group documentation.
operationId: listSemanticGroups_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id099
$ref: '#/components/schemas/WSSemanticGroupsQuery'
application/json:
schema: *id099
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id100
$ref: '#/components/schemas/WSSemanticGroupListResult'
application/json:
schema: *id100
/semantic-groups-meta/orderings:
get:
tags:
- semantic-groups
summary: Lists available orderings
description: Lists all orderings available to the semantic groups endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_12
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id101
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id101
/semantic-groups-meta/renderings:
get:
tags:
- semantic-groups
summary: Lists available renderings
description: Lists all renderings available to the semantic groups endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_12
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id102
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id102
/thesauri:
get:
tags:
- thesauri
summary: Lists all thesauri
description: Lists all thesauri in the Pure instance.
operationId: listThesauri
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:
- rating
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
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: &id103
$ref: '#/components/schemas/WSThesauriListResult'
application/json:
schema: *id103
post:
tags:
- thesauri
summary: Complex operation for thesauri
description: Lists thesauri 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 Thesauri
documentation.
operationId: listThesauri_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id104
$ref: '#/components/schemas/WSThesauriQuery'
application/json:
schema: *id104
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id105
$ref: '#/components/schemas/WSThesauriListResult'
application/json:
schema: *id105
/thesauri/{id}:
get:
tags:
- thesauri
summary: Get thesauri
description: Get thesauri with specific ID (path parameter).
operationId: getThesauri
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired thesauri
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
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: &id106
$ref: '#/components/schemas/WSThesauri'
application/json:
schema: *id106
'404':
description: Resource not found
content:
application/xml:
schema: &id107
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id107
/thesauri-meta/orderings:
get:
tags:
- thesauri
summary: Lists available orderings
description: Lists all orderings available to the thesauri endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_13
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id108
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id108
/thesauri-meta/renderings:
get:
tags:
- thesauri
summary: Lists available renderings
description: Lists all renderings available to the thesauri endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_13
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id109
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id109
/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: &id110
$ref: '#/components/schemas/WSImpactListResult'
application/json:
schema: *id110
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: &id111
$ref: '#/components/schemas/WSImpactsQuery'
application/json:
schema: *id111
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id112
$ref: '#/components/schemas/WSImpactListResult'
application/json:
schema: *id112
/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: &id113
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id113
/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: &id114
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id114
/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: &id115
$ref: '#/components/schemas/WSImpact'
application/json:
schema: *id115
'404':
description: Resource not found
content:
application/xml:
schema: &id116
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id116
/journals:
get:
tags:
- journals
summary: Lists all journals
description: Lists all journals in the Pure instance. If you need to filter the journals returned, see the POST version
which supports additional filtering.
operationId: listJournals
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:
- issn
- rating
- modified
- title
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: &id117
$ref: '#/components/schemas/WSJournalListResult'
application/json:
schema: *id117
post:
tags:
- journals
summary: Complex operation for journals
description: Lists journals 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 Journal
documentation.
operationId: listJournals_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id118
$ref: '#/components/schemas/WSJournalsQuery'
application/json:
schema: *id118
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id119
$ref: '#/components/schemas/WSJournalListResult'
application/json:
schema: *id119
/journals-meta/orderings:
get:
tags:
- journals
summary: Lists available orderings
description: Lists all orderings available to the journal endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_15
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id120
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id120
/journals-meta/renderings:
get:
tags:
- journals
summary: Lists available renderings
description: Lists all renderings available to the journal endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_15
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id121
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id121
/journals/{id}:
get:
tags:
- journals
summary: Get journal
description: Get journal with specific ID (path parameter).
operationId: getJournal
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired journal
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: &id122
$ref: '#/components/schemas/WSJournal'
application/json:
schema: *id122
'404':
description: Resource not found
content:
application/xml:
schema: &id123
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id123
/keyword-group-configurations/{id}:
get:
tags:
- keyword-group-configuration
summary: Get keyword group configuration
description: Get keyword group configuration with specific URI (path parameter).
operationId: getKeywordGroupConfiguration
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired keyword group configuration
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
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: &id124
$ref: '#/components/schemas/WSKeywordGroupConfiguration'
application/json:
schema: *id124
'404':
description: Resource not found
content:
application/xml:
schema: &id125
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id125
/keyword-group-configurations:
get:
tags:
- keyword-group-configuration
summary: Lists all keyword group configurations
description: Lists all keyword group configurations in the Pure instance. If filtering of the returned keyword group
configurations is required, see the POST version which supports additional filtering.
operationId: listKeywordGroupConfigurations
security:
- apiKey: []
- api-key: []
parameters:
- 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
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
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: &id126
$ref: '#/components/schemas/WSKeywordGroupConfigurationListResult'
application/json:
schema: *id126
post:
tags:
- keyword-group-configuration
summary: Complex operation for keyword group configurations
description: Lists keyword group configurations 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 Keyword
Group Configuration documentation
operationId: listKeywordGroupConfigurations_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id127
$ref: '#/components/schemas/WSKeywordGroupConfigurationQuery'
application/json:
schema: *id127
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id128
$ref: '#/components/schemas/WSKeywordGroupConfigurationListResult'
application/json:
schema: *id128
/keyword-group-configurations-meta/orderings:
get:
tags:
- keyword-group-configuration
summary: Lists available orderings
description: Lists all orderings available to the KeywordGroupConfiguration endpoint. These values can be used by the
order parameter.
operationId: getAvailableOrderings_16
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id129
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id129
/keyword-group-configurations-meta/renderings:
get:
tags:
- keyword-group-configuration
summary: Lists available renderings
description: Lists all renderings available to the KeywordGroupConfiguration endpoint. These values can be used by the
rendering parameter.
operationId: getAvailableRenderings_16
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id130
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id130
/organisational-units/{id}:
get:
tags:
- organisational-units
summary: Get organizational unit
description: Get organizational unit with specific ID (path parameter).
operationId: getOrganisationalUnit
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired organizational unit
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
- fingerprint
- 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: &id131
$ref: '#/components/schemas/WSOrganisation'
application/json:
schema: *id131
'404':
description: Resource not found
content:
application/xml:
schema: &id132
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id132
/organisational-units:
get:
tags:
- organisational-units
summary: Lists all organizational units
description: Lists all organizational units in the Pure instance. If you need to filter the organizational units returned,
see the POST version which supports additional filtering.
operationId: listOrganisationalUnits
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:
- created
- name
- rating
- modified
- type
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
- fingerprint
- 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: &id133
$ref: '#/components/schemas/WSOrganisationListResult'
application/json:
schema: *id133
post:
tags:
- organisational-units
summary: Complex operation for organizational units
description: Lists organizational units 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 Organizational
unit documentation.
operationId: listOrganisationalUnits_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id134
$ref: '#/components/schemas/WSOrganisationsQuery'
application/json:
schema: *id134
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id135
$ref: '#/components/schemas/WSOrganisationListResult'
application/json:
schema: *id135
/organisational-units/active:
get:
tags:
- organisational-units
summary: Lists all active organizational units
description: Lists all active organizational units in the Pure instance.
operationId: listActiveOrganisationalUnits
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:
- created
- name
- rating
- modified
- type
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
- fingerprint
- 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: &id136
$ref: '#/components/schemas/WSOrganisationListResult'
application/json:
schema: *id136
/organisational-units/former:
get:
tags:
- organisational-units
summary: Lists all former organizational units
description: Lists all former organizational units in the Pure instance.
operationId: listFormerOrganisationalUnits
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:
- created
- name
- rating
- modified
- type
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
- fingerprint
- 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: &id137
$ref: '#/components/schemas/WSOrganisationListResult'
application/json:
schema: *id137
/organisational-units/{id}/hierarchy:
get:
tags:
- organisational-units
summary: Get organizational unit and all underlying organisations
description: Get organizational unit with specific ID (path parameter) and all underlying organisations.
operationId: listOrganisationHierarchy
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired organizational unit
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- created
- name
- rating
- modified
- type
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
- fingerprint
- short
- long
items:
type: string
- name: hierarchyDepth
in: query
required: false
description: Specify the hierarchy depth. Depth 1 only shows the root element. Default value is 8
schema:
type: integer
- name: hierarchyStrategy
in: query
required: false
description: Specify the hierarchy strategy to determine which units to show. Valid Strategies are 'PARENTS' and 'TAKEN_OVER'
schema:
type: string
enum:
- PARENTS
- TAKEN_OVER
default: PARENTS
- 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: &id138
$ref: '#/components/schemas/WSOrganisationListResult'
application/json:
schema: *id138
/organisational-units/{id}/courses:
get:
tags:
- organisational-units
summary: Lists courses on an organizational unit
description: Lists all courses associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitCourses
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- endDate
- created
- rating
- modified
- title
- startDate
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: 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: &id139
$ref: '#/components/schemas/WSCourseListResult'
application/json:
schema: *id139
'404':
description: Resource not found
content:
application/xml:
schema: &id140
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id140
/organisational-units/{id}/impacts:
get:
tags:
- organisational-units
summary: Lists impacts on an organizational unit
description: Lists all impacts associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitImpacts
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: 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: 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: &id141
$ref: '#/components/schemas/WSImpactListResult'
application/json:
schema: *id141
'404':
description: Resource not found
content:
application/xml:
schema: &id142
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id142
/organisational-units/{id}/persons:
get:
tags:
- organisational-units
summary: Lists persons on an organizational unit
description: Lists all persons associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitPersons
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- lastName
- rating
- 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
- fingerprint
- short
- cv_long
- 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
- 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: &id143
$ref: '#/components/schemas/WSPersonListResult'
application/json:
schema: *id143
'404':
description: Resource not found
content:
application/xml:
schema: &id144
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id144
/organisational-units/{id}/projects:
get:
tags:
- organisational-units
summary: Lists projects on an organizational unit
description: Lists all projects associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitProjects
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- firstParticipant
- owner
- totalAwardedAmountSum
- endDate
- acronym
- created
- rating
- firstFunder
- firstNatureType
- title
- totalSpendAmountSum
- typeClassification
- modified
- startDate
- status
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: 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: &id145
$ref: '#/components/schemas/WSUPMProjectListResult'
application/json:
schema: *id145
'404':
description: Resource not found
content:
application/xml:
schema: &id146
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id146
/organisational-units/{id}/awards:
get:
tags:
- organisational-units
summary: Lists awards on an organizational unit
description: Lists all awards associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitAwards
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- owner
- firstAwardholder
- acronym
- endDate
- created
- rating
- firstNatureType
- firstFunder
- awardDate
- title
- totalAwardedAmount
- typeClassification
- modified
- totalSpendAmount
- startDate
- firstClassifiedSource
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
- fingerprint
- 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
- 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: &id147
$ref: '#/components/schemas/WSAwardListResult'
application/json:
schema: *id147
'404':
description: Resource not found
content:
application/xml:
schema: &id148
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id148
/organisational-units/{id}/applications:
get:
tags:
- organisational-units
summary: Lists applications on an organizational unit
description: Lists all applications associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitApplications
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- owner
- projects
- endDate
- acronym
- created
- firstApplicant
- rating
- firstNatureType
- firstFunder
- title
- relatedApplications
- reviews
- awards
- typeClassification
- pureid
- modified
- totalAppliedAmount
- startDate
- internalapprovalworkflow
- applicationDate
- firstClassifiedSource
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: 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: &id149
$ref: '#/components/schemas/WSApplicationListResult'
application/json:
schema: *id149
'404':
description: Resource not found
content:
application/xml:
schema: &id150
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id150
/organisational-units/{id}/press-media:
get:
tags:
- organisational-units
summary: Lists press/media on an organizational unit
description: Lists all press/media associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitPressMedia
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: 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
- modified
- title
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: 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: &id151
$ref: '#/components/schemas/WSPressMediaListResult'
application/json:
schema: *id151
'404':
description: Resource not found
content:
application/xml:
schema: &id152
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id152
/organisational-units/{id}/research-outputs:
get:
tags:
- organisational-units
summary: Lists research outputs on an organizational unit
description: Lists all research outputs associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitResearchOutputs
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- publicationYearAndAuthor
- publicationYearAndTypeAndAuthor
- created
- rating
- typeAndAuthor
- type
- title
- typeAndYear
- authorLastName
- publicationYearAndTypeAndTitle
- publicationYear
- modified
- category
- publicationDate
- firstAuthor
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:
- portal-short
- standard
- detailsPortal
- mla
- author
- cbe
- authorlist
- expertKeywordGroupsPortal
- long
- BIBTEX
- vancouver
- ddp_metadata
- system
- apa
- fingerprint
- short
- harvard
- RIS
- researchOutputHeader
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
- 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: &id153
$ref: '#/components/schemas/WSResearchOutputListResult'
application/json:
schema: *id153
'404':
description: Resource not found
content:
application/xml:
schema: &id154
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id154
/organisational-units/{id}/datasets:
get:
tags:
- organisational-units
summary: Lists datasets on an organizational unit
description: Lists all datasets associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitDataSets
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- created
- dateAvailable
- rating
- modified
- title
- dataProduction
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: 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: &id155
$ref: '#/components/schemas/WSDataSetListResult'
application/json:
schema: *id155
'404':
description: Resource not found
content:
application/xml:
schema: &id156
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id156
/organisational-units/{id}/student-theses:
get:
tags:
- organisational-units
summary: Lists student theses on an organizational unit
description: Lists all student-theses associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitStudentTheses
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- awardYear
- authorLastName
- created
- rating
- modified
- title
- type
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
- inline
- 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
- 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: &id157
$ref: '#/components/schemas/WSStudentThesisListResult'
application/json:
schema: *id157
'404':
description: Resource not found
content:
application/xml:
schema: &id158
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id158
/organisational-units/{id}/prizes:
get:
tags:
- organisational-units
summary: Lists prizes on an organizational unit
description: Lists all prizes associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitPrizes
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- awardedDate
- created
- rating
- modified
- title
- type
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: 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: &id159
$ref: '#/components/schemas/WSPrizeListResult'
application/json:
schema: *id159
'404':
description: Resource not found
content:
application/xml:
schema: &id160
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id160
/organisational-units/{id}/fingerprints:
get:
tags:
- organisational-units
summary: Lists fingerprints on an organizational unit
description: Lists all fingerprints associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitFingerprints
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
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
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
- 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: &id161
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id161
'404':
description: Resource not found
content:
application/xml:
schema: &id162
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id162
/organisational-units/{id}/activities:
get:
tags:
- organisational-units
summary: Lists activities on an organizational unit
description: Lists all activities associated to the organizational unit specified by an ID (supplied as path parameter).
operationId: listOrganisationalUnitActivities
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- created
- rating
- modified
- type
- title
- startDate
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: 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: &id163
$ref: '#/components/schemas/WSActivityListResult'
application/json:
schema: *id163
'404':
description: Resource not found
content:
application/xml:
schema: &id164
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id164
/organisational-units-meta/orderings:
get:
tags:
- organisational-units
summary: Lists available orderings
description: Lists all orderings available to the organizational unit endpoint. These values can be used by the order
parameter.
operationId: getAvailableOrderings_17
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id165
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id165
/organisational-units-meta/renderings:
get:
tags:
- organisational-units
summary: Lists available renderings
description: Lists all renderings available to the organizational unit endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_17
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id166
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id166
/persons:
get:
tags:
- persons
summary: Lists all persons
description: Lists all persons in the Pure instance. If additional filtering of the amount of persons returned, see
the POST version which supports additional filtering.
operationId: listPersons
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:
- lastName
- rating
- 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
- fingerprint
- short
- cv_long
- 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: &id167
$ref: '#/components/schemas/WSPersonListResult'
application/json:
schema: *id167
post:
tags:
- persons
summary: Complex operation for persons
description: Lists persons 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 Person
documentation.
operationId: listPersons_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id168
$ref: '#/components/schemas/WSPersonsQuery'
application/json:
schema: *id168
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id169
$ref: '#/components/schemas/WSPersonListResult'
application/json:
schema: *id169
/persons/active:
get:
tags:
- persons
summary: Lists all active persons
description: Lists all active persons.
operationId: listActivePersons
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:
- lastName
- rating
- 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
- fingerprint
- short
- cv_long
- 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: &id170
$ref: '#/components/schemas/WSPersonListResult'
application/json:
schema: *id170
'404':
description: Resource not found
content:
application/xml:
schema: &id171
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id171
/persons/{id}/projects:
get:
tags:
- persons
summary: Lists projects on a person
description: Lists all projects associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonProjects
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- firstParticipant
- owner
- totalAwardedAmountSum
- endDate
- acronym
- created
- rating
- firstFunder
- firstNatureType
- title
- totalSpendAmountSum
- typeClassification
- modified
- startDate
- status
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: 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: &id172
$ref: '#/components/schemas/WSUPMProjectListResult'
application/json:
schema: *id172
'404':
description: Resource not found
content:
application/xml:
schema: &id173
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id173
/persons/{id}/projects/highlighted:
get:
tags:
- persons
summary: Lists highlighted projects on a person
description: Lists all highlighted projects associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonProjectsHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- 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: &id174
$ref: '#/components/schemas/WSUPMProjectListResult'
application/json:
schema: *id174
'404':
description: Resource not found
content:
application/xml:
schema: &id175
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id175
/persons/{id}/awards:
get:
tags:
- persons
summary: Lists awards on a person
description: Lists all awards associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonAwards
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- owner
- firstAwardholder
- acronym
- endDate
- created
- rating
- firstNatureType
- firstFunder
- awardDate
- title
- totalAwardedAmount
- typeClassification
- modified
- totalSpendAmount
- startDate
- firstClassifiedSource
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
- fingerprint
- 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
- 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: &id176
$ref: '#/components/schemas/WSAwardListResult'
application/json:
schema: *id176
'404':
description: Resource not found
content:
application/xml:
schema: &id177
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id177
/persons/{id}/awards/highlighted:
get:
tags:
- persons
summary: Lists highlighted awards on a person
description: Lists all highlighted awards associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonAwardsResearchOutputsHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- fingerprint
- 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
- 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: &id178
$ref: '#/components/schemas/WSAwardListResult'
application/json:
schema: *id178
'404':
description: Resource not found
content:
application/xml:
schema: &id179
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id179
/persons/{id}/applications:
get:
tags:
- persons
summary: Lists applications on a person
description: Lists all applications associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonApplications
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- owner
- projects
- endDate
- acronym
- created
- firstApplicant
- rating
- firstNatureType
- firstFunder
- title
- relatedApplications
- reviews
- awards
- typeClassification
- pureid
- modified
- totalAppliedAmount
- startDate
- internalapprovalworkflow
- applicationDate
- firstClassifiedSource
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: 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: &id180
$ref: '#/components/schemas/WSApplicationListResult'
application/json:
schema: *id180
'404':
description: Resource not found
content:
application/xml:
schema: &id181
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id181
/persons/{id}/applications/highlighted:
get:
tags:
- persons
summary: Lists highlighted applications on a person
description: Lists all highlighted applications associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonApplicationsHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- 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: &id182
$ref: '#/components/schemas/WSApplicationListResult'
application/json:
schema: *id182
'404':
description: Resource not found
content:
application/xml:
schema: &id183
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id183
/persons/{id}/courses:
get:
tags:
- persons
summary: Lists courses on a person
description: Lists all courses associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonCourses
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- endDate
- created
- rating
- modified
- title
- startDate
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: 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: &id184
$ref: '#/components/schemas/WSCourseListResult'
application/json:
schema: *id184
'404':
description: Resource not found
content:
application/xml:
schema: &id185
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id185
/persons/{id}/impacts:
get:
tags:
- persons
summary: Lists impacts on a person
description: Lists all impacts associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonImpacts
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: 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: 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: &id186
$ref: '#/components/schemas/WSImpactListResult'
application/json:
schema: *id186
'404':
description: Resource not found
content:
application/xml:
schema: &id187
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id187
/persons/{id}/impacts/highlighted:
get:
tags:
- persons
summary: Lists highlighted impacts on a person
description: Lists all highlighted impacts associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonImpactsHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- 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: &id188
$ref: '#/components/schemas/WSUPMProjectListResult'
application/json:
schema: *id188
'404':
description: Resource not found
content:
application/xml:
schema: &id189
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id189
/persons/{id}/prizes:
get:
tags:
- persons
summary: Lists prizes on a person
description: Lists all prizes associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonPrizes
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- awardedDate
- created
- rating
- modified
- title
- type
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: 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: &id190
$ref: '#/components/schemas/WSPrizeListResult'
application/json:
schema: *id190
'404':
description: Resource not found
content:
application/xml:
schema: &id191
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id191
/persons/{id}/prizes/highlighted:
get:
tags:
- persons
summary: Lists highlighted prizes on a person
description: Lists all highlighted prizes associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonPrizesHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- 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: &id192
$ref: '#/components/schemas/WSPrizeListResult'
application/json:
schema: *id192
'404':
description: Resource not found
content:
application/xml:
schema: &id193
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id193
/persons/{id}/datasets:
get:
tags:
- persons
summary: Lists datasets on a person
description: Lists all datasets associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonDataSets
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- created
- dateAvailable
- rating
- modified
- title
- dataProduction
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: 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: &id194
$ref: '#/components/schemas/WSDataSetListResult'
application/json:
schema: *id194
'404':
description: Resource not found
content:
application/xml:
schema: &id195
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id195
/persons/{id}/datasets/highlighted:
get:
tags:
- persons
summary: Lists highlighted datasets on a person
description: Lists all highlighted datasets associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonDataSetsHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- 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: &id196
$ref: '#/components/schemas/WSDataSetListResult'
application/json:
schema: *id196
'404':
description: Resource not found
content:
application/xml:
schema: &id197
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id197
/persons/{id}/fingerprints:
get:
tags:
- persons
summary: Lists fingerprints on a person
description: Lists all fingerprints associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonFingerprints
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
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
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
- 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: &id198
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id198
'404':
description: Resource not found
content:
application/xml:
schema: &id199
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id199
/persons/{id}/press-media:
get:
tags:
- persons
summary: Lists press/media on a person
description: Lists all press/media associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonPressMedia
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: 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
- modified
- title
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: 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: &id200
$ref: '#/components/schemas/WSPressMediaListResult'
application/json:
schema: *id200
'404':
description: Resource not found
content:
application/xml:
schema: &id201
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id201
/persons/{id}/press-media/highlighted:
get:
tags:
- persons
summary: Lists highlighted press/media on a person
description: Lists all highlighted press / media associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonPressMediaResearchOutputsHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: id
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
- 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: &id202
$ref: '#/components/schemas/WSPressMediaListResult'
application/json:
schema: *id202
'404':
description: Resource not found
content:
application/xml:
schema: &id203
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id203
/persons/{id}/research-outputs:
get:
tags:
- persons
summary: Lists research outputs on a person
description: Lists all research outputs associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonResearchOutputs
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- publicationYearAndAuthor
- publicationYearAndTypeAndAuthor
- created
- rating
- typeAndAuthor
- type
- title
- typeAndYear
- authorLastName
- publicationYearAndTypeAndTitle
- publicationYear
- modified
- category
- publicationDate
- firstAuthor
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:
- portal-short
- standard
- detailsPortal
- mla
- author
- cbe
- authorlist
- expertKeywordGroupsPortal
- long
- BIBTEX
- vancouver
- ddp_metadata
- system
- apa
- fingerprint
- short
- harvard
- RIS
- researchOutputHeader
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
- 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: &id204
$ref: '#/components/schemas/WSResearchOutputListResult'
application/json:
schema: *id204
'404':
description: Resource not found
content:
application/xml:
schema: &id205
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id205
/persons/{id}/research-outputs/highlighted:
get:
tags:
- persons
summary: Lists highlighted research outputs on a person
description: Lists all highlighted research outputs associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonResearchOutputsHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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:
- portal-short
- standard
- detailsPortal
- mla
- author
- cbe
- authorlist
- expertKeywordGroupsPortal
- long
- BIBTEX
- vancouver
- ddp_metadata
- system
- apa
- fingerprint
- short
- harvard
- RIS
- researchOutputHeader
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
- 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: &id206
$ref: '#/components/schemas/WSResearchOutputListResult'
application/json:
schema: *id206
'404':
description: Resource not found
content:
application/xml:
schema: &id207
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id207
/persons/{id}/activities:
get:
tags:
- persons
summary: Lists activities on a person
description: Lists all activities associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonActivities
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- created
- rating
- modified
- type
- title
- startDate
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: 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: &id208
$ref: '#/components/schemas/WSActivityListResult'
application/json:
schema: *id208
'404':
description: Resource not found
content:
application/xml:
schema: &id209
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id209
/persons/{id}/activities/highlighted:
get:
tags:
- persons
summary: Lists highlighted activities on a person
description: Lists all highlighted activities associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonActivitiesHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- 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: &id210
$ref: '#/components/schemas/WSActivityListResult'
application/json:
schema: *id210
'404':
description: Resource not found
content:
application/xml:
schema: &id211
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id211
/persons/{id}/student-theses:
get:
tags:
- persons
summary: Lists student theses on a person
description: Lists all student theses associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonStudentTheses
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- awardYear
- authorLastName
- created
- rating
- modified
- title
- type
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
- inline
- 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
- 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: &id212
$ref: '#/components/schemas/WSStudentThesisListResult'
application/json:
schema: *id212
'404':
description: Resource not found
content:
application/xml:
schema: &id213
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id213
/persons/{id}/student-theses/highlighted:
get:
tags:
- persons
summary: Lists highlighted student theses on a person
description: Lists all highlighted student theses associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonStudentThesesHighlighted
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- inline
- 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
- 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: &id214
$ref: '#/components/schemas/WSStudentThesisListResult'
application/json:
schema: *id214
'404':
description: Resource not found
content:
application/xml:
schema: &id215
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id215
/persons/{id}/curricula-vitae:
get:
tags:
- persons
summary: Lists curriculum vitae on a person
description: Lists all curriculum vitae associated to the person specified by an ID (supplied as path parameter).
operationId: listPersonCurriculumVitae
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
enum:
- created
- rating
- modified
- title
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:
- standard
- ddp_metadata
- cv_relations
- system
- inline
- 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
- 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: &id216
$ref: '#/components/schemas/WSCurriculumVitaeListResult'
application/json:
schema: *id216
'404':
description: Resource not found
content:
application/xml:
schema: &id217
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id217
/persons/former:
get:
tags:
- persons
summary: Lists all former persons
description: Lists all former persons.
operationId: listFormerPersons
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:
- lastName
- rating
- 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
- fingerprint
- short
- cv_long
- 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: &id218
$ref: '#/components/schemas/WSPersonListResult'
application/json:
schema: *id218
'404':
description: Resource not found
content:
application/xml:
schema: &id219
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id219
/persons-meta/orderings:
get:
tags:
- persons
summary: Lists available orderings
description: Lists all orderings available to the person endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_18
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id220
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id220
/persons-meta/renderings:
get:
tags:
- persons
summary: Lists available renderings
description: Lists all renderings available to the person endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_18
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id221
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id221
/persons/{id}:
get:
tags:
- persons
summary: Get person
description: Get person with specific ID (path parameter).
operationId: getPerson
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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
- fingerprint
- short
- cv_long
- 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: &id222
$ref: '#/components/schemas/WSPerson'
application/json:
schema: *id222
'404':
description: Resource not found
content:
application/xml:
schema: &id223
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id223
/press-media:
get:
tags:
- press-media
summary: Lists all press/media
description: Lists all press/media in the Pure instance. If you need to filter the press/media records returned, see
the POST version which supports additional filtering.
operationId: listPressMedia_1
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
- modified
- title
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: &id224
$ref: '#/components/schemas/WSPressMediaListResult'
application/json:
schema: *id224
post:
tags:
- press-media
summary: Complex operation for press/media
description: Lists press/media 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 Press/Media
documentation.
operationId: listPressMedia
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id225
$ref: '#/components/schemas/WSPressMediaQuery'
application/json:
schema: *id225
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id226
$ref: '#/components/schemas/WSPressMediaListResult'
application/json:
schema: *id226
/press-media-meta/orderings:
get:
tags:
- press-media
summary: Lists available orderings
description: Lists all orderings available to the press/media endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_19
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id227
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id227
/press-media-meta/renderings:
get:
tags:
- press-media
summary: Lists available renderings
description: Lists all renderings available to the press/media endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_19
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id228
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id228
/press-media/{id}:
get:
tags:
- press-media
summary: Get press/media
description: Get press/media with specific ID (path parameter).
operationId: getPressMedia
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired press/media
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: &id229
$ref: '#/components/schemas/WSApplication'
application/json:
schema: *id229
'404':
description: Resource not found
content:
application/xml:
schema: &id230
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id230
/prizes:
get:
tags:
- prizes
summary: Lists all prizes
description: Lists all prizes in the Pure instance. If additional filtering of the amount of prizes returned, see the
POST version which supports additional filtering.
operationId: listPrizes
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:
- awardedDate
- created
- rating
- modified
- title
- type
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: &id231
$ref: '#/components/schemas/WSPrizeListResult'
application/json:
schema: *id231
post:
tags:
- prizes
summary: Complex operation for prizes
description: Lists prizes 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 Prize
documentation.
operationId: listPrizes_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id232
$ref: '#/components/schemas/WSPrizesQuery'
application/json:
schema: *id232
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id233
$ref: '#/components/schemas/WSPrizeListResult'
application/json:
schema: *id233
/prizes/{id}:
get:
tags:
- prizes
summary: Get prize
description: Get prize with specific ID (path parameter).
operationId: getPrize
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: &id234
$ref: '#/components/schemas/WSPrize'
application/json:
schema: *id234
'404':
description: Resource not found
content:
application/xml:
schema: &id235
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id235
/prizes-meta/orderings:
get:
tags:
- prizes
summary: Lists available orderings
description: Lists all orderings available to the prize endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_20
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id236
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id236
/prizes-meta/renderings:
get:
tags:
- prizes
summary: Lists available renderings
description: Lists all renderings available to the prize endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_20
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id237
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id237
/publishers:
get:
tags:
- publishers
summary: Lists all publishers
description: Lists all publishers in the Pure instance. If filtering is required for the the returned publishers, see
the POST version which supports additional filtering.
operationId: listPublishers
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:
- name
- rating
- 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: &id238
$ref: '#/components/schemas/WSPublishersListResult'
application/json:
schema: *id238
post:
tags:
- publishers
summary: Complex operation for publishers
description: Lists publishers 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 Publisher
documentation.
operationId: listPublishers_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id239
$ref: '#/components/schemas/WSPublishersQuery'
application/json:
schema: *id239
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id240
$ref: '#/components/schemas/WSPublishersListResult'
application/json:
schema: *id240
/publishers/approved:
get:
tags:
- publishers
summary: Get approved publishers
description: Lists the publishers in the Pure instance which are in the 'approved' workflow step.
operationId: listApprovedPublishers
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:
- name
- rating
- 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: &id241
$ref: '#/components/schemas/WSPublishersListResult'
application/json:
schema: *id241
/publishers/{id}:
get:
tags:
- publishers
summary: Get publisher
description: Get the publisher with specific ID (path parameter).
operationId: getPublisher
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired publisher
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: &id242
$ref: '#/components/schemas/WSPublisher'
application/json:
schema: *id242
'404':
description: Resource not found
content:
application/xml:
schema: &id243
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id243
/publishers-meta/orderings:
get:
tags:
- publishers
summary: Lists available orderings
description: Lists all orderings available to the publisher endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_21
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id244
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id244
/publishers-meta/renderings:
get:
tags:
- publishers
summary: Lists available renderings
description: Lists all renderings available to the publisher endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_21
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id245
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id245
/research-outputs-meta/author-roles:
get:
tags:
- research-outputs
summary: Lists available author roles
description: Lists all author roles available to the research output endpoint. These values can be used by the authorRole
parameter in POST calls.
operationId: getAvailableAuthorRoles
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id246
$ref: '#/components/schemas/WSAuthorRolesList'
application/json:
schema: *id246
/research-outputs:
get:
tags:
- research-outputs
summary: Lists all research outputs
description: Lists all research outputs in the Pure instance. If you need to filter the research outputs returned, see
the POST version which supports additional filtering.
operationId: listResearchOutputs
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:
- publicationYearAndAuthor
- publicationYearAndTypeAndAuthor
- created
- rating
- typeAndAuthor
- type
- title
- typeAndYear
- authorLastName
- publicationYearAndTypeAndTitle
- publicationYear
- modified
- category
- publicationDate
- firstAuthor
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:
- portal-short
- standard
- detailsPortal
- mla
- author
- cbe
- authorlist
- expertKeywordGroupsPortal
- long
- BIBTEX
- vancouver
- ddp_metadata
- system
- apa
- fingerprint
- short
- harvard
- RIS
- researchOutputHeader
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: &id247
$ref: '#/components/schemas/WSResearchOutputListResult'
application/json:
schema: *id247
post:
tags:
- research-outputs
summary: Complex operation for research output
description: Lists research outputs 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 Research
Output documentation.
operationId: listResearchOutputs_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id248
$ref: '#/components/schemas/WSResearchOutputsQuery'
application/json:
schema: *id248
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id249
$ref: '#/components/schemas/WSResearchOutputListResult'
application/json:
schema: *id249
/research-outputs/{id}/fingerprints:
get:
tags:
- research-outputs
summary: Lists impacts on a research output
description: Lists all fingerprints associated to the research-output specified by an ID (supplied as path parameter).
operationId: listResearchOutputFingerprints
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
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
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
- 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: &id250
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id250
'404':
description: Resource not found
content:
application/xml:
schema: &id251
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id251
/research-outputs/{id}:
get:
tags:
- research-outputs
summary: Get research output
description: Get research output with specific ID (path parameter).
operationId: getResearchOutput
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired research output
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:
- portal-short
- standard
- detailsPortal
- mla
- author
- cbe
- authorlist
- expertKeywordGroupsPortal
- long
- BIBTEX
- vancouver
- ddp_metadata
- system
- apa
- fingerprint
- short
- harvard
- RIS
- researchOutputHeader
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: &id252
$ref: '#/components/schemas/WSResearchOutput'
application/json:
schema: *id252
'404':
description: Resource not found
content:
application/xml:
schema: &id253
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id253
/research-outputs-meta/orderings:
get:
tags:
- research-outputs
summary: Lists available orderings
description: Lists all orderings available to the research output endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_22
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id254
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id254
/research-outputs-meta/renderings:
get:
tags:
- research-outputs
summary: Lists available renderings
description: Lists all renderings available to the research output endpoint. These values can be used by the rendering
parameter.
operationId: getAvailableRenderings_22
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id255
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id255
'404':
description: Resource not found
content:
application/xml:
schema: &id256
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id256
/applications:
get:
tags:
- applications
summary: Lists all applications
description: Lists all applications in the Pure instance. If you need to filter the applications returned, see the POST
version which supports additional filtering.
operationId: listApplications_1
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:
- owner
- projects
- endDate
- acronym
- created
- firstApplicant
- rating
- firstNatureType
- firstFunder
- title
- relatedApplications
- reviews
- awards
- typeClassification
- pureid
- modified
- totalAppliedAmount
- startDate
- internalapprovalworkflow
- applicationDate
- firstClassifiedSource
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: &id257
$ref: '#/components/schemas/WSApplicationListResult'
application/json:
schema: *id257
post:
tags:
- applications
summary: Complex operation for applications
description: Lists applications 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 Application
documentation.
operationId: listApplications
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id258
$ref: '#/components/schemas/WSApplicationsQuery'
application/json:
schema: *id258
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id259
$ref: '#/components/schemas/WSApplicationListResult'
application/json:
schema: *id259
/applications-meta/orderings:
get:
tags:
- applications
summary: Lists available orderings
description: Lists all orderings available to the application endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_23
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id260
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id260
/applications-meta/renderings:
get:
tags:
- applications
summary: Lists available renderings
description: Lists all renderings available to the application endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_23
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id261
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id261
/applications/{id}:
get:
tags:
- applications
summary: Get application
description: Get application with specific ID (path parameter).
operationId: getApplication
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired application
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: &id262
$ref: '#/components/schemas/WSApplication'
application/json:
schema: *id262
'404':
description: Resource not found
content:
application/xml:
schema: &id263
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id263
/awards:
get:
tags:
- awards
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: listAwards
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:
- owner
- firstAwardholder
- acronym
- endDate
- created
- rating
- firstNatureType
- firstFunder
- awardDate
- title
- totalAwardedAmount
- typeClassification
- modified
- totalSpendAmount
- startDate
- firstClassifiedSource
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
- fingerprint
- 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: &id264
$ref: '#/components/schemas/WSAwardListResult'
application/json:
schema: *id264
post:
tags:
- awards
summary: Complex operation for awards
description: Lists awards 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 Award
documentation.
operationId: listAwards_1
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id265
$ref: '#/components/schemas/WSAwardsQuery'
application/json:
schema: *id265
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id266
$ref: '#/components/schemas/WSAwardListResult'
application/json:
schema: *id266
/awards/{id}/fingerprints:
get:
tags:
- awards
summary: Lists fingerprints on an award
description: Lists all fingerprints associated to the award specified by an ID (supplied as path parameter).
operationId: listAwardFingerprints
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
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
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
- 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: &id267
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id267
'404':
description: Resource not found
content:
application/xml:
schema: &id268
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id268
/awards-meta/orderings:
get:
tags:
- awards
summary: Lists available orderings
description: Lists all orderings available to the award endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_24
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id269
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id269
/awards-meta/renderings:
get:
tags:
- awards
summary: Lists available renderings
description: Lists all renderings available to the award endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_24
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id270
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id270
/awards/{id}:
get:
tags:
- awards
summary: Get award
description: Get award with specific ID (path parameter).
operationId: getAward
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired award
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
- fingerprint
- 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: &id271
$ref: '#/components/schemas/WSAward'
application/json:
schema: *id271
'404':
description: Resource not found
content:
application/xml:
schema: &id272
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id272
/projects:
get:
tags:
- projects
summary: Lists all projects
description: Lists all projects in the Pure instance. If you need to filter the projects returned, see the POST version
which supports additional filtering.
operationId: listProjects_1
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:
- firstParticipant
- owner
- totalAwardedAmountSum
- endDate
- acronym
- created
- rating
- firstFunder
- firstNatureType
- title
- totalSpendAmountSum
- typeClassification
- modified
- startDate
- status
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: &id273
$ref: '#/components/schemas/WSUPMProjectListResult'
application/json:
schema: *id273
post:
tags:
- projects
summary: Complex operation for projects
description: Lists projects 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 Project
documentation.
operationId: listProjects
security:
- apiKey: []
- api-key: []
requestBody:
content:
application/xml:
schema: &id274
$ref: '#/components/schemas/WSUPMProjectsQuery'
application/json:
schema: *id274
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id275
$ref: '#/components/schemas/WSUPMProjectListResult'
application/json:
schema: *id275
/projects/{id}/fingerprints:
get:
tags:
- projects
summary: Lists fingerprints on a project
description: Lists all fingerprints associated to the project specified by an ID (supplied as path parameter).
operationId: listProjectFingerprints
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID
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: order
in: query
required: false
description: 'Specify the ordering of content in the result. Default: ID ascending. Read
more...'
schema:
type: array
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
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
- 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: &id276
$ref: '#/components/schemas/WSFingerprintListResult'
application/json:
schema: *id276
'404':
description: Resource not found
content:
application/xml:
schema: &id277
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id277
/projects/active:
get:
tags:
- projects
summary: Lists all active projects
description: Lists all active projects in the Pure instance.
operationId: listActiveProjects
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:
- firstParticipant
- owner
- totalAwardedAmountSum
- endDate
- acronym
- created
- rating
- firstFunder
- firstNatureType
- title
- totalSpendAmountSum
- typeClassification
- modified
- startDate
- status
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: &id278
$ref: '#/components/schemas/WSUPMProjectListResult'
application/json:
schema: *id278
/projects-meta/orderings:
get:
tags:
- projects
summary: Lists available orderings
description: Lists all orderings available to the project endpoint. These values can be used by the order parameter.
operationId: getAvailableOrderings_25
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id279
$ref: '#/components/schemas/WSOrderingsList'
application/json:
schema: *id279
/projects-meta/renderings:
get:
tags:
- projects
summary: Lists available renderings
description: Lists all renderings available to the project endpoint. These values can be used by the rendering parameter.
operationId: getAvailableRenderings_25
security:
- apiKey: []
- api-key: []
responses:
'200':
description: Successful operation
content:
application/xml:
schema: &id280
$ref: '#/components/schemas/WSRenderingsList'
application/json:
schema: *id280
/projects/{id}:
get:
tags:
- projects
summary: Get project
description: Get project with specific ID (path parameter).
operationId: getProject
security:
- apiKey: []
- api-key: []
parameters:
- name: id
in: path
required: true
description: ID of the desired project
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: &id281
$ref: '#/components/schemas/WSUPMProject'
application/json:
schema: *id281
'404':
description: Resource not found
content:
application/xml:
schema: &id282
$ref: '#/components/schemas/WSErrorResult'
application/json:
schema: *id282
components:
schemas:
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
WSAbstractMemorandum:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
applicant:
$ref: '#/components/schemas/WSExternalOrganisationRef'
projectNo:
type: string
journalNo:
type: string
dateFinished:
type: string
format: date-time
publicationSeries:
type: array
items:
$ref: '#/components/schemas/WSPublicationSeries'
xml:
name: researchOutput
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'
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
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'
WSActivityVisitorAssociation:
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
externalPerson:
$ref: '#/components/schemas/WSExternalPersonRef'
country:
$ref: '#/components/schemas/WSClassification'
visitorDegree:
type: string
externalOrganisations:
type: array
xml:
wrapped: true
items:
xml:
name: externalOrganisation
$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
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'
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
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'
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'
WSAttendance:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
xml:
name: attendance
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
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'
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
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
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
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'
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
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'
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'
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
WSAwardStatusDetailsStatus:
type: object
properties:
key:
type: string
xml:
attribute: true
enum:
- ContractNegotiation
- InternallyApproved
- Terminated
- ExtendedNoCost
value:
$ref: '#/components/schemas/WSLocalizedString'
WSBookAnthology:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
commissioningBody:
$ref: '#/components/schemas/WSExternalOrganisationRef'
volume:
type: string
publicationSeries:
type: array
xml:
wrapped: true
items:
xml:
name: publicationSerie
$ref: '#/components/schemas/WSPublicationSeries'
placeOfPublication:
type: string
edition:
type: string
isbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: isbn
electronicIsbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: electronicIsbn
publisher:
$ref: '#/components/schemas/WSPublisherRef'
bookSeries:
type: array
xml:
wrapped: true
items:
xml:
name: bookSerie
$ref: '#/components/schemas/WSBookSeriesJournalAssociation'
event:
$ref: '#/components/schemas/WSEventRef'
xml:
name: bookAnthology
WSBookSeriesJournalAssociation:
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:
$ref: '#/components/schemas/WSTemporalTitle'
issn:
$ref: '#/components/schemas/WSTemporalISSN'
journal:
$ref: '#/components/schemas/WSJournalRef'
'no':
type: string
volume:
type: string
WSCaseNote:
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
court:
$ref: '#/components/schemas/WSExternalOrganisationRef'
title:
$ref: '#/components/schemas/WSLocalizedString'
judgementDate:
type: string
format: date-time
classifiedSources:
type: array
xml:
name: ids
wrapped: true
items:
xml:
name: id
$ref: '#/components/schemas/WSClassifiedValue'
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'
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'
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'
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'
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
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
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'
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
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'
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'
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
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'
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'
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'
WSCompoundDate:
type: object
properties:
year:
type: integer
format: int32
month:
type: integer
format: int32
day:
type: integer
format: int32
WSCompoundDateRange:
type: object
properties:
startDate:
$ref: '#/components/schemas/WSCompoundDate'
endDate:
$ref: '#/components/schemas/WSCompoundDate'
WSConferenceSeries:
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:
type: string
shortTitle:
type: string
alternativeTitles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: alternativeTitle
frequency:
type: string
type:
$ref: '#/components/schemas/WSClassification'
keywordGroups:
type: array
xml:
wrapped: true
items:
xml:
name: keywordGroup
$ref: '#/components/schemas/WSKeywordGroup'
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: conferenceSeries
WSConferenceSeriesRef:
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/WSConferenceSeries'
WSConsultancy:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
associatedOrganisationalUnit:
$ref: '#/components/schemas/WSOrganisationRef'
associatedExternalOrganisation:
$ref: '#/components/schemas/WSExternalOrganisationRef'
xml:
name: consultancy
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
WSContributionToBookAnthology:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
placeOfPublication:
type: string
edition:
type: string
isbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: isbn
electronicIsbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: electronicIsbn
publisher:
$ref: '#/components/schemas/WSPublisherRef'
event:
$ref: '#/components/schemas/WSEventRef'
publicationSeries:
type: array
xml:
wrapped: true
items:
xml:
name: publicationSerie
$ref: '#/components/schemas/WSPublicationSeries'
pages:
type: string
volume:
type: string
hostPublicationEditors:
type: array
xml:
wrapped: true
items:
xml:
name: hostPublicationEditor
$ref: '#/components/schemas/WSName'
hostPublicationTitle:
$ref: '#/components/schemas/WSValue'
hostPublicationSubTitle:
$ref: '#/components/schemas/WSValue'
translatedHostPublicationTitle:
$ref: '#/components/schemas/WSLocalizedString'
translatedHostPublicationSubtitle:
xml:
name: translatedHostPublicationSubTitle
$ref: '#/components/schemas/WSLocalizedString'
articleNumber:
type: string
courtCases:
type: array
xml:
wrapped: true
description: Only available when the proper configuration is enabled
items:
xml:
name: courtCase
$ref: '#/components/schemas/WSCaseNote'
commissioningBody:
$ref: '#/components/schemas/WSExternalOrganisationRef'
bookSeries:
type: array
xml:
wrapped: true
items:
xml:
name: bookSerie
$ref: '#/components/schemas/WSBookSeriesJournalAssociation'
chapter:
type: string
conferenceSeries:
description: Only available when the Conferenceseries module is enabled
$ref: '#/components/schemas/WSConferenceSeriesRef'
xml:
name: contributionToBookAnthology
WSContributionToConference:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
pages:
type: string
event:
$ref: '#/components/schemas/WSEventRef'
xml:
name: contributionToConference
WSContributionToJournal:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
pages:
type: string
volume:
type: string
articleNumber:
type: string
journalNumber:
type: string
courtCases:
type: array
xml:
wrapped: true
description: Only available when the proper configuration is enabled
items:
xml:
name: courtCase
$ref: '#/components/schemas/WSCaseNote'
conferenceSeries:
description: Only available when the Conferenceseries module is enabled
$ref: '#/components/schemas/WSConferenceSeriesRef'
journal:
$ref: '#/components/schemas/WSJournalAssociation'
xml:
name: contributionToJournal
WSContributionToMemorandum:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
applicant:
$ref: '#/components/schemas/WSExternalOrganisationRef'
projectNo:
type: string
journalNo:
type: string
dateFinished:
type: string
format: date-time
publicationSeries:
type: array
xml:
wrapped: true
items:
xml:
name: publicationSerie
$ref: '#/components/schemas/WSPublicationSeries'
bookSeries:
type: array
xml:
wrapped: true
items:
xml:
name: bookSerie
$ref: '#/components/schemas/WSBookSeriesJournalAssociation'
xml:
name: contributionToMemorandum
WSContributionToPeriodical:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
publisher:
$ref: '#/components/schemas/WSPublisherRef'
volume:
type: string
number:
type: string
pages:
type: string
journal:
$ref: '#/components/schemas/WSJournalAssociation'
xml:
name: contributionToPeriodical
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
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
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
WSDataSetListResult:
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/WSDataSet'
xml:
name: result
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'
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'
WSDateRange:
type: object
properties:
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
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
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
WSEditorialWork:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
journal:
$ref: '#/components/schemas/WSJournalAssociation'
publisher:
$ref: '#/components/schemas/WSPublisherRef'
event:
$ref: '#/components/schemas/WSEventRef'
xml:
name: editorialWork
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
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
WSEligibilityFulfillmentType:
type: object
properties:
key:
type: string
xml:
attribute: true
enum:
- RECOMMENDATION
- REQUIREMENT
value:
$ref: '#/components/schemas/WSLocalizedString'
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
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'
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'
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
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'
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'
WSEthicalReviewReply:
type: object
properties:
key:
type: string
xml:
attribute: true
enum:
- PENDING
- APPROVED
- DECLINED
- EXTENDED
- WITHDRAWN
- EXPIRED
value:
$ref: '#/components/schemas/WSLocalizedString'
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
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'
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
WSExamination:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
examinees:
type: array
xml:
wrapped: true
items:
xml:
name: examinee
$ref: '#/components/schemas/WSExamineeAssociation'
examinationOrganisations:
type: array
xml:
wrapped: true
items:
xml:
name: examinationOrganisation
$ref: '#/components/schemas/WSInternalExternalOrganisationAssociation'
xml:
name: examination
WSExamineeAssociation:
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'
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
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'
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
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'
WSFileRef:
type: object
properties:
fileName:
type: string
mimeType:
type: string
size:
type: integer
format: int64
fileURL:
type: string
pureId:
type: integer
format: int64
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
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
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
WSFundingOpportunityEligibility:
type: object
properties:
eligibilityType:
$ref: '#/components/schemas/WSClassification'
eligibilityFulfillmentType:
$ref: '#/components/schemas/WSEligibilityFulfillmentType'
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'
WSGender:
type: object
properties:
key:
type: string
xml:
attribute: true
enum:
- MALE
- FEMALE
- UNKNOWN
value:
$ref: '#/components/schemas/WSLocalizedString'
WSGeoLocation:
type: object
properties:
point:
type: string
polygon:
type: string
calculatedPoint:
type: string
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
WSHostVisitor:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
visitors:
type: array
xml:
wrapped: true
items:
xml:
name: visitor
$ref: '#/components/schemas/WSActivityVisitorAssociation'
xml:
name: hostVisitor
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
WSId:
type: object
properties:
id:
type: string
idSource:
type: string
xml:
attribute: true
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
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
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'
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'
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'
WSJournal:
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'
titles:
type: array
xml:
wrapped: true
items:
xml:
name: title
$ref: '#/components/schemas/WSTemporalTitle'
type:
$ref: '#/components/schemas/WSClassification'
alternativeTitles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: alternativeTitle
electronicISSNs:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: electronicISSN
alternativeISSNs:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: alternativeISSN
publisher:
$ref: '#/components/schemas/WSPublisherRef'
country:
$ref: '#/components/schemas/WSClassification'
links:
type: array
xml:
wrapped: true
items:
xml:
name: link
$ref: '#/components/schemas/WSLink'
classifiedSources:
type: array
xml:
name: ids
wrapped: true
items:
xml:
name: id
$ref: '#/components/schemas/WSClassifiedValue'
doajIndexed:
type: boolean
sherpaRomeoPolicy:
$ref: '#/components/schemas/WSSherpaRomeoPolicy'
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'
scopusMetrics:
type: array
xml:
wrapped: true
items:
xml:
name: scopusMetric
$ref: '#/components/schemas/WSScopusMetrics'
issns:
type: array
items:
$ref: '#/components/schemas/WSTemporalISSN'
sherpaRomeoCustomerInformation:
type: string
xml:
name: journal
WSJournalAssociation:
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:
$ref: '#/components/schemas/WSTemporalTitle'
issn:
$ref: '#/components/schemas/WSTemporalISSN'
journal:
$ref: '#/components/schemas/WSJournalRef'
WSJournalRef:
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/WSJournal'
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
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'
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'
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
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'
WSLocalizedString:
type: object
properties:
formatted:
type: boolean
xml:
attribute: true
text:
type: array
items:
xml:
name: text
$ref: '#/components/schemas/WSLocalizedText'
WSLocalizedText:
type: object
properties:
locale:
type: string
xml:
attribute: true
value:
type: string
WSMembership:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
associatedOrganisationalUnit:
$ref: '#/components/schemas/WSOrganisationRef'
associatedExternalOrganisation:
$ref: '#/components/schemas/WSExternalOrganisationRef'
xml:
name: membership
WSMemorandum:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
applicant:
$ref: '#/components/schemas/WSExternalOrganisationRef'
projectNo:
type: string
journalNo:
type: string
dateFinished:
type: string
format: date-time
publicationSeries:
type: array
xml:
wrapped: true
items:
xml:
name: publicationSerie
$ref: '#/components/schemas/WSPublicationSeries'
bookSeries:
type: array
xml:
wrapped: true
items:
xml:
name: bookSerie
$ref: '#/components/schemas/WSBookSeriesJournalAssociation'
xml:
name: memorandum
WSName:
type: object
properties:
firstName:
type: string
lastName:
type: string
WSNavigationLink:
type: object
properties:
ref:
type: string
xml:
attribute: true
href:
type: string
xml:
attribute: true
WSNonTextual:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
placeOfPublication:
type: string
edition:
type: string
isbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: isbn
electronicIsbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: electronicIsbn
publisher:
$ref: '#/components/schemas/WSPublisherRef'
event:
$ref: '#/components/schemas/WSEventRef'
outputMedia:
$ref: '#/components/schemas/WSClassification'
size:
type: string
volume:
type: string
xml:
name: nonTextual
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
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'
WSOtherActivity:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
associatedOrganisationalUnit:
$ref: '#/components/schemas/WSOrganisationRef'
associatedExternalOrganisation:
$ref: '#/components/schemas/WSExternalOrganisationRef'
xml:
name: otherActivity
WSOtherContribution:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
publicationSeries:
type: array
xml:
wrapped: true
items:
xml:
name: publicationSerie
$ref: '#/components/schemas/WSPublicationSeries'
placeOfPublication:
type: string
edition:
type: string
isbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: isbn
electronicIsbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: electronicIsbn
publisher:
$ref: '#/components/schemas/WSPublisherRef'
volume:
type: string
typeDescription:
$ref: '#/components/schemas/WSLocalizedString'
outputMedia:
type: string
courtCases:
type: array
xml:
wrapped: true
description: Only available when the proper configuration is enabled
items:
xml:
name: courtCase
$ref: '#/components/schemas/WSCaseNote'
bookSeries:
type: array
xml:
wrapped: true
items:
xml:
name: bookSerie
$ref: '#/components/schemas/WSBookSeriesJournalAssociation'
xml:
name: otherContribution
WSPageInformation:
type: object
properties:
offset:
type: integer
format: int32
size:
type: integer
format: int32
xml:
name: pageInformation
WSPatent:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
country:
$ref: '#/components/schemas/WSClassification'
ipc:
type: string
patentNumber:
type: string
date:
type: string
format: date-time
priorityDate:
type: string
format: date-time
priorityNumber:
type: string
publisher:
$ref: '#/components/schemas/WSPublisherRef'
xml:
name: patent
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
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'
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'
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'
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'
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
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'
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'
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
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'
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
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'
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'
WSPublicationSeries:
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/WSValue'
publisherName:
type: string
printIssn:
type: string
xml:
name: issn
electronicIssn:
type: string
'no':
type: string
volume:
type: string
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'
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
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'
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'
WSReferenceType:
type: object
properties:
key:
type: string
xml:
attribute: true
enum:
- CONTRIBUTION
- COVERAGE
value:
$ref: '#/components/schemas/WSLocalizedString'
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
WSResearchOutputMetric:
type: object
properties:
value:
type: integer
format: int32
year:
type: integer
format: int32
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'
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
WSResidencyFlag:
type: object
properties:
key:
type: string
enum:
- UNKNOWN
- HOME
- OVERSEAS
value:
$ref: '#/components/schemas/WSLocalizedString'
WSScopusMetrics:
type: object
properties:
year:
type: integer
format: int32
citescore:
type: number
format: double
snip:
type: number
format: double
sjr:
type: number
format: double
WSSherpaRomeoOpenAccessPermission:
type: object
properties:
articleVersion:
type: string
enum:
- submitted
- accepted
- published
licenses:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: license
conditions:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: condition
prerequisites:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: prerequisite
funderPrerequisites:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: funderPrerequisite
subjectPrerequisites:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: subjectPrerequisite
locations:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: location
publisherDeposits:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: publisherDeposit
additionalFee:
type: boolean
embargo:
type: string
WSSherpaRomeoPolicy:
type: object
properties:
openAccessProhibited:
type: boolean
openAccessPermissions:
type: array
xml:
wrapped: true
items:
xml:
name: openAccessPermission
$ref: '#/components/schemas/WSSherpaRomeoOpenAccessPermission'
publisherPolicies:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: publisherPolicy
sherpaRomeoUri:
type: string
lastUpdatedDate:
type: string
format: date-time
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
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
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
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
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'
WSTalk:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
associatedOrganisationalUnit:
$ref: '#/components/schemas/WSOrganisationRef'
associatedExternalOrganisation:
$ref: '#/components/schemas/WSExternalOrganisationRef'
xml:
name: talk
WSTemporalISSN:
type: object
properties:
issn:
type: string
startDate:
type: string
xml:
attribute: true
endDate:
type: string
xml:
attribute: true
WSTemporalTitle:
type: object
properties:
title:
type: string
startDate:
type: string
xml:
attribute: true
endDate:
type: string
xml:
attribute: true
WSThesis:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
placeOfPublication:
type: string
edition:
type: string
isbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: isbn
electronicIsbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: electronicIsbn
publisher:
$ref: '#/components/schemas/WSPublisherRef'
volume:
type: string
publicationSeries:
type: array
xml:
wrapped: true
items:
xml:
name: publicationSerie
$ref: '#/components/schemas/WSPublicationSeries'
bookSeries:
type: array
xml:
wrapped: true
items:
xml:
name: bookSerie
$ref: '#/components/schemas/WSBookSeriesJournalAssociation'
qualification:
$ref: '#/components/schemas/WSClassification'
awardingInstitutions:
type: array
xml:
wrapped: true
items:
xml:
name: awardingInstitution
$ref: '#/components/schemas/WSInternalExternalOrganisationAssociation'
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'
supervisors:
type: array
xml:
wrapped: true
items:
xml:
name: supervisor
$ref: '#/components/schemas/WSClassifiedPersonAssociation'
sponsors:
type: array
xml:
wrapped: true
items:
xml:
name: sponsor
$ref: '#/components/schemas/WSExternalOrganisationRef'
awardedDate:
type: string
format: date-time
awardDate:
type: string
format: date-time
xml:
name: thesis
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
WSUPMProjectAssociation:
type: object
properties:
relationType:
$ref: '#/components/schemas/WSClassification'
project:
$ref: '#/components/schemas/WSUPMProjectRef'
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'
WSUPMProjectStatus:
type: object
properties:
key:
type: string
xml:
attribute: true
enum:
- NOT_STARTED
- RUNNING
- FINISHED
- CURTAILED
value:
$ref: '#/components/schemas/WSLocalizedString'
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'
WSUuidList:
type: object
properties:
family:
type: string
xml:
attribute: true
uuids:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: uuid
WSValue:
type: object
properties:
formatted:
type: boolean
xml:
attribute: true
value:
type: string
WSVisibility:
type: object
properties:
key:
type: string
xml:
attribute: true
enum:
- FREE
- CAMPUS
- BACKEND
value:
$ref: '#/components/schemas/WSLocalizedString'
WSVisitOther:
allOf:
- $ref: '#/components/schemas/WSAbstractActivity'
- type: object
properties:
event:
$ref: '#/components/schemas/WSEventRef'
associatedExternalOrganisation:
$ref: '#/components/schemas/WSExternalOrganisationRef'
xml:
name: visitOther
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
WSWorkflow:
type: object
properties:
workflowStep:
type: string
xml:
attribute: true
value:
$ref: '#/components/schemas/WSLocalizedString'
WSWorkingPaper:
allOf:
- $ref: '#/components/schemas/WSResearchOutput'
- type: object
properties:
volume:
type: string
pages:
type: string
publicationSeries:
type: array
xml:
wrapped: true
items:
xml:
name: publicationSerie
$ref: '#/components/schemas/WSPublicationSeries'
placeOfPublication:
type: string
edition:
type: string
isbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: isbn
electronicIsbns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: electronicIsbn
publisher:
$ref: '#/components/schemas/WSPublisherRef'
bookSeries:
type: array
xml:
wrapped: true
items:
xml:
name: bookSerie
$ref: '#/components/schemas/WSBookSeriesJournalAssociation'
xml:
name: workingPaper
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
WSDataSetsQuery:
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
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
forPublishers:
$ref: '#/components/schemas/WSPublisherNestedQuery'
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: dataSetsQuery
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
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
WSPublisherNestedQuery:
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
names:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: name
countryUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: countryUri
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
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: publishersNestedQuery
WSErrorResult:
type: object
properties:
code:
type: integer
format: int32
type:
type: string
title:
type: string
description:
type: string
xml:
name: error
WSOrderingsList:
type: object
properties:
orderings:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: ordering
xml:
name: orderings
WSRenderingsList:
type: object
properties:
renderings:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: rendering
xml:
name: renderings
WSActivityListResult:
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/WSAbstractActivity'
xml:
name: result
WSActivityQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
categoryUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: categoryUri
degreeOfRecognitionUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: degreeOfRecognitionUri
period:
$ref: '#/components/schemas/WSCompoundDateRange'
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forResearchOutputs:
$ref: '#/components/schemas/WSResearchOutputsNestedQuery'
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: activitiesQuery
WSBookSeriesNestedQuery:
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
titles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: title
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
issns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: issn
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
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: bookSeriesNestedQuery
WSJournalNestedQuery:
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
titles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: title
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
issns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: issn
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
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: journalsNestedQuery
WSResearchOutputsNestedQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
publicationStatuses:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: publicationStatus
publicationCategories:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: publicationCategory
peerReviews:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: peerReview
enum:
- PEER_REVIEW
- NOT_PEER_REVIEW
- NOT_SET
internationalPeerReviewed:
type: boolean
publishedBeforeDate:
type: string
format: date
publishedAfterDate:
type: string
format: date
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
forJournals:
$ref: '#/components/schemas/WSJournalNestedQuery'
forBookSeries:
$ref: '#/components/schemas/WSBookSeriesNestedQuery'
forPublishers:
$ref: '#/components/schemas/WSPublisherNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
authorRoles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: authorRole
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
includedOnStaffPages:
type: boolean
xml:
name: researchOutputsNestedQuery
WSAuthorCollaborationListResult:
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/WSAuthorCollaboration'
xml:
name: result
WSAuthorCollaborationsQuery:
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
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
xml:
name: authorCollaborationsQuery
WSAbstractChange:
type: object
WSChangeListResult:
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'
resumptionToken:
type: string
moreChanges:
type: boolean
items:
type: array
xml:
wrapped: true
items:
$ref: '#/components/schemas/WSAbstractChange'
xml:
name: result
WSClassificationScheme:
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'
baseUri:
type: string
typeClassification:
$ref: '#/components/schemas/WSClassification'
description:
$ref: '#/components/schemas/WSLocalizedString'
associatedSchemes:
type: array
xml:
wrapped: true
items:
xml:
name: associatedScheme
$ref: '#/components/schemas/WSClassificationSchemeRelation'
containedClassifications:
type: array
xml:
wrapped: true
items:
xml:
name: containedClassification
$ref: '#/components/schemas/WSClassification'
classifications:
type: array
xml:
wrapped: true
items:
xml:
name: classification
$ref: '#/components/schemas/WSClassification'
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: classificationScheme
WSClassificationSchemeListResult:
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/WSClassificationScheme'
xml:
name: result
WSClassificationSchemeRef:
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
baseUri:
type: string
xml:
attribute: true
ref:
$ref: '#/components/schemas/WSClassificationScheme'
WSClassificationSchemeRelation:
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:
$ref: '#/components/schemas/WSClassification'
title:
$ref: '#/components/schemas/WSLocalizedString'
classificationScheme:
$ref: '#/components/schemas/WSClassificationSchemeRef'
xml:
name: classificationScheme
WSClassificationSchemesQuery:
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
baseUri:
type: string
containedClassificationUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: containedClassificationUri
xml:
name: classificationSchemesQuery
WSClassifiedCourseDevelopedByAssociation:
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'
WSCourse:
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'
period:
$ref: '#/components/schemas/WSDateRange'
level:
$ref: '#/components/schemas/WSClassification'
format:
$ref: '#/components/schemas/WSClassification'
classifiedSources:
type: array
xml:
name: ids
wrapped: true
items:
xml:
name: id
$ref: '#/components/schemas/WSClassifiedValue'
creators:
type: array
xml:
wrapped: true
items:
xml:
name: creator
$ref: '#/components/schemas/WSClassifiedCourseDevelopedByAssociation'
organisationalUnits:
type: array
xml:
wrapped: true
items:
xml:
name: organisationalUnit
$ref: '#/components/schemas/WSOrganisationRef'
managingOrganisationalUnit:
$ref: '#/components/schemas/WSOrganisationRef'
occurrences:
type: array
xml:
name: courseOccurrences
wrapped: true
items:
xml:
name: courseOccurrence
$ref: '#/components/schemas/WSCourseOccurrence'
visibility:
$ref: '#/components/schemas/WSVisibility'
workflow:
$ref: '#/components/schemas/WSWorkflow'
keywordGroups:
type: array
xml:
name: keywordgroups
wrapped: true
items:
xml:
name: keywordgroup
$ref: '#/components/schemas/WSKeywordGroup'
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: course
WSCourseListResult:
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/WSCourse'
xml:
name: result
WSCourseOccurrence:
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
semester:
$ref: '#/components/schemas/WSClassification'
year:
type: integer
format: int32
lecturers:
type: array
xml:
wrapped: true
items:
xml:
name: lecturer
$ref: '#/components/schemas/WSClassifiedPersonAssociation'
numberOfStudents:
type: integer
format: int32
grade:
type: string
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'
WSCoursesQuery:
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
courseStatus:
type: string
enum:
- ACTIVE
- FORMER
titles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: title
types:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: type
formats:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: format
courseLevels:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: courseLevel
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'
forLecturerOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forLecturers:
$ref: '#/components/schemas/WSPersonsNestedQuery'
xml:
name: coursesQuery
WSAbstractCurriculumVitaeBlock:
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
WSCurriculumVitae:
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:
type: string
person:
$ref: '#/components/schemas/WSPersonRef'
type:
$ref: '#/components/schemas/WSClassification'
blocks:
type: array
xml:
wrapped: true
items:
xml:
name: block
$ref: '#/components/schemas/WSAbstractCurriculumVitaeBlock'
pdfURLs:
type: array
xml:
wrapped: true
items:
xml:
name: pdfURL
$ref: '#/components/schemas/WSCurriculumVitaePdfUrl'
confidential:
type: boolean
visibility:
$ref: '#/components/schemas/WSVisibility'
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: curriculumVitae
WSCurriculumVitaePdfUrl:
type: object
properties:
locale:
type: string
xml:
attribute: true
url:
type: string
xml:
name: href
attribute: true
xml:
name: pdfURL
WSCurriculumVitaeListResult:
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/WSCurriculumVitae'
xml:
name: result
WSCurriculumVitaeQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
xml:
name: curriculumVitaeQuery
WSContentRef:
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
WSDownloadInformationCount:
type: object
properties:
pureId:
type: integer
format: int64
contentRef:
$ref: '#/components/schemas/WSContentRef'
downloadCount:
type: integer
format: int32
xml:
name: download
WSDownloadInformationCountListResult:
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/WSDownloadInformationCount'
xml:
name: result
WSDownloadsQuery:
type: object
required:
- family
properties:
uuids:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: uuid
family:
type: string
accessTimeBeforeDate:
type: string
format: date-time
accessTimeAfterDate:
type: string
format: date-time
size:
type: integer
format: int32
offset:
type: integer
format: int32
navigationLink:
type: boolean
xml:
name: downloadsQuery
WSStringListResult:
type: object
properties:
items:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: item
count:
type: integer
format: int32
xml:
name: result
WSEquipmentListResult:
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/WSEquipment'
xml:
name: result
WSEquipmentsQuery:
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
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
managingOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
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
loanTypeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: loanTypeUri
xml:
name: equipmentsQuery
WSFingerprint:
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'
contentId:
type: integer
format: int64
contentUuid:
type: string
contentFamily:
type: string
contentVersion:
type: integer
format: int32
concepts:
type: array
xml:
wrapped: true
items:
xml:
name: concept
$ref: '#/components/schemas/WSRankedConcept'
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: fingerprint
WSFingerprintListResult:
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/WSFingerprint'
xml:
name: result
WSRankedConcept:
type: object
properties:
conceptUuid:
type: string
xml:
name: uuid
attribute: true
rank:
type: number
format: double
frequency:
type: integer
format: int32
weightedRank:
type: number
format: double
WSEventListResult:
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/WSEvent'
xml:
name: result
WSEventsQuery:
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
titles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: title
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
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: eventsQuery
WSExternalOrganisationListResult:
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/WSExternalOrganisation'
xml:
name: result
WSExternalOrganisationsQuery:
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
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
searchString:
type: string
xml:
name: externalOrganisationsQuery
WSExternalPersonListResult:
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/WSExternalPerson'
xml:
name: result
WSExternalPersonsQuery:
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
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: externalPersonsQuery
WSConcept:
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'
thesauri:
$ref: '#/components/schemas/WSThesauriRef'
conceptId:
type: string
parentConcepts:
type: array
xml:
name: concepts
wrapped: true
items:
xml:
name: concept
$ref: '#/components/schemas/WSConceptRef'
semanticGroups:
type: array
xml:
wrapped: true
items:
xml:
name: semanticGroup
$ref: '#/components/schemas/WSSemanticGroupRef'
name:
$ref: '#/components/schemas/WSLocalizedString'
terms:
type: array
xml:
wrapped: true
items:
xml:
name: term
$ref: '#/components/schemas/WSLocalizedText'
idf:
type: number
format: double
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: concept
WSConceptListResult:
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/WSConcept'
xml:
name: result
WSConceptRef:
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/WSConceptRef'
WSSemanticGroupRef:
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/WSSemanticGroupRef'
WSThesauriRef:
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/WSThesauriRef'
WSConceptsQuery:
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
xml:
name: conceptsQuery
WSFingerprintsQuery:
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
contentIds:
type: array
xml:
wrapped: true
items:
type: integer
format: int64
xml:
name: contentId
contentFamily:
type: string
xml:
name: fingerprintsQuery
WSSemanticGroup:
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'
thesauri:
$ref: '#/components/schemas/WSThesauriRef'
semanticGroupId:
type: string
name:
$ref: '#/components/schemas/WSLocalizedString'
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: semanticGroup
WSSemanticGroupListResult:
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/WSSemanticGroup'
xml:
name: result
WSSemanticGroupsQuery:
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
xml:
name: semanticGroupsQuery
WSThesauri:
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'
acronym:
type: string
workflow:
type: string
name:
$ref: '#/components/schemas/WSLocalizedString'
thesaurusVersion:
type: string
description:
$ref: '#/components/schemas/WSLocalizedString'
info:
$ref: '#/components/schemas/WSContentInformation'
xml:
name: thesauri
WSThesauriListResult:
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/WSThesauri'
xml:
name: result
WSThesauriQuery:
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
xml:
name: thesauriQuery
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
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
WSJournalListResult:
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/WSJournal'
xml:
name: result
WSJournalsQuery:
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
titles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: title
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
issns:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: issn
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
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
searchString:
type: string
xml:
name: journalsQuery
WSKeywordGroupConfiguration:
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'
targetFamily:
type: string
name:
$ref: '#/components/schemas/WSLocalizedString'
description:
$ref: '#/components/schemas/WSLocalizedString'
classificationScheme:
$ref: '#/components/schemas/WSClassificationSchemeRef'
allowUserdefinedKeywords:
type: boolean
modifyingRoles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: modifyingRole
weight:
type: integer
format: int32
userdefinedKeywordEditMode:
type: string
enum:
- SUBMISSION_LOCALE
- ALL_SUPPORTED_SUBMISSION_LOCALES
- ALL_SUPPORTED_LOCALES
limitToLeafSelection:
type: boolean
logicalName:
type: string
tags:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: tag
relationType:
type: string
relationName:
type: string
info:
$ref: '#/components/schemas/WSContentInformation'
propagationConfigurations:
type: array
xml:
name: keywordPropagationConfigurations
wrapped: true
items:
xml:
name: keywordPropagationConfiguration
$ref: '#/components/schemas/WSKeywordPropagationConfiguration'
xml:
name: keywordGroupConfiguration
WSKeywordGroupConfigurationRef:
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/WSKeywordGroupConfiguration'
WSKeywordPropagationConfiguration:
type: object
properties:
keywordPropagationHandlerId:
type: string
propagationSourceConfiguration:
$ref: '#/components/schemas/WSKeywordGroupConfigurationRef'
WSKeywordGroupConfigurationListResult:
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/WSKeywordGroupConfiguration'
xml:
name: result
WSKeywordGroupConfigurationQuery:
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
xml:
name: keywordGroupConfigurationQuery
WSOrganisationListResult:
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/WSOrganisation'
xml:
name: result
WSOrganisationsQuery:
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
searchString:
type: string
xml:
name: organisationalUnitsQuery
WSPersonListResult:
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/WSPerson'
xml:
name: result
WSUPMProjectListResult:
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/WSUPMProject'
xml:
name: result
WSAwardListResult:
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/WSAward'
xml:
name: result
WSApplicationListResult:
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/WSApplication'
xml:
name: result
WSPressMediaListResult:
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/WSPressMedia'
xml:
name: result
WSResearchOutputListResult:
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/WSResearchOutput'
xml:
name: result
WSEthicalReviewListResult:
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/WSEthicalReview'
xml:
name: result
WSStudentThesisListResult:
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/WSStudentThesis'
xml:
name: result
WSPrizeListResult:
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/WSPrize'
xml:
name: result
WSPersonsQuery:
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
searchString:
type: string
xml:
name: personsQuery
WSPressMediaQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
period:
$ref: '#/components/schemas/WSCompoundDateRange'
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
managingOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
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: pressMediaQuery
WSPrizesQuery:
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
degreeOfRecognitionUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: degreeOfRecognitionUri
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: prizesQuery
WSPublishersListResult:
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/WSPublisher'
xml:
name: result
WSPublishersQuery:
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
names:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: name
countryUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: countryUri
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
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
searchString:
type: string
xml:
name: publishersQuery
WSAuthorRolesList:
type: object
properties:
authorRoles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: authorRole
xml:
name: authorRoles
WSResearchOutputsQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
publicationStatuses:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: publicationStatus
publicationCategories:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: publicationCategory
peerReviews:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: peerReview
enum:
- PEER_REVIEW
- NOT_PEER_REVIEW
- NOT_SET
internationalPeerReviewed:
type: boolean
publishedBeforeDate:
type: string
format: date
publishedAfterDate:
type: string
format: date
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
forJournals:
$ref: '#/components/schemas/WSJournalNestedQuery'
forBookSeries:
$ref: '#/components/schemas/WSBookSeriesNestedQuery'
forPublishers:
$ref: '#/components/schemas/WSPublisherNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
authorRoles:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: authorRole
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
includedOnStaffPages:
type: boolean
searchString:
type: string
xml:
name: researchOutputsQuery
WSApplicationsQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
period:
$ref: '#/components/schemas/WSCompoundDateRange'
statusUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: statusUri
financial:
type: boolean
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
externalCollaborators:
$ref: '#/components/schemas/WSExternalOrganisationsNestedQuery'
internalCollaborators:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
managingOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
forProjects:
$ref: '#/components/schemas/WSUPMProjectsNestedQuery'
forAwards:
$ref: '#/components/schemas/WSAwardsNestedQuery'
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: applicationsQuery
WSAwardsNestedQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
period:
$ref: '#/components/schemas/WSCompoundDateRange'
financial:
type: boolean
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
funders:
$ref: '#/components/schemas/WSExternalOrganisationsNestedQuery'
externalCollaborators:
$ref: '#/components/schemas/WSExternalOrganisationsNestedQuery'
internalCollaborators:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
managingOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
forProjects:
$ref: '#/components/schemas/WSUPMProjectsNestedQuery'
xml:
name: awardsNestedQuery
WSExternalOrganisationsNestedQuery:
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
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: externalOrganisationsNestedQuery
WSUPMProjectsNestedQuery:
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
projectStatus:
type: string
enum:
- NOT_STARTED
- RUNNING
- FINISHED
- CURTAILED
period:
$ref: '#/components/schemas/WSCompoundDateRange'
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
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: projectsNestedQuery
WSAwardsQuery:
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
excludeByTypeUri:
type: boolean
typeUris:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: typeUri
period:
$ref: '#/components/schemas/WSCompoundDateRange'
financial:
type: boolean
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
funders:
$ref: '#/components/schemas/WSExternalOrganisationsNestedQuery'
externalCollaborators:
$ref: '#/components/schemas/WSExternalOrganisationsNestedQuery'
internalCollaborators:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
managingOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
forProjects:
$ref: '#/components/schemas/WSUPMProjectsNestedQuery'
searchString:
type: string
xml:
name: awardsQuery
WSAwardMilestoneListResult:
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/WSAwardMilestone'
xml:
name: result
WSUPMProjectsQuery:
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
projectStatus:
type: string
enum:
- NOT_STARTED
- RUNNING
- FINISHED
- CURTAILED
period:
$ref: '#/components/schemas/WSCompoundDateRange'
workflowSteps:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: workflowStep
forOrganisationalUnits:
$ref: '#/components/schemas/WSOrganisationsNestedQuery'
forPersons:
$ref: '#/components/schemas/WSPersonsNestedQuery'
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
searchString:
type: string
xml:
name: projectsQuery
securitySchemes:
apiKey:
type: apiKey
name: apiKey
in: query
api-key:
type: apiKey
name: api-key
in: header
security:
- apiKey: []
- api-key: []