Yonsei University ethicalReview API
The ethicalReview API from Yonsei University — 22 operation(s) for ethicalreview.
The ethicalReview API from Yonsei University — 22 operation(s) for ethicalreview.
openapi: 3.0.1
info:
title: Pure activity ethicalReview 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: ethicalReview
paths:
/ethical-reviews:
get:
tags:
- ethicalReview
summary: Lists all ethicalReviews
description: Lists all ethicalReviews in the Pure instance. If you need to filter the ethicalReviews returned, see the POST version which supports additional filtering.
operationId: ethicalReview_list
parameters:
- name: size
in: query
description: Number of returned ethicalReviews 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 /ethicalReviews/orderings
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReviewListResult'
put:
tags:
- ethicalReview
summary: Create ethicalReview
description: Create ethicalReview
operationId: ethicalReview_create
requestBody:
description: The content to create
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReview'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReview'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/ethical-reviews/allowed-classified-identifier-types:
get:
tags:
- ethicalReview
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 ethical reviews
operationId: ethicalReview_getAllowedClassifiedIdentifierTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/ethical-reviews/allowed-custom-defined-field-values/{propertyName}/classifications:
get:
tags:
- ethicalReview
summary: Get allowed classifications for the custom-defined field associated with the project
description: Get allowed classifications for the custom-defined field associated with the project.
operationId: ethicalReview_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'
/ethical-reviews/allowed-description-types:
get:
tags:
- ethicalReview
summary: A list of allowed description types
description: Get a list of allowed types for descriptions on ethical reviews
operationId: ethicalReview_getAllowedDescriptionTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/ethical-reviews/allowed-document-types:
get:
tags:
- ethicalReview
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 ethicalReviews
operationId: ethicalReview_getAllowedDocumentTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/ethical-reviews/allowed-keyword-group-configurations:
get:
tags:
- ethicalReview
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: ethicalReview_getAllowedKeywordGroupConfigurations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
/ethical-reviews/allowed-keyword-group-configurations/{id}/classifications:
get:
tags:
- ethicalReview
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: ethicalReview_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'
/ethical-reviews/allowed-link-types:
get:
tags:
- ethicalReview
summary: A list of allowed link types
description: Get a list of allowed link types on ethical reviews
operationId: ethicalReview_getAllowedLinkTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/ethical-reviews/allowed-locales:
get:
tags:
- ethicalReview
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: ethicalReview_getAllowedLocales
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LocalesList'
/ethical-reviews/allowed-persons-roles:
get:
tags:
- ethicalReview
summary: A list of allowed person roles
description: Get a list of allowed person roles that can be used for the 'persons.role' attribute of the ethical review.
operationId: ethicalReview_getAllowedPersonsRoles
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/ethical-reviews/allowed-types:
get:
tags:
- ethicalReview
summary: A list of allowed ethical review types
description: Get a list of allowed types that can be used for the 'type' attribute of ethical review
operationId: ethicalReview_getAllowedTypes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRefList'
/ethical-reviews/allowed-workflow-steps:
get:
tags:
- ethicalReview
summary: A list of allowed workflow steps
description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of ethicalReviews
operationId: ethicalReview_getAllowedWorkflowSteps
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResult'
/ethical-reviews/file-uploads:
put:
tags:
- ethicalReview
summary: Upload file for a specific ethicalReview
description: Uploads file for the ethicalReview
operationId: ethicalReview_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'
/ethical-reviews/orderings:
get:
tags:
- ethicalReview
summary: Lists available orderings
description: Lists all orderings available to the ethicalReviews endpoint. These values can be used by the order parameter when listing ethicalReviews.
operationId: ethicalReview_getOrderings
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OrderingsList'
/ethical-reviews/search:
post:
tags:
- ethicalReview
summary: Query operation for ethicalReviews
description: Lists ethicalReviews 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: ethicalReview_query
requestBody:
description: The query to perform
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReviewQuery'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReviewListResult'
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/ethical-reviews/{uuid}:
get:
tags:
- ethicalReview
summary: Get ethicalReview
description: Get ethicalReview with specific UUID.
operationId: ethicalReview_get
parameters:
- name: uuid
in: path
description: UUID of the desired ethicalReview
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReview'
'301':
description: The requested content have changed UUID
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- ethicalReview
summary: Update ethicalReview
description: Update ethicalReview with specific UUID.
operationId: ethicalReview_update
parameters:
- name: uuid
in: path
description: UUID of the ethicalReview to update
required: true
schema:
pattern: .+
type: string
format: uuid
requestBody:
description: The content to update
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReview'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/EthicalReview'
'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:
- ethicalReview
summary: Delete ethicalReview
description: Delete ethicalReview with specific UUID.
operationId: ethicalReview_delete
parameters:
- name: uuid
in: path
description: UUID of the ethicalReview
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'
/ethical-reviews/{uuid}/actions/lock:
post:
tags:
- ethicalReview
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: ethicalReview_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'
/ethical-reviews/{uuid}/actions/unlock:
post:
tags:
- ethicalReview
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: ethicalReview_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'
/ethical-reviews/{uuid}/dependents:
get:
tags:
- ethicalReview
summary: Lists all dependents to an ethical review
description: 'Lists all dependents to an ethical review with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
operationId: ethicalReview_dependents
parameters:
- name: uuid
in: path
description: UUID of the ethical review
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'
/ethical-reviews/{uuid}/files/{fileId}:
get:
tags:
- ethicalReview
summary: Get file from the ethicalReview
description: Get file from the ethicalReview
operationId: ethicalReview_getFile
parameters:
- name: uuid
in: path
description: UUID of the ethicalReview
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
/ethical-reviews/{uuid}/milestones:
get:
tags:
- ethicalReview
summary: List milestones on an ethical review
description: List milestones on an ethical review.
operationId: ethicalReview_getMilestones
parameters:
- name: uuid
in: path
description: UUID of the ethical review
required: true
schema:
pattern: .+
type: string
format: uuid
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/MilestoneListResult'
'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'
/ethical-reviews/{uuid}/notes:
get:
tags:
- ethicalReview
summary: Lists notes
description: Lists notes associated with an ethicalReview ordered by date (nulls last)
operationId: ethicalReview_listNotes
parameters:
- name: uuid
in: path
description: UUID of the ethicalReview 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: ethicalReview not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
put:
tags:
- ethicalReview
summary: Create note
description: Create note and associate it with the ethicalReview
operationId: ethicalReview_createNote
parameters:
- name: uuid
in: path
description: UUID of the ethicalReview 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
EthicalReviewAwardAssociation:
required:
- award
type: object
properties:
award:
$ref: '#/components/schemas/AwardRef'
description: An association with an award
ContractRef:
required:
- uuid
type: object
description: A reference to a contract
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
OrganizationRef:
required:
- uuid
type: object
description: A reference to an organization in the institution
nullable: true
allOf:
- $ref: '#/components/schemas/ContentRef'
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
MilestoneDocument:
required:
- fileName
- mimeType
- type
- 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'
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
description: A milestone document
Link:
required:
- url
type: object
properties:
pureId:
type: integer
description: Pure database ID of the object, prefer using the UUID if it is present on the entity
format: int64
readOnly: true
url:
type: string
description: The URL (Uniform Resource Locator) of the link
alias:
type: string
description: A user-friendly text to show instead of the URL
nullable: true
description:
$ref: '#/components/schemas/LocalizedString'
linkType:
$ref: '#/components/schemas/ClassificationRef'
description: A hyperlink describing a location on the web.
EthicalReview:
required:
- managingOrganization
- organizations
- persons
- title
- type
- 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
uuid:
type: string
description: UUID, this is the primary identity of the entity
format: uuid
readOnly: true
createdBy:
type: string
description: Username of creator
readOnly: true
createdDate:
type: string
description: Date and time of creation
format: date-time
readOnly: true
modifiedBy:
type: string
description: Username of the user that performed a modification
readOnly: true
modifiedDate:
type: string
description: Date and time of last modification
format: date-time
readOnly: true
portalUrl:
type: string
description: URL of the content on the Pure Portal
readOnly: true
prettyUrlIdentifiers:
type: array
description: All pretty URLs
readOnly: true
items:
type: string
description: All pretty URLs
readOnly: true
previousUuids:
type: array
description: UUIDs of other content items which have been merged into this content item (or similar)
readOnly: true
items:
type: string
description: UUIDs of other content items which have been merged into this content item (or similar)
readOnly: true
version:
type: string
description: Used to guard against conflicting updates. For new content this is null, and for existing content the current value. The property should never be modified by a client, except in the rare case where the client wants to perform an update irrespective of if other clients have made updates in the meantime, also known as a "dirty write". A dirty write is performed by not including the property value
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yonsei/refs/heads/main/openapi/yonsei-ethicalreview-api-openapi.yml