Core API
Gitee Team (2.9.3)
Download OpenAPI specification:Download
E-mail: yezhiming@oschina.cn
This is the API Specification from Gitee Team.
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
Gitee Team offers two forms of authentication:
- API Token
- Session Token
Search Item by IQL(Item Query Language)
Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
header Parameters
X-Parse-Application-Id required | string Tenant key |
Request Body schema: application/json
iql required | string IQL query string |
from required | number skip size for pagination |
size required | number fetch size |
Responses
Request samples
- Payload
Content type
application/json
{- "iql": "order by createdAt",
- "from": 0,
- "size": 20
}
Response samples
- 200
Content type
application/json
{- "payload": {
- "count": 0,
- "items": [ ]
}
}
Search Item by IQL with infinite hierarchy
Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
Request Body schema: application/json
iql | string |
from | number |
size | number |
isShowAncestors | boolean |
isShowDescendants | boolean |
workspaceIdOrFilterId | string |
Responses
Request samples
- Payload
Content type
application/json
{- "iql": "string",
- "from": 0,
- "size": 0,
- "isShowAncestors": true,
- "isShowDescendants": true,
- "workspaceIdOrFilterId": "string"
}
Response samples
- 200
Content type
application/json
{- "depths": [ ],
- "hitIds": [ ],
- "rows": [ ]
}
Create an item
Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
Request Body schema: application/jsonrequired
name | string |
ancestors | Array of strings |
required | object |
required | object |
object | |
values | object |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "ancestors": [
- "string"
], - "workspace": {
- "__type": "Pointer",
- "objectId": "string",
- "className": "Workspace"
}, - "itemType": {
- "__type": "Pointer",
- "objectId": "string",
- "className": "ItemType"
}, - "itemGroup": {
- "__type": "Pointer",
- "objectId": "string",
- "className": "ItemGroup"
}, - "values": { }
}
Response samples
- 201
- default
Content type
application/json
{- "name": "string",
- "ancestors": [
- "string"
], - "workspace": {
- "__type": "Pointer",
- "objectId": "string",
- "className": "Workspace"
}, - "itemType": {
- "__type": "Pointer",
- "objectId": "string",
- "className": "ItemType"
}, - "itemGroup": {
- "__type": "Pointer",
- "objectId": "string",
- "className": "ItemGroup"
}, - "values": { }
}