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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hamad Bin Khalifa University

Hamad Bin Khalifa University articles API

The articles API from Hamad Bin Khalifa University — 34 operation(s) for articles.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hamad Bin Khalifa University articles 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 articles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 53 operations across 34 paths, and defines 45 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.

53 operations 34 paths 45 schemas 7 DELETE22 GET2 PATCH14 POST8 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
Contact
Figshare Support
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 53

Across 34 paths, the API surfaces 53 operations — 7 DELETE, 22 GET, 2 PATCH, 14 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

articles 53
GET
/articles
Public Articles
articles_list 15 params → 200400422500
POST
/articles/search
Public Articles Search
articles_search 1 param body → 200400422500
GET
/articles/{article_id}
View article details
article_details 1 param → 200400404500
GET
/articles/{article_id}/versions
List article versions
article_versions 1 param → 200400404500
GET
/articles/{article_id}/versions/{version_id}
Article details for version
article_version_details 2 params → 200400404500
GET
/articles/{article_id}/versions/{version_id}/files
Public Article version files
article_version_files 6 params → 200400404500
GET
/articles/{article_id}/download
Public Article Download
public_article_download 2 params → 200500
GET
/articles/{article_id}/versions/{version_id}/download
Public Article Version Download
public_article_version_download 3 params → 200500
GET
/articles/{article_id}/versions/{version_id}/embargo
Public Article Embargo for article version
article_version_embargo 2 params → 200400404500
GET
/articles/{article_id}/versions/{version_id}/confidentiality
Public Article Confidentiality for article version
article_version_confidentiality 2 params → 200400404500
GET
/articles/{article_id}/files
List article files
article_files 5 params → 200400404500
GET
/articles/{article_id}/files/{file_id}
Article file details
article_file_details 2 params → 200400404500
POST
/account/articles/search
Private Articles search
private_articles_search body → 200400403500
GET
/account/articles
Private Articles
private_articles_list 4 params → 200400403500
POST
/account/articles
Create new Article
private_article_create body → 201400403500
GET
/account/articles/{article_id}
Article details
private_article_details 1 param → 200400403404500
PUT
/account/articles/{article_id}
Update article
private_article_update 1 param body → 205403404500
DELETE
/account/articles/{article_id}
Delete article
private_article_delete 1 param → 204403404500
PATCH
/account/articles/{article_id}
Partially update article
private_article_partial_update 1 param body → 205403404500
GET
/account/articles/{article_id}/embargo
Article Embargo Details
private_article_embargo_details 1 param → 200400403404500
PUT
/account/articles/{article_id}/embargo
Update Article Embargo
private_article_embargo_update 1 param body → 205400403404500
DELETE
/account/articles/{article_id}/embargo
Delete Article Embargo
private_article_embargo_delete 1 param → 204403404500
POST
/account/articles/{article_id}/resource
Private Article Resource
private_article_resource 1 param body → 205400403404422
POST
/account/articles/{article_id}/publish
Private Article Publish
account_article_publish 1 param → 201400403404500
POST
/account/articles/{article_id}/unpublish
Public Article Unpublish
account_article_unpublish 1 param body → 204400403404500
POST
/account/articles/{article_id}/reserve_doi
Private Article Reserve DOI
private_article_reserve_doi 1 param → 200400403404500
POST
/account/articles/{article_id}/reserve_handle
Private Article Reserve Handle
private_article_reserve_handle 1 param → 200400403404500
GET
/account/articles/{article_id}/download
Private Article Download
private_article_download 2 params → 200403500
PUT
/account/articles/{article_id}/versions/{version_id}
Update article version
article_version_update 2 params body → 205403404500
PATCH
/account/articles/{article_id}/versions/{version_id}
Partially update article version
article_version_partial_update 2 params body → 205403404500
PUT
/account/articles/{article_id}/versions/{version_id}/update_thumb
Update article version thumbnail
article_version_update_thumb 2 params body → 205403404422
GET
/account/articles/{article_id}/authors
List article authors
private_article_authors_list 1 param → 200400403404500
PUT
/account/articles/{article_id}/authors
Replace article authors
private_article_authors_replace 1 param body → 205400403404500
POST
/account/articles/{article_id}/authors
Add article authors
private_article_authors_add 1 param body → 205400403404500
DELETE
/account/articles/{article_id}/authors/{author_id}
Delete article author
private_article_author_delete 2 params → 204403404500
GET
/account/articles/{article_id}/categories
List article categories
private_article_categories_list 1 param → 200400403404500
PUT
/account/articles/{article_id}/categories
Replace article categories
private_article_categories_replace 1 param body → 205400403404500
POST
/account/articles/{article_id}/categories
Add article categories
private_article_categories_add 1 param body → 205400403404500
DELETE
/account/articles/{article_id}/categories/{category_id}
Delete article category
private_article_category_delete 2 params → 204403404500
GET
/account/articles/{article_id}/confidentiality
Article confidentiality details
private_article_confidentiality_details 1 param → 200400403404500
PUT
/account/articles/{article_id}/confidentiality
Update article confidentiality
private_article_confidentiality_update 1 param body → 205400403404500
DELETE
/account/articles/{article_id}/confidentiality
Delete article confidentiality
private_article_confidentiality_delete 1 param → 204400403404500
GET
/account/articles/{article_id}/private_links
List private links
private_article_private_link 1 param → 200400403404500
POST
/account/articles/{article_id}/private_links
Create private link
private_article_private_link_create 1 param body → 201400403404422500
PUT
/account/articles/{article_id}/private_links/{link_id}
Update private link
private_article_private_link_update 2 params body → 205400403404422500
DELETE
/account/articles/{article_id}/private_links/{link_id}
Disable private link
private_article_private_link_delete 2 params → 204400403404500
GET
/account/articles/{article_id}/files
List article files
private_article_files_list 5 params → 200400403404500
POST
/account/articles/{article_id}/files
Initiate Upload
private_article_upload_initiate 5 params body → 201400403404422500
GET
/account/articles/{article_id}/files/{file_id}
Single File
private_article_file 2 params → 200400403404500
POST
/account/articles/{article_id}/files/{file_id}
Complete Upload
private_article_upload_complete 2 params → 202400403404500
DELETE
/account/articles/{article_id}/files/{file_id}
File Delete
private_article_file_delete 2 params → 204400403404500
GET
/account/articles/export
Account Article Report
account_article_report 1 param → 200400500
POST
/account/articles/export
Initiate a new Report
account_article_report_generate → 200429500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are ArticleUpdate (24 properties), ArticleCreate (23 properties), ProjectArticle (23 properties), Article (16 properties). Each schema is shown below with its type and property counts.

