Yonsei University impact API
The impact API from Yonsei University — 31 operation(s) for impact.
The impact API from Yonsei University — 31 operation(s) for impact.
openapi: 3.0.1
info:
title: Pure activity impact 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: impact
paths:
/impacts:
get:
tags:
- impact
summary: Lists all impacts
description: Lists all impacts in the Pure instance. If you need to filter the impact returned, see the POST version which supports additional filtering.
operationId: impact_list
parameters:
- name: size
in: query
description: Number of returned impact 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 /impacts/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ImpactListResult'
put:
tags:
- impact
summary: Create impact
description: Create impact
operationId: impact_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/Impact'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Impact'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Version conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictProblemDetails'
/impacts/allowed-classified-identifier-types:
get:
tags:
- impact
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 impact
operationId: impact_getAllowedClassifiedIdentifierTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-custom-defined-field-values/{propertyName}/classifications:
get:
tags:
- impact
summary: Get allowed classifications for the custom-defined field associated with the impact
description: Get allowed classifications for the custom-defined field associated with the impact.
operationId: impact_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'
/impacts/allowed-description-types:
get:
tags:
- impact
summary: A list of allowed classifications for the descriptions property
description: Get a list of classifications that can be used when submitting a description.
operationId: impact_getAllowedDescriptionTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-document-licenses:
get:
tags:
- impact
summary: A list of allowed document licenses
description: Get a list of allowed license types that can be used for the 'documents.license' attribute of impacts
operationId: impact_getAllowedDocumentLicenses
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-document-types:
get:
tags:
- impact
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 impacts
operationId: impact_getAllowedDocumentTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-image-types:
get:
tags:
- impact
summary: A list of allowed image types
description: Get a list of allowed image types that can be used for the 'images.type' attribute of impact
operationId: impact_getAllowedImageTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-impact-categories:
get:
tags:
- impact
summary: A list of allowed impact categories
description: Get a list of allowed categories for impacts
operationId: impact_getAllowedImpactCategories
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-impact-evidence-indicators:
get:
tags:
- impact
summary: A list of allowed impact evidence indicators
description: Get a list of allowed indicators for impact evidence
operationId: impact_getAllowedImpactEvidenceIndicators
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-impact-levels:
get:
tags:
- impact
summary: A list of allowed impact levels
description: Get a list of levels for impact
operationId: impact_getAllowedImpactLevels
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-impact-status:
get:
tags:
- impact
summary: A list of allowed impact types
description: Get a list of allowed types that can be used for the 'type' attribute of impact
operationId: impact_getAllowedImpactStatus
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-keyword-group-configurations:
get:
tags:
- impact
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: impact_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/impacts/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- impact
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: impact_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'
/impacts/allowed-link-types:
get:
tags:
- impact
summary: A list of allowed link types
description: Get a list of allowed link types that can be used for the 'links.linkType' attribute of impacts
operationId: impact_getAllowedLinkTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-locales:
get:
tags:
- impact
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: impact_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/impacts/allowed-persons-countries:
get:
tags:
- impact
summary: A list of allowed impact persons countries
description: Get a list of countries for impact persons
operationId: impact_getAllowedPersonsCountries
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-persons-roles:
get:
tags:
- impact
summary: A list of allowed persons roles
description: Get a list of allowed persons roles
operationId: impact_getAllowedPersonsRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-types:
get:
tags:
- impact
summary: A list of allowed impact types
description: Get a list of allowed types that can be used for the 'type' attribute of impact
operationId: impact_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/impacts/allowed-workflow-steps:
get:
tags:
- impact
summary: A list of allowed workflow steps in localized strings
description: Get a list of allowed workflow steps.
operationId: impact_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/impacts/disciplines/allowed-discipline-schemes:
get:
tags:
- impact
summary: A list of allowed discipline schemes
description: Get a list fo a allowed discipline schemes for impacts
operationId: impact_getAllowedDisciplineSchemes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
/impacts/disciplines/{discipline-scheme}/allowed-disciplines:
get:
tags:
- impact
summary: A list of allowed disciplines for a specific discipline scheme
description: Get a list of a allowed disciplines for specific discipline scheme for impacts
operationId: impact_getAllowedDisciplines
parameters:
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme for impacts
required: true
schema:
type: string
- name: size
in: query
description: Number of returned disciplines per request
schema:
maximum: 1000
type: integer
format: int32
default: 10
- name: offset
in: query
description: The offset for the returned list. 0 or null value is from the start
schema:
type: integer
format: int32
default: 0
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesDisciplineListResult'
/impacts/disciplines/{discipline-scheme}/search:
post:
tags:
- impact
summary: Query operation for disciplines associated with impacts
description: Lists disciplines from the discipline scheme associated with impacts in the Pure instance that matches the provided query.
operationId: impact_listDisciplineAssociations
parameters:
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociationsQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociationListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/impacts/file-uploads:
put:
tags:
- impact
summary: Upload file to a specific impact
description: Uploads file for the impact
operationId: impact_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'
/impacts/search:
post:
tags:
- impact
summary: Query operation for impact
description: Lists impact 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: impact_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/ImpactQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ImpactListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/impacts/{uuid}:
get:
tags:
- impact
summary: Get impact
description: Get impact with specific UUID.
operationId: impact_get
parameters:
- name: uuid
in: path
description: UUID of the desired impact
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Impact'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- impact
summary: Update impact
description: Update impact with specific UUID.
operationId: impact_update
parameters:
- name: uuid
in: path
description: UUID of the impact to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/Impact'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Impact'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
delete:
tags:
- impact
summary: Delete impact
description: Delete impact with specific UUID.
operationId: impact_delete
parameters:
- name: uuid
in: path
description: UUID of the impact
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'
/impacts/{uuid}/actions/lock:
post:
tags:
- impact
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: impact_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'
/impacts/{uuid}/actions/unlock:
post:
tags:
- impact
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: impact_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'
/impacts/{uuid}/dependents:
get:
tags:
- impact
summary: Lists all dependents to an impact
description: 'Lists all dependents to an impact with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: impact_dependents
parameters:
- name: uuid
in: path
description: UUID of the impact
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'
/impacts/{uuid}/disciplines/{discipline-scheme}:
get:
tags:
- impact
summary: Get disciplines from the discipline scheme associated with the impact
description: Get disciplines from the discipline scheme associated with the impact with specific UUID.
operationId: impact_getDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the desired impact
required: true
schema:
pattern: .+
type: string
format: uuid
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- impact
summary: Update disciplines from the discipline scheme associated with the impact
description: Update disciplines from the discipline scheme associated with the impact with specific UUID.
operationId: impact_putDisciplineAssociation
parameters:
- name: uuid
in: path
description: UUID of the impact to update
required: true
schema:
pattern: .+
type: string
format: uuid
- name: discipline-scheme
in: path
description: Identifier for the discipline scheme
required: true
schema:
type: string
requestBody:
description: The disciplines association to create
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DisciplinesAssociation'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Resource not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/impacts/{uuid}/files/{fileId}:
get:
tags:
- impact
summary: Get file from the impact
description: Get file from the impact
operationId: impact_getFile
parameters:
- name: uuid
in: path
description: UUID of the impact
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
/impacts/{uuid}/notes:
get:
tags:
- impact
summary: Lists notes
description: Lists notes associated with an impact ordered by date (nulls last)
operationId: impact_listNotes
parameters:
- name: uuid
in: path
description: UUID of the impact to get notes for
required: true
schema:
pattern: .+
type: string
format: uuid
- name: size
in: query
description: Number of returned notes per request
schema:
maximum: 1000
type: integer
format: int32
default: 10
- name: offset
in: query
description: The offset for the returned list. 0 or null value is from the start
schema:
type: integer
format: int32
default: 0
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/NoteListResult'
'404':
description: Application not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- impact
summary: Create note
description: Create note and associate it with the impact
operationId: impact_createNote
parameters:
- name: uuid
in: path
description: UUID of the impact to add note to
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The note to create
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
components:
schemas:
DisciplinesAssociation:
required:
- disciplineAssignments
type: object
properties:
content:
$ref: '#/components/schemas/ContentRef'
disciplineScheme:
type: string
description: The discipline scheme these disciplines are assigned from
readOnly: true
disciplineAssignments:
type: array
description: A collection of assigned disciplines
items:
$ref: '#/components/schemas/DisciplinesDisciplineAssignment'
description: An association between a content and a number of discipline assignments
Visibility:
required:
- key
type: object
properties:
key:
type: string
description: Visibility value
enum:
- FREE
- CAMPUS
- BACKEND
- CONFIDENTIAL
description:
$ref: '#/components/schemas/SystemLocalizedString'
description: Visibility of an object
ImpactQuery:
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 impact
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/sc
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-impact-api-openapi.yml