Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

King Fahd University of Petroleum & Minerals studentThesis API

The studentThesis API from King Fahd University of Petroleum & Minerals — 26 operation(s) for studentthesis.

King Fahd University of Petroleum & Minerals studentThesis API is one of 38 APIs that King Fahd University of Petroleum & Minerals publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include studentThesis. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 4 JSON Schemas.

This API exposes 30 operations across 26 paths, and defines 50 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.kfupm.edu.sa/ws/api.

30 operations 26 paths 50 schemas 1 DELETE22 GET3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.35.3-4
Base URL
https://eprints.kfupm.edu.sa/cgi/oai2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

King Fahd University of Petroleum & Minerals studentThesis 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 30

Across 26 paths, the API surfaces 30 operations — 1 DELETE, 22 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

studentThesis 30
GET
/student-theses
Lists all student theses
studentThesis_list 3 params → 200
PUT
/student-theses
Create student thesis
studentThesis_create body → 201400
GET
/student-theses/allowed-contributor-countries
A list of allowed contributor countries for student theses
studentthesis_getAllowedContributorCountries → 200
GET
/student-theses/allowed-contributor-roles
A list of allowed contributor roles for student theses
studentthesis_getAllowedContributorRoles → 200
GET
/student-theses/allowed-custom-defined-field-values/{fieldIdentifer}/classifications
Get allowed classifications for the custom-defined field associated with the student thesis
studentThesis_getAllowedCustomDefinedFieldClassifications 1 param → 200400404
GET
/student-theses/allowed-document-embargo-reasons
A list of allowed document embargo reasons
studentThesis_getAllowedDocumentEmbargoReasons → 200
GET
/student-theses/allowed-document-license-types
A list of allowed document license types
studentThesis_getAllowedDocumentLicenses → 200
GET
/student-theses/allowed-document-types
A list of allowed document types
studentThesis_getAllowedDocumentTypes → 200
GET
/student-theses/allowed-document-version-types
A list of allowed document version types
studentThesis_getAllowedDocumentVersionTypes → 200
GET
/student-theses/allowed-image-types
A list of allowed image types
studentThesis_getAllowedImageTypes → 200
GET
/student-theses/allowed-keyword-group-configurations
A list of keyword group configurations
studentThesis_getAllowedKeywordGroupConfigurations → 200
GET
/student-theses/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
studentThesis_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/student-theses/allowed-languages
A list of allowed languages
studentthesis_getAllowedLanguages → 200
GET
/student-theses/allowed-link-types
A list of allowed link types
studentthesis_getAllowedLinkTypes → 200
GET
/student-theses/allowed-locales
A list of allowed locales in localized strings
studentThesis_getAllowedLocales → 200
GET
/student-theses/allowed-supervisor-roles
A list of allowed supervisor roles
studentthesis_getAllowedSupervisorRoles → 200
GET
/student-theses/allowed-types
A list of allowed student thesis types
studentThesis_getAllowedTypes → 200
GET
/student-theses/allowed-workflow-steps
A list of allowed workflow steps
studentThesis_getAllowedWorkflowSteps → 200
PUT
/student-theses/file-uploads
Upload file to a specific student thesis
studentThesis_fileUploads 1 param body → default
GET
/student-theses/orderings
Lists available orderings
studentThesis_getOrderings → 200
POST
/student-theses/search
Query operation for student theses
studentThesis_query body → 200400
GET
/student-theses/{uuid}
Get student thesis
studentThesis_get 1 param → 200301404
PUT
/student-theses/{uuid}
Update student thesis
studentThesis_update 1 param body → 200400404409
DELETE
/student-theses/{uuid}
Delete student thesis
studentThesis_delete 1 param → 204404409
POST
/student-theses/{uuid}/actions/lock
Lock the content
studentThesis_lock 1 param → 204404409
POST
/student-theses/{uuid}/actions/unlock
Unlock the content
studentThesis_unlock 1 param → 204404409
GET
/student-theses/{uuid}/dependents
Lists all dependents to a student thesis
studentThesis_dependents 2 params → 200
GET
/student-theses/{uuid}/files/{fileId}
Get file from the student thesis
studentThesis_getFile 2 params → 200
GET
/student-theses/{uuid}/notes
Lists notes
studentThesis_listNotes 3 params → 200404
PUT
/student-theses/{uuid}/notes
Create note
studentThesis_createNote 1 param body → 200400

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are StudentThesis (45 properties), StudentThesisDocument (21 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.

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
SupervisorAssociation
object
A supervisor on a research output.
7 properties 1 required
UploadedFile
object
Information about the uploaded file
7 properties 1 required
StudentThesesQuery
object
Create a query for student theses
6 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
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
StudentThesis
object
A student thesis
45 properties 7 required
EquipmentRef
object
A reference to a piece of equipment
1 required
FormattedString
object
A string containing HTML formatted text
1 property 1 required
Note
object
A note
3 properties 1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties 1 required
ClassificationRef
object
A reference to a classification value
2 properties 1 required
AbstractStudentThesisContributorAssociation
object
An association between student thesis and a person that has contributed to it
3 properties 1 required
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
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
ImpactRef
object
A reference to impact
1 required
ImageFile
object
An image file
15 properties 2 required
StudentThesisListResult
object
List of student theses. Can contain a subset of all items along with the full count
3 properties
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.
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
PageInformation
object
Information about pages
2 properties
ResearchOutputRef
object
A reference to a research output
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
PersonRef
object
A reference to a person internal to the institution
1 required
ClassificationRefList
object
List of classification references
1 property
PrizeRef
object
A reference to a prize
1 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
PressMediaRef
object
A reference to a press/media
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.
StudentThesisDocument
object
A student thesis document.
21 properties 5 required
KeywordGroup
object
4 properties 2 required
ExternalPersonRef
object
A reference to a person external to the institution
1 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
ActivityRef
object
A reference to an activity
1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kfupm-studentthesis-api-openapi.yml Raw ↑

Other APIs King Fahd University of Petroleum & Minerals publishes across the network.

KFUPM ePrints REST / Search
King Fahd University of Petroleum & Minerals activity API
King Fahd University of Petroleum & Minerals application API
King Fahd University of Petroleum & Minerals authorCollaboration API
King Fahd University of Petroleum & Minerals award API
King Fahd University of Petroleum & Minerals classificationScheme API
King Fahd University of Petroleum & Minerals concept API
King Fahd University of Petroleum & Minerals conferenceSeries API
King Fahd University of Petroleum & Minerals contract API
King Fahd University of Petroleum & Minerals course API
King Fahd University of Petroleum & Minerals dataSet API
King Fahd University of Petroleum & Minerals education API