Graviti Open API

Api Overview

Actions on Datasets

API	Description
ListAuthStorageConfig	Acquire the list of authentication configuration
CreateDataset	Create a dataset
DeleteDataset	Delete a dataset
updateDataset	Update a dataset
ListDataset	List datasets
GetDataset	Get a dataset
CreateBranch	Create a branch
DeleteBranch	Delete a branch
ListBranch	List branches
CreateDraft	Create a draft
ListDraft	List drafts
CommitDataset	Commit a dataset
ListCommit	List commits
CreateTag	Create a tag
DeleteTag	Delete a tag
ListTag	List tags
UploadNote	Upload a dataset note
GetNote	Get the note of a dataset

Actions on Data

API	Description
GetPolicy	Acquire data upload token
PutCallback	Put callback
MultiPutCallback	Batch callback
CreateSegment	Create a segment
DeleteSegment	Delete a segment
ListSegment	List segments
UploadLabelCatalog	Upload label catalog
GetLabelCatalog	Acquire label catalog
UploadSensor	Create a sensor
DeleteSensor	Delete a sensor
ListSensor	List sensors
ListData	List data
ListDataUri	Acquire data URL
UploadLabel	Upload label
ListLabel	Acquire annotation labels of a dataset
DeleteData	Delete data

Common

Common Parameters

Some common parameters in the doc

Name	Descriptions	Value
service	Prefix of API request address	https://gas.graviti.com/gatewayv2/tensorbay-open-api
your_accesskey	Get the AccessKey at GAS Help Center

This module mainly illustrates HTTP common request headers and common response headers.

Name	Type	Descriptions
Content-Type	string	HTTP request content type defined in RFC2616. Default value: application/json
X-Token	string	The AccessKey obtained by the user

Name	Type	Descriptions
X-Request-Id	string	X-Request-Id is created by Graviti and is the only UUID that identifies this response. If you encounter any difficulties when using this service, please contact Graviti. Default value: null

Error code description

Error Code Return Type

{
  "code": "error_code",
  "message": "***"
}

The server may return any of the following type of errors when your request generates an error. For example, the 404 error code occurs when acquiring a dataset. 。

# Response status
HttpStatus 404
#  Response result
{
    "code": "ResourceNotExist", 
    "message": "dataset not exist!"
}

Error Code

Code	Description
AccessDenied	Request is denied and lack of authorized access.
InvalidParamsValue	Invalid parameter value, e.g., invalid parameter format
NameConflict	Name is conflicted
RequestParamsMissing	The required parameters are missing
ResourceNotExist	The resource does not exist when requested
SystemError	System error

Fuzzy Query

For API that supports fuzzy query, please follow these rules:

1. Support MySQL wildcard query, such as %, _, and other wildcard characters.

2. If there is no MySQL wildcard, the default is %{fuzzy query}% with fuzzy matching before and after.

3. If the query field contains MySQL wildcard, automatic fuzzy matching is disabled.

4. If you want the wildcard to be treated only as a normal string, you need to transcribe it, and degrade it to non-fuzzy matching. If you still need fuzzy matching, you need to construct the wildcard query manually.

For example： result： graviti_1, great_graviti_1, graviti%1

1. name = graviti, return graviti_1, great_graviti_1, graviti%1

2. name = graviti\_%, return graviti_1, great_graviti_1

3. name = graviti\_, return none

4. name = graviti%, return graviti_1，graviti%1

5. name = graviti\%%, return graviti%1

6. name = graviti\%, return none

7. name = graviti\%1, return graviti%1

8. name = %graviti, return none