Yonsei University fundingOpportunity API
The fundingOpportunity API from Yonsei University — 21 operation(s) for fundingopportunity.
The fundingOpportunity API from Yonsei University — 21 operation(s) for fundingopportunity.
openapi: 3.0.1
info:
title: Pure activity fundingOpportunity API
description: The Pure API provides a secure and complete web services API for using and managing research information data in Pure. The API enables a broad range of use-cases for interacting with research information, from anonymous Open Data scenarios to enabling the next generation Pure admin.
termsOfService: ''
contact:
name: ''
url: ''
email: pure-support@elsevier.com
license:
name: ''
url: ''
version: 5.35.3-4
servers:
- url: https://yonsei.elsevierpure.com/ws/api
description: Yonsei University Elsevier Pure REST API
security:
- api-key: []
tags:
- name: fundingOpportunity
paths:
/funding-opportunities:
get:
tags:
- fundingOpportunity
summary: Lists all funding opportunities
description: Lists all funding opportunities in the Pure instance. If you need to filter the funding opportunities returned, see the POST version which supports additional filtering.
operationId: fundingOpportunity_list
parameters:
- name: size
in: query
description: Number of returned funding opportunities per request.
schema:
maximum: 1000
type: integer
format: int32
default: 10
- name: offset
in: query
description: The offset for the returned list. 0 or null value is from the start
schema:
type: integer
format: int32
default: 0
- name: order
in: query
description: The order of the list, must be a value from /fundingOpportunities/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunityListResult'
put:
tags:
- fundingOpportunity
summary: Create funding opportunity
description: Create funding opportunity
operationId: fundingOpportunity_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunity'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunity'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/funding-opportunities/allowed-classified-academic-degree-eligibility-types:
get:
tags:
- fundingOpportunity
summary: A list of allowed classified identifier types
description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of funding opportunity
operationId: fundingOpportunity_getAllowedAcademicDegreeEligibilityTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/allowed-classified-eligibility-types:
get:
tags:
- fundingOpportunity
summary: A list of allowed classified identifier types
description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of funding opportunity
operationId: fundingOpportunity_getAllowedEligibilityTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/allowed-custom-defined-field-values/{propertyName}/classifications:
get:
tags:
- fundingOpportunity
summary: Get allowed classifications for the custom-defined field associated with the funding opportunity
description: Get allowed classifications for the custom-defined field associated with the funding opportunity.
operationId: fundingOpportunity_getAllowedCustomDefinedFieldClassifications
parameters:
- name: propertyName
in: path
description: PropertyName for the desired custom-defined field
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/funding-opportunities/allowed-document-licenses:
get:
tags:
- fundingOpportunity
summary: A list of allowed document licenses
description: Get a list of allowed document licenses for funding opportunity
operationId: fundingOpportunity_getAllowedDocumentLicenses
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/allowed-document-types:
get:
tags:
- fundingOpportunity
summary: A list of allowed document types
description: Get a list of allowed license types that can be used for the 'documents.type' attribute of funding opportunity
operationId: fundingOpportunity_getAllowedDocumentTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/allowed-document-version-types:
get:
tags:
- fundingOpportunity
summary: A list of allowed document version types
description: Get a list of allowed version types for documents on funding opportunity
operationId: fundingOpportunity_getAllowedDocumentVersionTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/allowed-keyword-group-configurations:
get:
tags:
- fundingOpportunity
summary: A list of keyword group configurations
description: Get a list of allowed keyword group configurations that can be used when submitting keyword groups.
operationId: fundingOpportunity_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/funding-opportunities/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- fundingOpportunity
summary: A list of allowed classifications for the specified keyword group
description: Get a list of allowed classifications that can be used when submitting a specified keyword group.
operationId: fundingOpportunity_getAllowedKeywordGroupConfigurationClassifications
parameters:
- name: id
in: path
description: Pure id of the keyword group configuration
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/allowed-locales:
get:
tags:
- fundingOpportunity
summary: A list of allowed locales in localized strings
description: Get a list of allowed locales that can be used when submitting localized string entities.
operationId: fundingOpportunity_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/funding-opportunities/allowed-nature-types:
get:
tags:
- fundingOpportunity
summary: A list of allowed classified identifier types
description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of funding opportunity
operationId: fundingOpportunity_getAllowedNatureTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/allowed-types:
get:
tags:
- fundingOpportunity
summary: A list of allowed classifications for the type property
description: Get a list of classifications that can be used when submitting a type.
operationId: fundingOpportunity_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/funding-opportunities/file-uploads:
put:
tags:
- fundingOpportunity
summary: Upload file to a specific funding opportunity
description: Uploads file for the funding opportunity
operationId: fundingOpportunity_fileUploads
parameters:
- name: Content-Type
in: header
description: Set the mime type for the file
schema:
type: string
requestBody:
content:
'*/*':
schema:
type: string
format: binary
required: true
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/UploadedFile'
application/xml:
schema:
$ref: '#/components/schemas/UploadedFile'
/funding-opportunities/orderings:
get:
tags:
- fundingOpportunity
summary: Lists available orderings
description: Lists all orderings available to the funding opportunities endpoint. These values can be used by the order parameter when listing funding opportunities.
operationId: fundingOpportunity_getOrderings
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OrderingsList'
/funding-opportunities/search:
post:
tags:
- fundingOpportunity
summary: Query operation for funding opportunities
description: Lists funding opportunities in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options.
operationId: fundingOpportunity_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunitiesQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunityListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/funding-opportunities/{uuid}:
get:
tags:
- fundingOpportunity
summary: Get funding opportunity
description: Get funding opportunity with specific UUID.
operationId: fundingOpportunity_get
parameters:
- name: uuid
in: path
description: UUID of the desired funding opportunity
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunity'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- fundingOpportunity
summary: Update funding opportunity
description: Update funding opportunity with specific UUID.
operationId: fundingOpportunity_update
parameters:
- name: uuid
in: path
description: UUID of the funding opportunity to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunity'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FundingOpportunity'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Version conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
delete:
tags:
- fundingOpportunity
summary: Delete funding opportunity
description: Delete funding opportunity with specific UUID.
operationId: fundingOpportunity_delete
parameters:
- name: uuid
in: path
description: UUID of the funding opportunity
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'204':
description: Successful operation
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/funding-opportunities/{uuid}/actions/lock:
post:
tags:
- fundingOpportunity
summary: Lock the content
description: Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API.
operationId: fundingOpportunity_lock
parameters:
- name: uuid
in: path
description: UUID of the content to lock
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'204':
description: Content marked as locked
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Content already locked
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/funding-opportunities/{uuid}/actions/unlock:
post:
tags:
- fundingOpportunity
summary: Unlock the content
description: Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API.
operationId: fundingOpportunity_unlock
parameters:
- name: uuid
in: path
description: UUID of the content to unlock
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'204':
description: Content marked as unlocked
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Content already unlocked
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/funding-opportunities/{uuid}/dependents:
get:
tags:
- fundingOpportunity
summary: Lists all dependents to a funding opportunity
description: 'Lists all dependents to a funding opportunity with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: fundingOpportunity_dependents
parameters:
- name: uuid
in: path
description: UUID of the funding opportunity
required: true
schema:
pattern: .+
type: string
format: uuid
- name: verbose
in: query
description: DEPRECATED - Parameter has no effect.
deprecated: true
schema:
type: boolean
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ContentRefListResult'
/funding-opportunities/{uuid}/files/{fileId}:
get:
tags:
- fundingOpportunity
summary: Get file from the funding opportunity
description: Get file from the funding opportunity
operationId: fundingOpportunity_getFile
parameters:
- name: uuid
in: path
description: UUID of the funding opportunity
required: true
schema:
pattern: .+
type: string
format: uuid
- name: fileId
in: path
description: 'File id '
required: true
schema:
pattern: .+
type: string
responses:
'200':
description: Successful operation
content:
'*/*':
schema:
type: string
format: binary
/funding-opportunities/{uuid}/notes:
get:
tags:
- fundingOpportunity
summary: Lists notes
description: Lists notes associated with a funding opportunity ordered by date (nulls last)
operationId: fundingOpportunity_listNotes
parameters:
- name: uuid
in: path
description: UUID of the funding opportunity to get notes for
required: true
schema:
pattern: .+
type: string
format: uuid
- name: size
in: query
description: Number of returned notes per request
schema:
maximum: 1000
type: integer
format: int32
default: 10
- name: offset
in: query
description: The offset for the returned list. 0 or null value is from the start
schema:
type: integer
format: int32
default: 0
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/NoteListResult'
'404':
description: funding opportunity not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- fundingOpportunity
summary: Create note
description: Create note and associate it with a funding opportunity
operationId: fundingOpportunity_createNote
parameters:
- name: uuid
in: path
description: UUID of the funding opportunity to add note to
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The note to create
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
components:
schemas:
Visibility:
required:
- key
type: object
properties:
key:
type: string
description: Visibility value
enum:
- FREE
- CAMPUS
- BACKEND
- CONFIDENTIAL
description:
$ref: '#/components/schemas/SystemLocalizedString'
description: Visibility of an object
ContentRef:
required:
- systemName
- uuid
type: object
properties:
uuid:
type: string
description: UUID of the referred content
format: uuid
systemName:
type: string
nullable: true
discriminator:
propertyName: systemName
mapping:
AccessDefinition: '#/components/schemas/AccessDefinitionRef'
Activity: '#/components/schemas/ActivityRef'
Application: '#/components/schemas/ApplicationRef'
AuthorCollaboration: '#/components/schemas/AuthorCollaborationRef'
Award: '#/components/schemas/AwardRef'
ClassificationScheme: '#/components/schemas/ClassificationSchemeRef'
ConferenceSeries: '#/components/schemas/ConferenceSeriesRef'
DataSet: '#/components/schemas/DataSetRef'
Equipment: '#/components/schemas/EquipmentRef'
Event: '#/components/schemas/EventRef'
ExternalOrganization: '#/components/schemas/ExternalOrganizationRef'
ExternalPerson: '#/components/schemas/ExternalPersonRef'
Impact: '#/components/schemas/ImpactRef'
Journal: '#/components/schemas/JournalRef'
Organization: '#/components/schemas/OrganizationRef'
Person: '#/components/schemas/PersonRef'
Publisher: '#/components/schemas/PublisherRef'
PressMedia: '#/components/schemas/PressMediaRef'
Prize: '#/components/schemas/PrizeRef'
Project: '#/components/schemas/ProjectRef'
ResearchOutput: '#/components/schemas/ResearchOutputRef'
StudentThesis: '#/components/schemas/StudentThesisRef'
FundingOpportunity: '#/components/schemas/FundingOpportunityRef'
EthicalReview: '#/components/schemas/EthicalReviewRef'
ApplicationCluster: '#/components/schemas/ApplicationClusterRef'
AwardCluster: '#/components/schemas/AwardClusterRef'
User: '#/components/schemas/UserRef'
ERA2018FieldOfResearch: '#/components/schemas/Anzsrc2008FieldOfResearchRef'
UnitOfAssessmentREF2014: '#/components/schemas/Ref2014UnitOfAssessmentRef'
UnitOfAssessmentREF2020: '#/components/schemas/Ref2020UnitOfAssessmentRef'
ANZSRCTypeOfActivity: '#/components/schemas/Anzsrc2020TypeOfActivityRef'
ANZSRCFieldOfResearch: '#/components/schemas/Anzsrc2020FieldOfResearchRef'
ANZSRCSocioEconomicObjective: '#/components/schemas/Anzsrc2020SocioEconomicObjectiveRef'
Semester: '#/components/schemas/SemesterRef'
Education: '#/components/schemas/EducationRef'
Course: '#/components/schemas/CourseRef'
CurriculumVitae: '#/components/schemas/CurriculumVitaeRef'
CustomDefinedFieldConfiguration: '#/components/schemas/CustomDefinedFieldConfigurationRef'
KeywordGroupConfiguration: '#/components/schemas/KeywordGroupConfigurationRef'
Review: '#/components/schemas/ReviewRef'
GenericContentRef: '#/components/schemas/GenericContentRef'
UserProfile: '#/components/schemas/UserProfileRef'
Thesaurus: '#/components/schemas/ThesaurusRef'
Concept: '#/components/schemas/ConceptRef'
PersonExpertise: '#/components/schemas/PersonExpertiseRef'
Contract: '#/components/schemas/ContractRef'
Milestone: '#/components/schemas/MilestoneRef'
Fingerprint: '#/components/schemas/FingerprintRef'
Specialization: '#/components/schemas/SpecializationRef'
StudentProject: '#/components/schemas/StudentProjectRef'
PageInformation:
type: object
properties:
offset:
type: integer
description: Offset that returned items start at
format: int32
size:
type: integer
description: The requested number of items. May be higher than the actual number of items in the result if there are fewer items in the store than requested
format: int32
description: Information about pages
FundingOpportunityAcademicDegreeEligibility:
required:
- eligibilityFulfilmentType
- eligibilityTypeClassification
type: object
properties:
pureId:
type: integer
description: Pure database ID of the object, prefer using the UUID if it is present on the entity
format: int64
readOnly: true
eligibilityTypeClassification:
$ref: '#/components/schemas/ClassificationRef'
eligibilityFulfilmentType:
type: string
description: The eligibility fulfilment type
enum:
- RECOMMENDATION
- REQUIREMENT
description: Academic degree eligibility of the funding opportunity
OrganizationRef:
required:
- uuid
type: object
description: A reference to an organization in the institution
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
FundingOpportunityDocument:
required:
- fileName
- mimeType
- type
- versionType
- visibility
type: object
properties:
pureId:
type: integer
description: Pure database ID of the object, prefer using the UUID if it is present on the entity
format: int64
readOnly: true
fileId:
type: string
description: The id of the file
readOnly: true
fileName:
type: string
description: The documents file name
mimeType:
type: string
description: The documents mime type
size:
type: integer
description: The documents size in bytes
format: int64
url:
type: string
description: Download url for the binary file
readOnly: true
fileStoreLocations:
type: object
additionalProperties:
type: string
description: Locations of the binary file in file stores.
readOnly: true
description: Locations of the binary file in file stores.
readOnly: true
uploadedFile:
$ref: '#/components/schemas/UploadedFile'
remoteFile:
$ref: '#/components/schemas/RemoteFile'
fileData:
type: string
description: Base64 encoded file data for new files. This property can be used instead of uploadedFile for small files
format: byte
writeOnly: true
title:
type: string
description: Document title
nullable: true
type:
$ref: '#/components/schemas/ClassificationRef'
license:
$ref: '#/components/schemas/ClassificationRef'
visibleOnPortalDate:
type: string
description: The date the document will be available on the portal
format: date
readOnly: true
visibility:
$ref: '#/components/schemas/Visibility'
creator:
type: string
description: The user that created the document
readOnly: true
created:
type: string
description: Create date for the document
format: date-time
readOnly: true
versionType:
$ref: '#/components/schemas/ClassificationRef'
description: Funding Opportunity document
ClassificationRef:
required:
- uri
type: object
properties:
uri:
type: string
description: Classification URI of the referred classification
term:
$ref: '#/components/schemas/SystemLocalizedString'
description: A reference to a classification value
nullable: true
UploadedFile:
required:
- key
type: object
properties:
digest:
type: string
description: The calculated digest for the file in Pure
readOnly: true
digestType:
type: string
description: The digest type
readOnly: true
size:
type: integer
description: The file size of the file in Pure
format: int64
readOnly: true
mimeType:
type: string
description: The mime type detected for the file
readOnly: true
timeStamp:
type: string
description: The timestamp Pure received the file
format: date-time
readOnly: true
expires:
type: string
description: The timestamp where Pure deletes the uploaded file if it has not been attached to any content
format: date-time
readOnly: true
key:
type: string
description: Pure key identifer for the file upload
readOnly: true
description: Information about the uploaded file
FormattedString:
required:
- value
type: object
properties:
value:
type: string
description: The actual formatted string
description: A string containing HTML formatted text
FundingOpportunitiesQuery:
type: object
properties:
uuids:
type: array
items:
type: string
format: uuid
size:
type: integer
format: int32
offset:
type: integer
format: int32
orderings:
type: array
items:
type: string
searchString:
type: string
description: String used to perform search
orderBy:
type: string
writeOnly: true
description: Create a query for funding opportunities
LocalizedString:
type: object
additionalProperties:
type: string
description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
nullable: true
example: '{"en_GB":"Some text"}'
description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
nullable: true
example:
en_GB: Some text
UserRef:
required:
- uuid
type: object
description: A reference to an user
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
AllowedKeywordGroupConfiguration:
required:
- targetSystemName
type: object
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-fundingopportunity-api-openapi.yml