You are located in service: Coscine

API

API

Kurzinformation

Coscine offers an Application Programming Interface for the automization of workflows. Learn more about the Coscine API in the following paragraphs.


Detailinformation

You can interact with coscine via a REST API (REpresentational State Transfer). For this purpose you need an access token. The process of creating an access token in your user profile is described in Access Token. Once you have an access token associated with your coscine account you can start using the API.

To become familiar with API functions and how to use them you should take a look at the documentation of the specific endpoints. There you are able to test certain functions with custom parameters.

API Description
EndpointDescriptionLink
NotificationsThe NotificationApi handles the sync and async sending of notification.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Notification/swagger/index.html
Resources

This api provides methods for interacting with resources.

https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Resources/swagger/index.html
Project

This api provides methods to access, create and update project information.

https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Project/swagger/index.html
UserThis api provides methods to access and update user information.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.User/swagger/index.html
TreeApiThe TreeApi handles the retrieving or storing metadata to a certain path.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Tree/swagger/index.html
OrganizationThis api provides methods for interacting with organizations.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Organization/swagger/index.html
BlobApiThe BlobApi handles the interaction with binary large objects in the Coscine environment.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Blob/swagger/index.html
MetadataThis api provides methods for interacting with metadata.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Metadata/swagger/index.html

Bindings for various programming languages

You can use the API with a variety of programming languages. We have already implemented an example for you in the Python programming language:

https://git.rwth-aachen.de/coscine/docs/public/wiki/-/blob/master/tutorials/api-interaction/python/Step-by-step%20API%20connection%20tutorial.md

Following the step by step instructions for building the example program, you will learn how to include the Coscine API in the programming language of your choice. As an experienced user, you may skip the example and integrate the resulting library directly into your own program. Nevertheless, it makes sense to take a look at the step-by-step instructions beforehand. The repository for the Python connector can be accessed via the following link:

https://git.rwth-aachen.de/coscine/docs/public/wiki/-/tree/master/tutorials/api-interaction/python

last changed on 11.02.2021

How did this content help you?