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

Hamad Bin Khalifa University projects API

The projects API from Hamad Bin Khalifa University — 17 operation(s) for projects.

Hamad Bin Khalifa University projects API is one of 11 APIs that Hamad Bin Khalifa University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include projects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 27 operations across 17 paths, and defines 37 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.figshare.com/v2.

27 operations 17 paths 37 schemas 4 DELETE12 GET1 PATCH8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.figshare.com/v2
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Hamad Bin Khalifa University projects API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 27

Across 17 paths, the API surfaces 27 operations — 4 DELETE, 12 GET, 1 PATCH, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

projects 27
GET
/projects
Public Projects
projects_list 10 params → 200400422500
POST
/projects/search
Public Projects Search
projects_search 1 param body → 200400422500
GET
/projects/{project_id}
Public Project
project_details 1 param → 200400404500
GET
/projects/{project_id}/articles
Public Project Articles
project_articles 5 params → 200400404500
POST
/account/projects/search
Private Projects search
private_projects_search body → 200400422500
GET
/account/projects
Private Projects
private_projects_list 8 params → 200400403500
POST
/account/projects
Create project
private_project_create body → 201400403500
GET
/account/projects/{project_id}
View project details
private_project_details 1 param → 200400403404500
PUT
/account/projects/{project_id}
Update project
private_project_update 1 param body → 205403404500
DELETE
/account/projects/{project_id}
Delete project
private_project_delete 1 param → 204403404500
PATCH
/account/projects/{project_id}
Partially update project
private_project_partial_update 1 param body → 205403404500
POST
/account/projects/{project_id}/publish
Private Project Publish
private_project_publish 1 param → 200400403404500
GET
/account/projects/{project_id}/notes
List project notes
private_project_notes_list 5 params → 200400403404500
POST
/account/projects/{project_id}/notes
Create project note
private_project_notes_create 1 param body → 201400403404500
GET
/account/projects/{project_id}/notes/{note_id}
Project note details
private_project_note 2 params → 200400403404500
PUT
/account/projects/{project_id}/notes/{note_id}
Update project note
private_project_note_update 2 params body → 205400403404500
DELETE
/account/projects/{project_id}/notes/{note_id}
Delete project note
private_project_note_delete 2 params → 204403404500
POST
/account/projects/{project_id}/leave
Private Project Leave
private_project_leave 1 param → 204400403404500
GET
/account/projects/{project_id}/collaborators
List project collaborators
private_project_collaborators_list 1 param → 200400403404500
POST
/account/projects/{project_id}/collaborators
Invite project collaborators
private_project_collaborators_invite 1 param body → 201400403404500
DELETE
/account/projects/{project_id}/collaborators/{user_id}
Remove project collaborator
private_project_collaborator__Delete 2 params → 204400403404500
GET
/account/projects/{project_id}/articles
List project articles
private_project_articles_list 1 param → 200400403404500
POST
/account/projects/{project_id}/articles
Create project article
private_project_articles_create 1 param body → 201400403404500
GET
/account/projects/{project_id}/articles/{article_id}
Project article details
private_project_article_details 2 params → 200400403404500
DELETE
/account/projects/{project_id}/articles/{article_id}
Delete project article
private_project_article_delete 2 params → 204400403404500
GET
/account/projects/{project_id}/articles/{article_id}/files
Project article list files
private_project_article_files 2 params → 200400403404500
GET
/account/projects/{project_id}/articles/{article_id}/files/{file_id}
Project article file details
private_project_article_file 3 params → 200400403404500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are ProjectArticle (23 properties), ArticleProjectCreate (20 properties), Article (16 properties), ProjectCompletePrivate (13 properties). Each schema is shown below with its type and property counts.

Category
object
6 properties 6 required
ArticleProjectCreate
object
20 properties 1 required
ArticleCompletePrivate
object
2 properties 2 required
ProjectArticle
object
23 properties 22 required
ProjectCreate
object
7 properties 1 required
ProjectUpdate
object
6 properties
FundingCreate
object
2 properties
RelatedMaterial
object
7 properties
Timeline
Location
object
1 property 1 required
TimelineUpdate
object
3 properties
ProjectsSearch
object
1 property
PrivateFile
object
5 properties 5 required
Project
object
5 properties 5 required
ProjectComplete
object
7 properties 7 required
CustomArticleField
object
6 properties 6 required
PublicFile
object
8 properties 7 required
ProjectPrivate
object
2 properties 2 required
ResponseMessage
object
1 property 1 required
Article
object
16 properties 16 required
ProjectCompletePrivate
object
13 properties 13 required
License
object
3 properties 3 required
ErrorMessage
object
2 properties
ProjectNote
object
6 properties 6 required
CreateProjectResponse
object
2 properties 2 required
Author
object
7 properties 7 required
Collaborator
object
3 properties 3 required
GroupEmbargoOptions
object
3 properties 3 required
ArticleComplete
object
7 properties 7 required
CustomArticleFieldAdd
object
2 properties 2 required
FundingInformation
object
6 properties 6 required
ShortCustomField
object
6 properties 3 required
ProjectCollaboratorInvite
object
4 properties 1 required
CommonSearch
object
10 properties
ProjectCollaborator
object
4 properties 4 required
ProjectNoteCreate
object
1 property 1 required
ProjectNotePrivate
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hbku-projects-api-openapi.yml Raw ↑

Other APIs Hamad Bin Khalifa University publishes across the network.

Figshare OAI-PMH (Manara - HBKU Research)
Hamad Bin Khalifa University altmetric API
Hamad Bin Khalifa University articles API
Hamad Bin Khalifa University authors API
Hamad Bin Khalifa University collections API
Hamad Bin Khalifa University institutions API
Hamad Bin Khalifa University oauth API
Hamad Bin Khalifa University other API
Hamad Bin Khalifa University profiles API
Hamad Bin Khalifa University symplectic API