Qiita REST API¶
The Qiita API system is composed by 2 modules.
Qiita Plugin REST API¶
This module allows new plugins to get access, create and update data within Qiita. Note that some of these
endpoints are required to follow RFC6750 and pass a payload to the methods, the rest follow the general format
for GET/POST. A payload has 3 main components: 'success': True/False
, 'step': <str>
, and 'values': <dict>
;
the important parts of the values are described in the Parameters column.
Action |
URI |
Parameters |
Description |
Object Name |
POST |
|
|
Authenticate given information as per RFC6750 |
TokenAuthHandler |
POST |
|
Update the heartbeat timestamp of the job |
HeartbeatHandler |
|
POST |
|
|
Changes the current execution step of the given job |
ActiveStepHandler |
POST |
|
|
Updates the job to one of the completed statuses: ‘success’, ‘error’ |
CompleteHandler |
GET |
|
Get the job information |
JobHandler |
|
GET |
|
Retrieves the available artifact types and their local mount point |
ArtifactTypeHandler |
|
POST |
|
|
Creates a new artifact type |
ArtifactTypeHandler |
GET |
|
Retrieves the artifact information |
ArtifactHandler |
|
PATCH |
|
|
Retrieves the artifact information |
ArtifactHandler |
POST |
|
|
Injects artifacts to existing prep templates or jobs |
APIArtifactHandler |
GET |
|
Retrieves the email and name of all the users |
UsersListDBHandler |
|
GET |
|
Retrieves the user information |
UserInfoDBHandlerTests |
|
GET |
|
Retrieves the sample information contents |
SampleInfoDBHandler |
|
GET |
|
Retrieves the preparation information contents |
PrepTemplateDataHandler |
|
GET |
|
Retrieves the preparation information |
PrepTemplateDBHandler |
|
POST |
|
Adds a new preparation |
PrepTemplateAPIHandler |
|
GET |
|
Activates the command |
CommandActivateHandler |
|
GET |
|
Retrieve the command information |
CommandHandler |
|
POST |
|
|
Create new command for a plugin |
CommandListHandler |
GET |
|
Retrieve the plugin information |
PluginHandler |
|
GET |
|
Retrieves the analysis metadata |
APIAnalysisMetadataHandler |
|
POST |
|
|
Retrieves the archiving information |
APIArchiveObservations |
PATCH |
|
|
Retrieves the archiving information |
APIArchiveObservations |
Qiita Internal REST API¶
This is the currently internal but planned to be external (general users) API.
Action |
URI |
Description |
---|---|---|
GET |
|
Get study details (title, contacts, abstract, description and alias). |
GET |
|
Get samples associated with a study and the available metadata headers for these samples. |
PATCH |
|
Update sample metadata or add samples to the sample information. |
GET |
|
Get metadata categories foo and bar for all samples in the study. |
GET |
|
The status of a study (whether or not the study: is public, has sample information, sample information has warnings and a list of existing preparations. |
GET |
|
Get list of persons. |
GET |
|
See if a person exists. |
POST |
|
Create a study (mirrors study creation on qiita UI with minimal requirements). |
POST |
|
Create a study person (ie lab person or PI). |
POST |
|
Associate a prep with a study. |
POST |
|
Associate filepaths to a preparation, assuming this filepaths are present in the uploads folder. |