Queen's University Belfast activity API
The activity API from Queen's University Belfast — 39 operation(s) for activity.
Queen’s University Belfast activity 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 activity. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 44 operations across 39 paths, and defines 59 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.
44 operations
39 paths
59 schemas
1 DELETE34 GET4 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Queen's University Belfast activity 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 44
Across 39 paths, the API surfaces 44 operations — 1 DELETE, 34 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
activity 44
GET
/activities
Lists all activities
PUT
/activities
Create activity
GET
/activities/allowed-attendance-person-roles
A list of allowed attendance activity person roles
GET
/activities/allowed-categories
A list of allowed categories
GET
/activities/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/activities/allowed-consultancy-person-roles
A list of allowed consultancy activity person roles
GET
/activities/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the activity
GET
/activities/allowed-degree-of-recognitions
A list of allowed degree of recognitions
GET
/activities/allowed-description-types
A list of allowed description types
GET
/activities/allowed-document-licenses
A list of allowed document licenses
GET
/activities/allowed-document-types
A list of allowed document types
GET
/activities/allowed-editorial-work-person-roles
A list of allowed editorial-work activity person roles
GET
/activities/allowed-examination-person-roles
A list of allowed examination activity person roles
GET
/activities/allowed-host-visitor-countries
A list of allowed host visitor countries
GET
/activities/allowed-host-visitor-person-roles
A list of allowed host-visitor activity person roles
GET
/activities/allowed-image-types
A list of allowed image types
GET
/activities/allowed-indicators
A list of allowed activity indicators
GET
/activities/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/activities/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/activities/allowed-link-types
A list of allowed link types
GET
/activities/allowed-locales
A list of allowed locales in localized strings
GET
/activities/allowed-membership-person-roles
A list of allowed membership activity person roles
GET
/activities/allowed-other-activity-person-roles
A list of allowed other activity person roles
GET
/activities/allowed-talk-person-roles
A list of allowed talk activity person roles
GET
/activities/allowed-types
A list of allowed activity types
GET
/activities/allowed-visit-other-person-roles
A list of allowed visit-other activity person roles
GET
/activities/allowed-workflow-steps
A list of allowed workflow steps in localized strings
GET
/activities/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/activities/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/activities/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with activities
PUT
/activities/file-uploads
Upload file to a specific activity
GET
/activities/orderings
Lists available orderings
POST
/activities/search
Query operation for activities
GET
/activities/{uuid}
Get activity
PUT
/activities/{uuid}
Update an activity
DELETE
/activities/{uuid}
Delete activity
POST
/activities/{uuid}/actions/lock
Lock the content
POST
/activities/{uuid}/actions/unlock
Unlock the content
GET
/activities/{uuid}/dependents
Lists all dependents to a activity
GET
/activities/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the activity
PUT
/activities/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the activity
GET
/activities/{uuid}/files/{fileId}
Get file from the activity
GET
/activities/{uuid}/notes
Lists notes
PUT
/activities/{uuid}/notes
Create note
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are Activity (39 properties), Document (17 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.
Activity
object
Activities exist in many variations.
39 properties
6 required
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
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
Document
object
Document
17 properties
4 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
ActivityProjectAssociation
object
An association with a project.
1 property
1 required
StudentThesisRef
object
A reference to student thesis
1 required
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
ActivityDatasetAssociation
object
An association with an dataset.
1 property
1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
Identifier
object
1 property
1 required
DataSetRef
object
A reference to a data set
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
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
EquipmentRef
object
A reference to a piece of equipment
1 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
Note
object
A note
3 properties
1 required
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties
1 required
ActivityListResult
object
List of activities. Can contain a subset of all items along with the full count
3 properties
ClassificationRef
object
A reference to a classification value
2 properties
1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ActivityPrizeAssociation
object
An association with a prize.
1 property
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ContentRefListResult
object
List of Content Refs
1 property
ProblemDetails
object
RFC7807 Error details
5 properties
ProjectRef
object
A reference to project
1 required
ContentRef
object
2 properties
2 required
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
ImpactRef
object
A reference to impact
1 required
ImageFile
object
An image file
15 properties
2 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
OrganizationRef
object
A reference to an organization in the institution
1 required
PageInformation
object
Information about pages
2 properties
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
ResearchOutputRef
object
A reference to a research output
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRefList
object
List of classification references
1 property
PrizeRef
object
A reference to a prize
1 required
PressMediaRef
object
A reference to a press/media
1 required
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
CompoundDateRange
object
A date range of that can be defined by only year, year and month or a full date
2 properties
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.
KeywordGroup
object
4 properties
2 required
LocalesList
object
List of available locales
1 property
AbstractActivityPersonAssociation
object
An association between an activity and a person, which can either be internal or external
5 properties
2 required
NoteListResult
object
List of notes
3 properties
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
Workflow
object
Information about workflow
2 properties
1 required
OrderingsList
object
List of available orderings
1 property
ActivityRef
object
A reference to an activity
1 required
ActivitiesQuery
object
Create a query for activities
6 properties
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 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
Queen's University Belfast equipment API
#activity