跳到主要内容

Core API

Gitee Team (2.9.3)

Download OpenAPI specification:Download

This is the API Specification from Gitee Team.

Introduction

The Gitee Team OpenAPI can be used by 3rd party Applications and System Integrations.

Cross-Origin Resource Sharing

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.

Authentication

Gitee Team offers two forms of authentication:

  • API Token
  • Session Token

X-Parse-Session-Token

Session Token for frontend usage

Security Scheme Type: API Key
Header parameter name: X-Parse-Session-Token

X-Proxima-API-Token

API Token for 3rd party development

Security Scheme Type: API Key
Header parameter name: X-Proxima-API-Token

Workspace

Workspace related APIs

Get workspacePages of a workspace as menu

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get workspace detail by workspaceKey

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Responses

Response samples

Content type
application/json
{
  • "boardGroups": [ ],
  • "itemTypes": [ ],
  • "workspace": { },
  • "workspaceAuth": {
    }
}

Search

Item search apis

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

Content type
application/json
{
  • "iql": "order by createdAt",
  • "from": 0,
  • "size": 20
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Search Item by IQL with hierarchy

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

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

Content type
application/json
{
  • "iql": "string",
  • "from": 0,
  • "size": 0,
  • "isShowAncestors": true,
  • "isShowDescendants": true,
  • "workspaceIdOrFilterId": "string"
}

Response samples

Content type
application/json
{
  • "depths": [ ],
  • "hitIds": [ ],
  • "rows": [ ]
}

Get autocomplete data

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get autocomplete suggestions

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Item

Item related apis

Get item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Edit item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Create an item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
Request Body schema: application/json
required
name
string
ancestors
Array of strings
required
object
required
object
object
values
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ancestors": [
    ],
  • "workspace": {
    },
  • "itemType": {
    },
  • "itemGroup": {
    },
  • "values": { }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "ancestors": [
    ],
  • "workspace": {
    },
  • "itemType": {
    },
  • "itemGroup": {
    },
  • "values": { }
}

Clone item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Update item ancestor

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Quick edit item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Bulk create item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Bulk delete item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Watch item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
path Parameters
idOrKey
required
string

Object Id or Key

UnWatch item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
path Parameters
idOrKey
required
string

Object Id or Key

Get item forest

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Create item forest

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Update item forest

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Refresh item forest

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Delete item forest

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Update forest item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Workflow

Workflow

Bulk item transition

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

get workflows by item list

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get workflow by id or key

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
path Parameters
idOrKey
required
string

Object Id or Key

Get available executers

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
path Parameters
idOrKey
required
string

Object Id or Key

Get available user/group/role

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
path Parameters
idOrKey
required
string

Object Id or Key

security-level

Item security level

Get workspace list

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get workspace securityLevel

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Create securityLevel

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get securityLevel

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Update securityLevel

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Delete securityLevel

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get securityLevelScheme

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Update securityLevelScheme

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Delete securityLevelScheme

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get securityLevelScheme list

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

user

User related

User login

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

User login captcha

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

User register

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Reset password

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get roles

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get user roles as tree

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get user roles

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get all user groups

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

create user group

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

getUsersByGroups

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Fetch user group as tree format

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Fetch groups for a user

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

permission

Permissions

Get permission schemes

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Change permission schemes

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Copy permission schemes

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Find permission scheme privileges

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Find privileges

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Grant privileges

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Cancel privileges

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Remove privileges

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Permission keys

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get user privilege for a workspace

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get permission schemes

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

field-behavior

Field behavior

configFields

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

conditionFields

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Create field behavior

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

c

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

c

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

c

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

export

Export item

Export Excel

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

board

Board

Get board

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
path Parameters
idOrKey
required
string

Object Id or Key

Responses

get view privilege

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

get browser privilege

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

grant board privilege

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

cancel board privilege

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

remove board privilege

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

fetch board privileges

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

fetch board policies for workspace

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

add board policy

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

delete board policy

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

fetch board groups

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

app

App

Update Application

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token
path Parameters
idOrKey
required
string

Object Id or Key

Responses

Get Module Manifest

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get Workspace Modules

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get web-trigger by key

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Uninstall Application

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

report

Report

create report chart

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

query report chart list

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

update

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

duplicate report

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

query dashboard

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

automation

Automation

Get Automation Logs

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get Automation Log Item

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Delete automation scenes

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Move automation scenes

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Enable/disable scenes

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

system

System

Refresh item index

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get system entity engine version

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get system version info

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

screen

Get screen by workspace and itemType

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get screen Id list by workspace and itemType

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get screens

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Get screen customFields

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

attachment

Uninstall Application

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

workspace role

Fetch workspace role

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Create workspace role

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Fetch view role

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token

Find workspace role by workspace

Authorizations:
X-Proxima-API-TokenX-Parse-Session-Token