Queen's University Belfast ethicalReview API
The ethicalReview API from Queen's University Belfast — 22 operation(s) for ethicalreview.
Queen’s University Belfast ethicalReview API is one of 38 APIs that Queen’s University Belfast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ethicalReview. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 26 operations across 22 paths, and defines 48 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.
Requests are made against a single base URL, https://pure.qub.ac.uk/ws/api.
26 operations
22 paths
48 schemas
1 DELETE18 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Queen's University Belfast ethicalReview API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as api-key (api-key).
By default, every request must be authenticated.
api-key— Security mechanism for the API
Paths & Operations 26
Across 22 paths, the API surfaces 26 operations — 1 DELETE, 18 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
ethicalReview 26
GET
/ethical-reviews
Lists all ethicalReviews
PUT
/ethical-reviews
Create ethicalReview
GET
/ethical-reviews/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/ethical-reviews/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the project
GET
/ethical-reviews/allowed-description-types
A list of allowed description types
GET
/ethical-reviews/allowed-document-types
A list of allowed document types
GET
/ethical-reviews/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/ethical-reviews/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/ethical-reviews/allowed-link-types
A list of allowed link types
GET
/ethical-reviews/allowed-locales
A list of allowed locales in localized strings
GET
/ethical-reviews/allowed-persons-roles
A list of allowed person roles
GET
/ethical-reviews/allowed-types
A list of allowed ethical review types
GET
/ethical-reviews/allowed-workflow-steps
A list of allowed workflow steps
PUT
/ethical-reviews/file-uploads
Upload file for a specific ethicalReview
GET
/ethical-reviews/orderings
Lists available orderings
POST
/ethical-reviews/search
Query operation for ethicalReviews
GET
/ethical-reviews/{uuid}
Get ethicalReview
PUT
/ethical-reviews/{uuid}
Update ethicalReview
DELETE
/ethical-reviews/{uuid}
Delete ethicalReview
POST
/ethical-reviews/{uuid}/actions/lock
Lock the content
POST
/ethical-reviews/{uuid}/actions/unlock
Unlock the content
GET
/ethical-reviews/{uuid}/dependents
Lists all dependents to an ethical review
GET
/ethical-reviews/{uuid}/files/{fileId}
Get file from the ethicalReview
GET
/ethical-reviews/{uuid}/milestones
List milestones on an ethical review
GET
/ethical-reviews/{uuid}/notes
Lists notes
PUT
/ethical-reviews/{uuid}/notes
Create note
Schemas 48
The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are Milestone (30 properties), EthicalReview (28 properties), MilestoneDocument (15 properties), EthicalReviewDocument (15 properties). Each schema is shown below with its type and property counts.
EthicalReview
object
An ethical review
28 properties
6 required
EthicalReviewQuery
object
Create a query for ethical review
6 properties
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
UploadedFile
object
Information about the uploaded file
7 properties
1 required
EthicalReviewAwardAssociation
object
An association with an award
1 property
1 required
UserRef
object
A reference to an user
1 required
EthicalReviewListResult
object
List of ethical reviews. Can contain a subset of all items along with the full count
3 properties
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
Identifier
object
1 property
1 required
Visibility
object
Visibility of an object
2 properties
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
Note
object
A note
3 properties
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ClassificationRef
object
A reference to a classification value
2 properties
1 required
MilestoneListResult
object
List of milestones. Can contain a subset of all items along with the full count
3 properties
ProjectRef
object
A reference to project
1 required
ContentRefListResult
object
List of Content Refs
1 property
ApplicationRef
object
A reference to an application
1 required
ContentRef
object
2 properties
2 required
ProblemDetails
object
RFC7807 Error details
5 properties
EthicalReviewApplicationAssociation
object
An association with an application
1 property
1 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
PageInformation
object
Information about pages
2 properties
AwardRef
object
A reference to an award
1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
OrganizationRef
object
A reference to an organization in the institution
1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRefList
object
List of classification references
1 property
MilestoneReminder
object
A milestone reminder.
3 properties
2 required
MilestoneDocument
object
A milestone document
15 properties
4 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
ContractRef
object
A reference to a contract
1 required
WorkflowListResult
object
List of workflow steps.
1 property
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
AbstractClassifiedEthicalReviewPersonAssociation
object
5 properties
2 required
KeywordGroup
object
4 properties
2 required
LocalesList
object
List of available locales
1 property
NoteListResult
object
List of notes
3 properties
Workflow
object
Information about workflow
2 properties
1 required
OrderingsList
object
List of available orderings
1 property
ClassifiedLocalizedValue
object
A classified localized value
3 properties
1 required
EthicalReviewDocument
object
An ethical review document.
15 properties
4 required
Milestone
object
A milestone.
30 properties
2 required
EthicalReviewRef
object
A reference to an ethical review
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Queen's University Belfast 12
Other APIs Queen's University Belfast publishes across the network.
Queen's University Belfast Research Portal (Pure OAI-PMH)
Queen's University Belfast activity API
Queen's University Belfast application API
Queen's University Belfast authorCollaboration API
Queen's University Belfast award API
Queen's University Belfast classificationScheme API
Queen's University Belfast concept API
Queen's University Belfast conferenceSeries API
Queen's University Belfast contract API
Queen's University Belfast course API
Queen's University Belfast dataSet API
Queen's University Belfast education API
#ethicalReview