Find - Central Service - REST API

You can find out more about ioChem-BD central service at https://www.iochem-bd.org/.

Additional links:

• Project source code
• Create module API
• Browse module API
• Find Central Service API

Base URL

https://www.iochem-bd.org/rest

Version: 1.0.0

Terms of service

https://www.iochem-bd.org/tos.html

Contact information:
contact@iochem-bd.org

License: AGPL 3.0

Pagination

REST API implementation configuration:

Parameters:

• limit - Number of items per page (default: 100)
• offset - Starting position in result set (default: 0)

Example:

GET https://www.iochem-bd.org/rest/collections?limit=5&offset=10

Usage: Add ?limit=N&offset=M to endpoints returning arrays (communities, collections, items).

/

GET

Summary:

Return index page

Responses

Code	Description
200	Index page returned

/test

GET

Summary:

Health check endpoint

Responses

Code	Description
200	Returns "REST api is running"

/communities

GET

Summary:

Get all communities

Responses

Code	Description
200	Array of all communities

/communities/top-communities

GET

Summary:

Get top-level communities

Responses

Code	Description
200	Top-level communities returned

/communities/

GET

Summary:

Get community by ID

Parameters

Name	Located in	Description	Required	Schema
communityId	path	Community UUID	Yes	string (UUID)

Responses

Code	Description
200	Community found

/communities/{communityId}/collections

GET

Summary:

Get collections in a community

Parameters

Name	Located in	Description	Required	Schema
communityId	path	Community UUID	Yes	string (UUID)

Responses

Code	Description
200	Collections returned

/communities/{communityId}/communities

GET

Summary:

Get subcommunities of a community

Parameters

Name	Located in	Description	Required	Schema
communityId	path	Community UUID	Yes	string (UUID)

Responses

Code	Description
200	Subcommunities returned

/collections

GET

Summary:

Get all collections

Responses

Code	Description
200	Array of all collections

/collections/

GET

Summary:

Get collection by ID

Parameters

Name	Located in	Description	Required	Schema
collectionId	path	Collection UUID	Yes	string (UUID)

Responses

Code	Description
200	Collection found

/collections/{collectionId}/items

GET

Summary:

Get items in a collection

Parameters

Name	Located in	Description	Required	Schema
collectionId	path	Collection UUID	Yes	string (UUID)

Responses

Code	Description
200	Items returned

/items

GET

Summary:

Get all items

Responses

Code	Description
200	Array of items

/items/

GET

Summary:

Get item by ID

Parameters

Name	Located in	Description	Required	Schema
itemId	path	Item UUID	Yes	string (UUID)

Responses

Code	Description
200	Item found

/items/{itemId}/metadata

GET

Summary:

Get metadata of item

Parameters

Name	Located in	Description	Required	Schema
itemId	path	Item UUID	Yes	string (UUID)

Responses

Code	Description
200	Metadata returned

/items/{itemId}/bitstreams

GET

Summary:

Get bitstreams of item

Parameters

Name	Located in	Description	Required	Schema
itemId	path	Item UUID	Yes	string (UUID)

Responses

Code	Description
200	Bitstreams returned

/bitstreams

GET

Summary:

Return all bitstreams in DSpace

Responses

Code	Description
200	List of bitstreams

/bitstreams/

GET

Summary:

Return the specified bitstream

Parameters

Name	Located in	Description	Required	Schema
bitstreamId	path	Bitstream UUID	Yes	string (UUID)

Responses

Code	Description
200	Bitstream details
404	Bitstream not found

/bitstreams/{bitstreamId}/policy

GET

Summary:

Return policies of the specified bitstream

Parameters

Name	Located in	Description	Required	Schema
bitstreamId	path	Bitstream UUID	Yes	string (UUID)

Responses

Code	Description
200	List of policies
404	Bitstream not found

/bitstreams/{bitstreamId}/retrieve

GET

Summary:

Return the contents of the specified bitstream

Parameters

Name	Located in	Description	Required	Schema
bitstreamId	path	Bitstream UUID	Yes	string (UUID)

Responses

Code	Description
200	Bitstream content stream
404	Bitstream not found