Category
object
6 properties 6 required
ArticleSearch
object
6 properties
ArticleCompletePrivate
object
2 properties 2 required
ArticleVersions
object
2 properties 2 required
ProjectArticle
object
23 properties 22 required
ArticleUpdate
object
24 properties
ArticleHandle
object
1 property 1 required
FundingCreate
object
2 properties
ArticleDOI
object
1 property 1 required
Resource
object
6 properties
RelatedMaterial
object
7 properties
PrivateLink
object
4 properties 4 required
Timeline
ArticleUnpublishData
object
1 property 1 required
ArticleEmbargoUpdater
object
6 properties 3 required
ArticleEmbargo
object
4 properties 4 required
PrivateLinkCreator
object
1 property
TimelineUpdate
object
3 properties
Location
object
1 property 1 required
LocationWarningsUpdate
object
2 properties 2 required
PrivateFile
object
5 properties 5 required
FileId
object
1 property
AuthorsCreator
object
1 property 1 required
CustomArticleField
object
6 properties 6 required
PublicFile
object
8 properties 7 required
Article
object
16 properties 16 required
License
object
3 properties 3 required
ErrorMessage
object
2 properties
ArticleVersionUpdate
object
2 properties
LocationWarnings
object
3 properties 3 required
ArticleWithProject
object
1 property 1 required
PrivateArticleSearch
object
1 property
Author
object
7 properties 7 required
GroupEmbargoOptions
object
3 properties 3 required
PrivateLinkResponse
object
3 properties 3 required
ArticleComplete
object
7 properties 7 required
FileCreator
object
5 properties
CustomArticleFieldAdd
object
2 properties 2 required
FundingInformation
object
6 properties 6 required
CommonSearch
object
10 properties
ArticleConfidentiality
object
2 properties 2 required
CategoriesCreator
object
1 property 1 required
ArticleCreate
object
23 properties 1 required
AccountReport
object
6 properties 6 required
ConfidentialityCreator
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hbku-articles-api-openapi.yml Raw ↑

Other APIs Hamad Bin Khalifa University publishes across the network.

Figshare OAI-PMH (Manara - HBKU Research)
AE Profile APIs.io
Hamad Bin Khalifa University altmetric API
AE Profile APIs.io
Hamad Bin Khalifa University authors API
AE Profile APIs.io
Hamad Bin Khalifa University collections API
AE Profile APIs.io
Hamad Bin Khalifa University institutions API
AE Profile APIs.io
Hamad Bin Khalifa University oauth API
AE Profile APIs.io
Hamad Bin Khalifa University other API
AE Profile APIs.io
Hamad Bin Khalifa University profiles API
AE Profile APIs.io
Hamad Bin Khalifa University projects API
AE Profile APIs.io
Hamad Bin Khalifa University symplectic API
AE Profile APIs.io
#articles
← Back to H APIs
API Details
ID
hbku:hbku-articles-api
Base URL
https://api.figshare.com/v2
Docs
https://docs.figshare.com/
Provider
Hamad Bin Khalifa University
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network