How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

University of Bath activity API

The activity API from University of Bath — 38 operation(s) for activity.

University of Bath activity API is one of 26 APIs that University of Bath 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.

This API exposes 43 operations across 38 paths, and defines 52 schemas. It is described by OpenAPI 3.0.1, at version 5.33.3-3.

Requests are made against a single base URL, /ws/api.

43 operations 38 paths 52 schemas 1 DELETE33 GET4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.33.3-3
Base URL
https://purehost.bath.ac.uk/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

University of Bath 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 43

Across 38 paths, the API surfaces 43 operations — 1 DELETE, 33 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

activity 43
GET
/activities
Lists all activities
activity_list 3 params → 200
PUT
/activities
Create activity
activity_create body → 201400
GET
/activities/allowed-attendance-person-roles
A list of allowed attendance activity person roles
activity_getAllowedAttendancePersonRoles → 200
GET
/activities/allowed-categories
A list of allowed categories
activity_getAllowedCategories → 200
GET
/activities/allowed-classified-identifier-types
A list of allowed classified identifier types
activity_getAllowedClassifiedIdentifierTypes → 200
GET
/activities/allowed-consultancy-person-roles
A list of allowed consultancy activity person roles
activity_getAllowedConsultancyPersonRoles → 200
GET
/activities/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the activity
activity_getAllowedCustomDefinedFieldClassifications 1 param → 200400404
GET
/activities/allowed-degree-of-recognitions
A list of allowed degree of recognitions
activity_getAllowedDegreeOfRecognitions → 200
GET
/activities/allowed-description-types
A list of allowed description types
activity_getAllowedDescriptionTypes → 200
GET
/activities/allowed-document-licenses
A list of allowed document licenses
activity_getAllowedDocumentLicenses → 200
GET
/activities/allowed-document-types
A list of allowed document types
activity_getAllowedDocumentTypes → 200
GET
/activities/allowed-editorial-work-person-roles
A list of allowed editorial-work activity person roles
activity_getAllowedEditorialWorkPersonRoles → 200
GET
/activities/allowed-examination-person-roles
A list of allowed examination activity person roles
activity_getAllowedExaminationPersonRoles → 200
GET
/activities/allowed-host-visitor-countries
A list of allowed host visitor countries
activity_getAllowedHostVisitorCountries → 200
GET
/activities/allowed-host-visitor-person-roles
A list of allowed host-visitor activity person roles
activity_getAllowedHostVisitorPersonRoles → 200
GET
/activities/allowed-image-types
A list of allowed image types
activity_getAllowedImageTypes → 200
GET
/activities/allowed-indicators
A list of allowed activity indicators
activity_getAllowedIndicators → 200
GET
/activities/allowed-keyword-group-configurations
A list of keyword group configurations
activity_getAllowedKeywordGroupConfigurations → 200
GET
/activities/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
activity_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/activities/allowed-link-types
A list of allowed link types
activity_getAllowedLinkTypes → 200
GET
/activities/allowed-locales
A list of allowed locales in localized strings
activity_getAllowedLocales → 200
GET
/activities/allowed-membership-person-roles
A list of allowed membership activity person roles
activity_getAllowedMembershipPersonRoles → 200
GET
/activities/allowed-other-activity-person-roles
A list of allowed other activity person roles
activity_getAllowedOtherActivityPersonRoles → 200
GET
/activities/allowed-talk-person-roles
A list of allowed talk activity person roles
activity_getAllowedTalkPersonRoles → 200
GET
/activities/allowed-types
A list of allowed activity types
activity_getAllowedTypes → 200
GET
/activities/allowed-visit-other-person-roles
A list of allowed visit-other activity person roles
activity_getAllowedVisitOtherPersonRoles → 200
GET
/activities/allowed-workflow-steps
A list of allowed workflow steps in localized strings
activity_getAllowedWorkflowSteps → 200
GET
/activities/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
activity_getAllowedDisciplineSchemes → 200
GET
/activities/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
activity_getAllowedDisciplines 3 params → 200
POST
/activities/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with activities
activity_listDisciplineAssociations 1 param body → 200400
PUT
/activities/file-uploads
Upload file to a specific activity
activity_fileUploads 1 param body → default
GET
/activities/orderings
Lists available orderings
activity_getOrderings → 200
POST
/activities/search
Query operation for activities
activity_query body → 200400
GET
/activities/{uuid}
Get activity
activity_get 1 param → 200301404
PUT
/activities/{uuid}
Update an activity
activity_update 1 param body → 200400404409
DELETE
/activities/{uuid}
Delete activity
activity_delete 1 param → 204404409
POST
/activities/{uuid}/actions/lock
Lock the content
activity_lock 1 param → 204404409
POST
/activities/{uuid}/actions/unlock
Unlock the content
activity_unlock 1 param → 204404409
GET
/activities/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the activity
activity_getDisciplineAssociation 2 params → 200404
PUT
/activities/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the activity
activity_putDisciplineAssociation 2 params body → 200400404
GET
/activities/{uuid}/files/{fileId}
Get file from the activity
activity_getFile 2 params → 200
GET
/activities/{uuid}/notes
Lists notes
activity_listNotes 3 params → 200404
PUT
/activities/{uuid}/notes
Create note
activity_createNote 1 param body → 200400

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Activity (36 properties), Document (17 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.

DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties 1 required
Visibility
object
Visibility of an object
2 properties 1 required
ContentRef
object
2 properties 2 required
PageInformation
object
Information about pages
2 properties
ActivityListResult
object
List of activities. Can contain a subset of all items along with the full count
3 properties
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties 1 required
OrganizationRef
object
A reference to an organization in the institution
1 required
Activity
object
Activities exist in many variations.
36 properties 6 required
ClassificationRef
object
A reference to a classification value
2 properties 1 required
UploadedFile
object
Information about the uploaded file
7 properties 1 required
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties 2 required
StudentThesisRef
object
A reference to student thesis
1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties 2 required
Workflow
object
Information about workflow
2 properties 1 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties 1 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
PressMediaRef
object
A reference to a press/media
1 required
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
WorkflowListResult
object
List of workflow steps.
1 property
ClassificationRefList
object
List of classification references
1 property
ImpactRef
object
A reference to impact
1 required
LocalesList
object
List of available locales
1 property
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property 1 required
NoteListResult
object
List of notes
3 properties
ActivityRef
object
A reference to an activity
1 required
Note
object
A note
3 properties 1 required
Document
object
Document
17 properties 4 required
OrderingsList
object
List of available orderings
1 property
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ActivitiesQuery
object
Create a query for activities
6 properties
CompoundDateRange
object
A date range of that can be defined by only year, year and month or a full date
2 properties
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
Name
object
A name describing a person, made up of given- and family name
2 properties
ProblemDetails
object
RFC7807 Error details
5 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
AbstractActivityPersonAssociation
object
An association between an activity and a person, which can either be internal or external
5 properties 2 required
ImageFile
object
An image file
15 properties 2 required
Identifier
object
1 property 1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ResearchOutputRef
object
A reference to a research output
1 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
EquipmentRef
object
A reference to a piece of equipment
1 required
KeywordGroup
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-bath-activity-api-openapi.yml Raw ↑

Other APIs University of Bath publishes across the network.

Research Portal (Pure) OAI-PMH
Research Data Archive OAI-PMH
Research Data Archive REST/Feeds
Library Discovery (Ex Libris Primo)
Azure API Management Developer Portal (non-production)
University of Bath application API
University of Bath authorCollaboration API
University of Bath award API
University of Bath classificationScheme API
University of Bath dataSet API
University of Bath equipment API
University of Bath event API
Where this information came from

This is an independent, third-party profile of University of Bath activity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.