Yonsei University studentThesis API
The studentThesis API from Yonsei University — 26 operation(s) for studentthesis.
The studentThesis API from Yonsei University — 26 operation(s) for studentthesis.
openapi: 3.0.1
info:
title: Pure activity studentThesis 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: studentThesis
paths:
/student-theses:
get:
tags:
- studentThesis
summary: Lists all student theses
description: Lists all student theses in the Pure instance. If you need to filter the student theses returned, see the POST version which supports additional filtering.
operationId: studentThesis_list
parameters:
- name: size
in: query
description: Number of returned student theses 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 /student-theses/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesisListResult'
put:
tags:
- studentThesis
summary: Create student thesis
description: Create student thesis
operationId: studentThesis_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesis'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesis'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/student-theses/allowed-contributor-countries:
get:
tags:
- studentThesis
summary: A list of allowed contributor countries for student theses
description: Get a list of allowed countries for contributors of student theses
operationId: studentthesis_getAllowedContributorCountries
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-contributor-roles:
get:
tags:
- studentThesis
summary: A list of allowed contributor roles for student theses
description: Get a list of allowed roles for contributors of student theses
operationId: studentthesis_getAllowedContributorRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-custom-defined-field-values/{fieldIdentifer}/classifications:
get:
tags:
- studentThesis
summary: Get allowed classifications for the custom-defined field associated with the student thesis
description: Get allowed classifications for the custom-defined field associated with the student theses.
operationId: studentThesis_getAllowedCustomDefinedFieldClassifications
parameters:
- name: fieldIdentifer
in: path
description: FieldIdentifer 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'
/student-theses/allowed-document-embargo-reasons:
get:
tags:
- studentThesis
summary: A list of allowed document embargo reasons
description: Get a list of allowed document embargo reasons that can be used for student theses
operationId: studentThesis_getAllowedDocumentEmbargoReasons
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-document-license-types:
get:
tags:
- studentThesis
summary: A list of allowed document license types
description: Get a list of allowed document license types that can be used for student these
operationId: studentThesis_getAllowedDocumentLicenses
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-document-types:
get:
tags:
- studentThesis
summary: A list of allowed document types
description: Get a list of allowed document types that can be used for student these
operationId: studentThesis_getAllowedDocumentTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-document-version-types:
get:
tags:
- studentThesis
summary: A list of allowed document version types
description: Get a list of allowed document version types that can be used for student these
operationId: studentThesis_getAllowedDocumentVersionTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-image-types:
get:
tags:
- studentThesis
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 student thesis
operationId: studentThesis_getAllowedImageTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-keyword-group-configurations:
get:
tags:
- studentThesis
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: studentThesis_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/student-theses/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- studentThesis
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: studentThesis_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'
/student-theses/allowed-languages:
get:
tags:
- studentThesis
summary: A list of allowed languages
description: Get a list of allowed languages on student theses
operationId: studentthesis_getAllowedLanguages
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-link-types:
get:
tags:
- studentThesis
summary: A list of allowed link types
description: Get a list of allowed link types on student theses
operationId: studentthesis_getAllowedLinkTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-locales:
get:
tags:
- studentThesis
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: studentThesis_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/student-theses/allowed-supervisor-roles:
get:
tags:
- studentThesis
summary: A list of allowed supervisor roles
description: Get a list of allowed supervisors roles for student theses
operationId: studentthesis_getAllowedSupervisorRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-types:
get:
tags:
- studentThesis
summary: A list of allowed student thesis types
description: Get a list of allowed types that can be used for the 'type' attribute of student theses
operationId: studentThesis_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/student-theses/allowed-workflow-steps:
get:
tags:
- studentThesis
summary: A list of allowed workflow steps
description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of student theses
operationId: studentThesis_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/student-theses/file-uploads:
put:
tags:
- studentThesis
summary: Upload file to a specific student thesis
description: Uploads file for the student thesis
operationId: studentThesis_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'
/student-theses/orderings:
get:
tags:
- studentThesis
summary: Lists available orderings
description: Lists all orderings available to the student thesis endpoint. These values can be used by the order parameter.
operationId: studentThesis_getOrderings
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OrderingsList'
/student-theses/search:
post:
tags:
- studentThesis
summary: Query operation for student theses
description: Lists student theses 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: studentThesis_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesesQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesisListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/student-theses/{uuid}:
get:
tags:
- studentThesis
summary: Get student thesis
description: Get student thesis with specific UUID.
operationId: studentThesis_get
parameters:
- name: uuid
in: path
description: UUID of the desired student thesis
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesis'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- studentThesis
summary: Update student thesis
description: Update student thesis with specific UUID.
operationId: studentThesis_update
parameters:
- name: uuid
in: path
description: UUID of the student thesis to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesis'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StudentThesis'
'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:
- studentThesis
summary: Delete student thesis
description: Delete student thesis with specific UUID.
operationId: studentThesis_delete
parameters:
- name: uuid
in: path
description: UUID of the student thesis
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'
/student-theses/{uuid}/actions/lock:
post:
tags:
- studentThesis
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: studentThesis_lock
parameters:
- name: uuid
in: path
description: UUID of the student thesis 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'
/student-theses/{uuid}/actions/unlock:
post:
tags:
- studentThesis
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: studentThesis_unlock
parameters:
- name: uuid
in: path
description: UUID of the student thesis 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'
/student-theses/{uuid}/dependents:
get:
tags:
- studentThesis
summary: Lists all dependents to a student thesis
description: 'Lists all dependents to a student thesis with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: studentThesis_dependents
parameters:
- name: uuid
in: path
description: UUID of the student thesis
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'
/student-theses/{uuid}/files/{fileId}:
get:
tags:
- studentThesis
summary: Get file from the student thesis
description: Get file from the student thesis
operationId: studentThesis_getFile
parameters:
- name: uuid
in: path
description: UUID of the student thesis
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
/student-theses/{uuid}/notes:
get:
tags:
- studentThesis
summary: Lists notes
description: Lists notes associated with a student thesis ordered by date (nulls last)
operationId: studentThesis_listNotes
parameters:
- name: uuid
in: path
description: UUID of the student thesis 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: student thesis not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- studentThesis
summary: Create note
description: Create note and associate it with a student thesis
operationId: studentThesis_createNote
parameters:
- name: uuid
in: path
description: UUID of the student thesis 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
AbstractStudentThesisContributorAssociation:
required:
- typeDiscriminator
type: object
properties:
pureId:
type: integer
description: Pure database ID of the object, prefer using the UUID if it is present on the entity
format: int64
readOnly: true
externalOrganizations:
type: array
description: A collection of external organization affiliations.
nullable: true
items:
$ref: '#/components/schemas/ExternalOrganizationRef'
typeDiscriminator:
type: string
description: An association between student thesis and a person that has contributed to it
discriminator:
propertyName: typeDiscriminator
mapping:
InternalContributorAssociation: '#/components/schemas/InternalStudentThesisContributorAssociation'
ExternalContributorAssociation: '#/components/schemas/ExternalStudentThesisContributorAssociation'
StudentThesisListResult:
type: object
properties:
count:
type: integer
description: The full count, ignoring paging
format: int32
pageInformation:
$ref: '#/components/schemas/PageInformation'
items:
type: array
description: StudentThesis
items:
$ref: '#/components/schemas/StudentThesis'
description: List of student theses. Can contain a subset of all items along with the full count
CompoundDate:
required:
- year
type: object
properties:
year:
maximum: 4000
minimum: 0
type: integer
format: int32
month:
maximum: 12
minimum: 1
type: integer
format: int32
nullable: true
day:
maximum: 31
minimum: 1
type: integer
format: int32
nullable: true
description: A date that can be defined by only year, year and month or a full date
nullable: true
OrganizationRef:
required:
- uuid
type: object
description: A reference to an organization in the institution
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
OrganizationOrExternalOrganizationRef:
type: object
properties:
organizationRef:
$ref: '#/components/schemas/OrganizationRef'
externalOrganizationRef:
$ref: '#/components/schemas/ExternalOrganizationRef'
description: A reference to an organization in the institution or an external organization
nullable: true
ProjectRef:
required:
- uuid
type: object
description: A reference to project
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
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
DataSetRef:
required:
- uuid
type: object
description: A reference to a data set
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
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
Link:
required:
- url
typ
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-studentthesis-api-openapi.yml