Indicator - FunctionalTest

Functional Test Indicator Management - Configure and manage functional test types (smoke testing, security testing) and their evaluation criteria

---

Query the indicator list of functionality

GET

/api/v1/indicator/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

targetType*

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT""SERVICE,API"

admin

Required when app administrators query all Functionality indicator

类型boolean

targetName

Target name

类型string

createdBy

Functionality indicator creator id

类型integer

format"int64"

createdDate

Functionality indicator creation time

类型string

format"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

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/indicator/func

试验场

授权

UserHttpBearer

变量

键

值

targetType*

admin

targetName

createdBy

createdDate

pageNo

pageSize

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 the indicator of functionality

PUT

/api/v1/indicator/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"targetId": 0,

"targetType": "string",

"smoke": true,

"smokeCheckSetting": "string",

"userDefinedSmokeAssertion": {

"name": "Assertion status",

"description": "Assertion response status must is 200.",

"enabled": true,

"type": "BODY",

"parameterName": "string",

"condition": "string",

"assertionCondition": "EQUAL",

"expression": "string",

"matchItem": 0,

"expected": 200,

"extraction": {

"name": "string",

"method": "string",

"expression": "string",

"matchItem": 0,

"defaultValue": "string",

"request": {

"method": "GET",

"url": "string",

"server": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"endpoint": "string",

"authentication": {

"type": "string",

"in": "string",

"scheme": "string",

"name": "string",

"description": "string",

"enabled": "true",

"value": "string",

"apiKeys": [

{

"name": "Authorization",

"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"x-xc-value": "string"

}

],

"oauth2": {

"clientCredentials": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"password": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"authFlow": "string",

"newToken": true,

"token": "string"

}

},

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"body": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"validSecurity": true

},

"location": "string",

"parameterName": "string",

"value": "string",

"finalValue": "string",

"failureMessage": "string"

},

"actualCondition": "string",

"actualExpected": "string",

"extractValue": "string",

"result": {

"failure": true,

"ignored": true,

"message": "string"

},

"success": true,

"enabledFlag": true,

"ignore": true

},

"security": true,

"securityCheckSetting": "string",

