Graviti Open API

Api Overview

Actions on Datasets

API
Description
Acquire the list of authentication configuration
Create a dataset
Delete a dataset
Update a dataset
List datasets
Get a dataset
Create a branch
Delete a branch
List branches
Create a draft
ListDraft
List drafts
Commit a dataset
List commits
CreateTag
Create a tag
DeleteTag
Delete a tag
ListTag
List tags
Upload a dataset note
GetNote
Get the note of a dataset

Actions on Data

API
Description
GetPolicy
Acquire data upload token
Put callback
Batch callback
Create a segment
Delete a segment
List segments
Upload label catalog
Acquire label catalog
Create a sensor
Delete a sensor
List sensors
ListData
List data
Acquire data URL
Upload label
ListLabel
Acquire annotation labels of a dataset
Delete data

Common

Common Parameters

Some common parameters in the doc
Name
Descriptions
Value
service
Prefix of API request address
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

1
{
2
"code": "error_code",
3
"message": "***"
4
}
Copied!
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. 。
1
# Response status
2
HttpStatus 404
3
# Response result
4
{
5
"code": "ResourceNotExist",
6
"message": "dataset not exist!"
7
}
Copied!

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. 1.
    Support MySQL wildcard query, such as %, _, and other wildcard characters
  2. 2.
    If there is no MySQL wildcard, the default is %{fuzzy query}% with fuzzy matching before and after
  3. 3.
    If the query field contains MySQL wildcard, automatic fuzzy matching is disabled
  4. 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. 1.
    name = graviti, return graviti_1, great_graviti_1, graviti%1
  2. 2.
    name = graviti\_%, return graviti_1, great_graviti_1
  3. 3.
    name = graviti\_, return none
  4. 4.
    name = graviti%, return graviti_1,graviti%1
  5. 5.
    name = graviti\%%, return graviti%1
  6. 6.
    name = graviti\%, return none
  7. 7.
    name = graviti\%1, return graviti%1
  8. 8.
    name = %graviti, return none
Last modified 6mo ago