AppFunction

Organizes system functions (including menu, button, and panel) and permission assignments

---

Query the functions list of application

GET

/api/v1/app/{appId}/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

查询参数

id

类型integer

format"int64"

code

类型string

name

类型string

showName

类型string

pid

类型integer

format"int64"

type

类型string

枚举

"MENU""BUTTON""PANEL"

authCtrl

类型boolean

enabled

类型boolean

sequence

类型integer

format"int32"

apiId

Function associated api id

类型integer

format"int64"

tagId

Function tag id

类型integer

format"int64"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/app/{appId}/func

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

id

code

name

showName

pid

type

authCtrl

enabled

sequence

apiId

tagId

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Replace application functions

PUT

/api/v1/app/{appId}/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

请求体

application/json

[

{

"id": 0,

"code": "script:add",

"name": "Add angus script",

"showName": "Add script",

"pid": 0,

"icon": "http://dev-files.xcan.cloud/storage/api/v1/file/Menu01.icon",

"type": "string",

"description": "Add angus script",

"authCtrl": true,

"url": "http://dev-tester.xcan.cloud/scripts",

"sequence": 10000,

"apiIds": [

0

],

"tagIds": [

0

]

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/app/{appId}/func

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

主体

示例

cURL

JavaScript

PHP

Python

---

Add application functions

POST

/api/v1/app/{appId}/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

请求体

application/json

[

{

"code": "script:add",

"name": "Add angus script",

"showName": "Add script",

"pid": 0,

"icon": "http://dev-files.xcan.cloud/storage/api/v1/file/Menu01.icon",

"type": "string",

"description": "Add angus script",

"authCtrl": true,

"url": "http://dev-tester.xcan.cloud/scripts",

"sequence": 10000,

"apiIds": [

0

],

"tagIds": [

0

]

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/app/{appId}/func

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

主体

示例

cURL

JavaScript

PHP

Python

---

Delete the functions of application

DELETE

/api/v1/app/{appId}/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/app/{appId}/func

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

ids*

示例

cURL

JavaScript

PHP

Python

---

Update application functions

PATCH

/api/v1/app/{appId}/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

请求体

application/json

[

{

"id": 1,

"code": "script:add",

"name": "Add angus script",

"showName": "Add script",

"pid": 0,

"icon": "http://dev-files.xcan.cloud/storage/api/v1/file/Menu01.icon",

"description": "Add angus script",

"authCtrl": true,

"url": "http://dev-tester.xcan.cloud/scripts",

"sequence": 10000,

"apiIds": [

0

],

"tagIds": [

0

]

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/app/{appId}/func

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

主体

示例

cURL

JavaScript

PHP

Python

---

Enable or disable the functions of application

PATCH

/api/v1/app/{appId}/func/enabled

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

请求体

application/json

[

{

"id": 1,

"enabled": true

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/app/{appId}/func/enabled

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

主体

示例

cURL

JavaScript

PHP

Python

---

Query the function tree of application

GET

/api/v1/app/{appId}/func/tree

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

查询参数

id

类型integer

format"int64"

code

类型string

name

类型string

showName

类型string

pid

类型integer

format"int64"

type

类型string

枚举

"MENU""BUTTON""PANEL"

authCtrl

类型boolean

enabled

类型boolean

sequence

类型integer

format"int32"

apiId

Function associated api id

类型integer

format"int64"

tagId

Function tag id

类型integer

format"int64"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/app/{appId}/func/tree

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

id

code

name

showName

pid

type

authCtrl

enabled

sequence

apiId

tagId

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the function tree of application

GET

/api/v1/app/{appId}/func/tree/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

查询参数

id

类型integer

format"int64"

code

类型string

name

类型string

showName

类型string

pid

类型integer

format"int64"

type

类型string

枚举

"MENU""BUTTON""PANEL"

authCtrl

类型boolean

enabled

类型boolean

sequence

类型integer

format"int32"

apiId

Function associated api id

类型integer

format"int64"

tagId

Function tag id

类型integer

format"int64"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/app/{appId}/func/tree/search

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

id

code

name

showName

pid

type

authCtrl

enabled

sequence

apiId

tagId

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the function list of application

GET

/api/v1/app/{appId}/func/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

appId*

Application id

类型integer

必填

format"int64"

查询参数

id

类型integer

format"int64"

code

类型string

name

类型string

showName

类型string

pid

类型integer

format"int64"

type

类型string

枚举

"MENU""BUTTON""PANEL"

authCtrl

类型boolean

enabled

类型boolean

sequence

类型integer

format"int32"

apiId

Function associated api id

类型integer

format"int64"

tagId

Function tag id

类型integer

format"int64"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/app/{appId}/func/search

试验场

服务器

授权

UserHttpBearer

变量

键

值

appId*

id

code

name

showName

pid

type

authCtrl

enabled

sequence

apiId

tagId

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Query the function detail of application

GET

/api/v1/app/func/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Function id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/app/func/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---