项目详情
项目详情
1. 描述
获取项目详情。
2. 请求地址
请求地址的格式如下:
https://api.yovole.com/v1/project/detail
3. 请求参数
参数名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
projectSn | String | 是 | 项目编号 |
4. 请求示例
4.1. 请求地址
POST https://api.yovole.com/v1/project/detail HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=
4.2. 接口请求参数
{
"projectSn":"PRJ-019DS"
}
5. 返回结果
5.1. 返回正确结果示例
{
"requestId": "4416235a-e9c0-453f-823a-ad491ebd74ab",
"success": true,
"code":200,
"message": null,
"model": {
"id": "acc230b7-d36f-11e8-88a8-fa163ebc68d3",
"sn": "PRJ-019DS",
"name": "测试项目",
"color": "project-color-1"
}
}
5.2. 返回错误结果示例
{
"requestId": "627f35ac-178e-4aaf-a283-4130bfa6cc89",
"success": false,
"code": 403,
"message": "permission denied",
"errorCode": "PermissionDenied"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码,错误码信息和简单的错误分析方法可以参考公共错误码。