"userDefinedSecurityAssertion": {

"name": "Assertion status",

"description": "Assertion response status must is 200.",

"enabled": true,

"type": "BODY",

"parameterName": "string",

"condition": "string",

"assertionCondition": "EQUAL",

"expression": "string",

"matchItem": 0,

"expected": 200,

"extraction": {

"name": "string",

"method": "string",

"expression": "string",

"matchItem": 0,

"defaultValue": "string",

"request": {

"method": "GET",

"url": "string",

"server": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"endpoint": "string",

"authentication": {

"type": "string",

"in": "string",

"scheme": "string",

"name": "string",

"description": "string",

"enabled": "true",

"value": "string",

"apiKeys": [

{

"name": "Authorization",

"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"x-xc-value": "string"

}

],

"oauth2": {

"clientCredentials": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"password": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"authFlow": "string",

"newToken": true,

"token": "string"

}

},

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"body": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"validSecurity": true

},

"location": "string",

"parameterName": "string",

"value": "string",

"finalValue": "string",

"failureMessage": "string"

},

"actualCondition": "string",

"actualExpected": "string",

"extractValue": "string",

"result": {

"failure": true,

"ignored": true,

"message": "string"

},

"success": true,

"enabledFlag": true,

"ignore": true

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/indicator/func

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add the indicator of functionality

POST

/api/v1/indicator/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"targetId": 0,

"targetType": "string",

"smoke": true,

"smokeCheckSetting": "string",

"userDefinedSmokeAssertion": {

"name": "Assertion status",

"description": "Assertion response status must is 200.",

"enabled": true,

"type": "BODY",

"parameterName": "string",

"condition": "string",

"assertionCondition": "EQUAL",

"expression": "string",

"matchItem": 0,

"expected": 200,

"extraction": {

"name": "string",

"method": "string",

"expression": "string",

"matchItem": 0,

"defaultValue": "string",

"request": {

"method": "GET",

"url": "string",

"server": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"endpoint": "string",

"authentication": {

"type": "string",

"in": "string",

"scheme": "string",

"name": "string",

"description": "string",

"enabled": "true",

"value": "string",

"apiKeys": [

{

"name": "Authorization",

"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"x-xc-value": "string"

}

],

"oauth2": {

"clientCredentials": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"password": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"authFlow": "string",

"newToken": true,

"token": "string"

}

},

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"body": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"validSecurity": true

},

"location": "string",

"parameterName": "string",

"value": "string",

"finalValue": "string",

"failureMessage": "string"

},

"actualCondition": "string",

"actualExpected": "string",

"extractValue": "string",

"result": {

"failure": true,

"ignored": true,

"message": "string"

},

"success": true,

"enabledFlag": true,

"ignore": true

},

"security": true,

"securityCheckSetting": "string",

"userDefinedSecurityAssertion": {

"name": "Assertion status",

"description": "Assertion response status must is 200.",

"enabled": true,

"type": "BODY",

"parameterName": "string",

"condition": "string",

"assertionCondition": "EQUAL",

"expression": "string",

"matchItem": 0,

"expected": 200,

"extraction": {

"name": "string",

"method": "string",

"expression": "string",

"matchItem": 0,

"defaultValue": "string",

"request": {

"method": "GET",

"url": "string",

"server": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"endpoint": "string",

"authentication": {

"type": "string",

"in": "string",

"scheme": "string",

"name": "string",

"description": "string",

"enabled": "true",

"value": "string",

"apiKeys": [

{

"name": "Authorization",

"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"x-xc-value": "string"

}

],

"oauth2": {

"clientCredentials": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"password": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"authFlow": "string",

"newToken": true,

"token": "string"

}

},

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"body": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"validSecurity": true

},

"location": "string",

"parameterName": "string",

"value": "string",

"finalValue": "string",

"failureMessage": "string"

},

"actualCondition": "string",

"actualExpected": "string",

"extractValue": "string",

"result": {

"failure": true,

"ignored": true,

"message": "string"

},

"success": true,

"enabledFlag": true,

"ignore": true

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/indicator/func

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the indicator detail of functionality

GET

/api/v1/indicator/{targetType}/{targetId}/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

targetType*

Target Type, allowable values: API

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"

targetId*

Target id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/indicator/{targetType}/{targetId}/func

试验场

授权

UserHttpBearer

变量

键

值

targetType*

targetId*

示例

cURL

JavaScript

PHP

Python

---

Delete the functionality indicator of target

DELETE

/api/v1/indicator/{targetType}/{targetId}/func

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

targetType*

Target Type, allowable values: API

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"

targetId*

Target id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/indicator/{targetType}/{targetId}/func

试验场

授权

UserHttpBearer

变量

键

值

targetType*

targetId*

示例

cURL

JavaScript

PHP

Python

---

Query the indicator detail of functionality

GET

/api/v1/indicator/{targetType}/{targetId}/func/detailOrDefault

Note: Return to default configuration when not set

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

targetType*

Target Type, allowable values: API

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"

targetId*

Target id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/indicator/{targetType}/{targetId}/func/detailOrDefault

试验场

授权

UserHttpBearer

变量

键

值

targetType*

targetId*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the indicator of functionality

GET

/api/v1/indicator/func/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Functionality indicator id

类型integer

format"int64"

targetType*

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT""SERVICE,API"

admin

Required when app administrators query all functionality indicator

类型boolean

targetName

Target name

类型string

createdBy

Functionality indicator creator id

类型integer

format"int64"

createdDate

Functionality indicator creation time

类型string

format"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

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/indicator/func/search

试验场

授权

UserHttpBearer

变量

键

值

id

targetType*

admin

targetName

createdBy

createdDate

pageNo

pageSize

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

---