获取效能洞察中指定企业的field表数据
接口说明
效能洞察数据导出 API 仅面向高级版客户开放,了解云效高级版功能,请前往 https://help.aliyun.com/document_detail/173288.html
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /organization/{organizationId}/data/fields HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| organizationId |
string |
是 |
企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/#{organizationId} |
61db9af2148974246bexxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 body |
|
| startTime |
string |
是 |
开始时间。和结束时间间隔不超过 1 年,格式为 YYYY-MM-DD HH:mm:ss。 |
2024-05-01 00:00:00 |
| endTime |
string |
是 |
结束时间。和开始时间间隔不超过 1 年,格式为 YYYY-MM-DD HH:mm:ss。 |
2024-06-01 00:00:00 |
| nextToken |
string |
否 |
下一页 token |
1 |
| maxResults |
integer |
否 |
最大结果条数 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| totalCount |
integer |
总条数 |
100 |
| nextToken |
string |
下一页 token,为 null 表示没有下一页 |
2 |
| maxResults |
integer |
返回条数 |
10 |
| result |
array<object> |
返回结果 |
|
|
object |
field |
||
| id |
integer |
记录自增 Id |
666666 |
| fieldId |
string |
字段 id,如自定义字段 Id 及标签 id |
9798551 |
| fieldName |
string |
字段名称 |
多选字段 |
| gmtCreate |
integer |
创建时间 |
1713752162000 |
| gmtModified |
integer |
更新时间 |
1714977502000 |
| identifier |
string |
废弃 |
field-444153 |
| isDeleted |
string |
是否删除(Y|N) |
N |
| isSystem |
string |
是否系统字段(Y|N) |
N |
| optionValue |
string |
字段可选值列表,如枚举有可选值 |
"[\"是\"]" |
| organizationId |
string |
企业 id |
61db9af2148974246bexxxx |
| targetId |
string |
字段适用对象 id, 如项目 id, 企业 id |
61db9af2148974246bexxxx |
| targetType |
string |
字段适用对象范围,如项目,企业等 |
organization |
| type |
string |
字段类型,如标签、枚举、文本、数值 |
string |
| position |
integer |
字段顺序 |
150 |
| scope |
string |
字段范围,space/global/system -> 项目内/全局/系统 |
global |
| source |
string |
字段来源系统,如 projex/teambition |
projex |
示例
正常返回示例
JSON格式
{
"totalCount": 100,
"nextToken": "2",
"maxResults": 10,
"result": [
{
"id": 666666,
"fieldId": "9798551",
"fieldName": "多选字段",
"gmtCreate": 1713752162000,
"gmtModified": 1714977502000,
"identifier": "field-444153",
"isDeleted": "N",
"isSystem": "N",
"optionValue": "\"[\\\"是\\\"]\"",
"organizationId": "61db9af2148974246bexxxx",
"targetId": "61db9af2148974246bexxxx",
"targetType": "organization",
"type": "string",
"position": 150,
"scope": "global",
"source": "projex"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。