huawei-cloud-api-definitions-CodeCraft 0.1.20240402

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"Error":{"description":"接口返回异常信息","properties":{"error_code":{"description":"异常错误码","type":"string"},"error_msg":{"description":"异常错误描述","type":"string"}},"required":["error_code","error_msg"]},"ListWorksResponseModel":{"properties":{"domain_id":{"description":"租户ID","example":"8624ae47cdc646e49e3fed2562c876e4","maxLength":50,"minLength":1,"type":"string"},"team_id":{"description":"团队ID","example":"2288803","maxLength":10,"minLength":1,"type":"string"},"works_id":{"description":"作品ID","example":"4056012","maxLength":10,"minLength":1,"type":"string"}},"required":["works_id","domain_id","team_id"],"title":"ListWorksResponseModel","type":"object"},"ListWorksResponseModelList":{"properties":{"total":{"description":"作品总数","example":1,"maximum":9999,"minimum":1,"type":"integer"},"works":{"description":"作品列表","items":{"$ref":"#/definitions/ListWorksResponseModel"},"maxItems":100,"minItems":1,"type":"array"}},"required":["works","total"],"type":"object"}},"description":null,"group_id":"af68f2651886492cad04cddb8f2f3129","host":"codecraft.cn-north-4.myhuaweicloud.com","id":"23c965d370504f92a13cb297b28a4358","info_version":"v5","method":"get","name":"ListCompetitionWorks","parameters":{},"paths":{"/v5/competitions/works":{"get":{"deprecated":false,"description":"第三方服务获取某个大赛某个阶段中一段时间内提交的作品信息。其中以请求参数read_time作为结束时间,定义向前一天或一小时内的时间作为查询范围","operationId":"ListCompetitionWorks","parameters":[{"description":"第三方token,需要平台配置账号权限","in":"header","maxLength":99999,"minLength":1,"name":"x-auth-token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvIIDgzCCXXXXXX..."},{"description":"要查询的大赛ID,由大赛平台提供","format":"int32","in":"query","maximum":2147483647,"minimum":1,"name":"competition_id","required":true,"type":"integer","x-example":1200922751},{"description":"要查询的大赛阶段ID,由大赛平台提供","format":"int32","in":"query","maximum":2147483647,"minimum":1,"name":"stage_id","required":true,"type":"integer","x-example":1001},{"description":"查询的截止时间","in":"query","maxLength":30,"minLength":19,"name":"read_time","required":true,"type":"string","x-example":"2021-05-20 13:45:30"},{"allowEmptyValue":true,"default":"day","description":"查询的时间范围。day表示以read_time作为结束时间,前一天内作为查询范围,hour表示以read_time作为结束时间,前一小内时作为查询范围。","enum":["day","hour"],"in":"query","maxLength":10,"minLength":0,"name":"time_unit","required":false,"type":"string","x-example":"hour"},{"description":"作品记录的起始编号,如果不传默认从0开始,offset为0时表示从第一条记录开始","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer","x-example":1},{"description":"每页包含的作品记录数,如果不传默认返回100条,并且返回最大条数为100","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":1},{"description":"需要排序的字段,只支持works_id字段,如果不传则不进行排序","in":"query","maxLength":10,"minLength":0,"name":"sort_key","required":false,"type":"string","x-example":"works_id"},{"allowEmptyValue":true,"default":"asc","description":"排序类型,支持asc|desc,默认为asc升序","enum":["asc","desc"],"in":"query","maxLength":10,"minLength":0,"name":"sort_dir","required":false,"type":"string","x-example":"desc"}],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"查询成功","examples":{"application/json":"{\n  \"works\": [\n    {\n      \"works_id\": \"4056012\",                                 //说明:作品ID\n      \"domain_id\": \"8624ae47cdc646e49e3fed2562c876e4\",       //说明:大赛ID\n      \"team_id\": \"2288803\"                                   //说明:团队ID\n    }\n  ],\n  \"total\": 1\n}"},"schema":{"$ref":"#/definitions/ListWorksResponseModelList"}},"400":{"description":"该时间段没有可判题的作品","examples":{"application/json":{"error_code":"CC.0005","error_msg":"该时间段没有可判题的作品"}},"schema":{"$ref":"#/definitions/Error"}},"403":{"description":"用户无权操作","examples":{"application/json":{"error_code":"CC.0001","error_msg":"用户无权操作"}},"schema":{"$ref":"#/definitions/Error"}}},"summary":"获取指定时间内选手提交的作品","tags":["作品管理"],"x-apigateway-backend":{"httpEndpoints":{"address":"#address#","method":"GET","path":"/CompetitionService/v5/competitions/works","scheme":"https","timeout":30000}},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-request-type":"public","x-is-registered":"Y","x-name":"获取一段时间内提交的作品","x-request-examples-description-1":"正常请求-返回200","x-request-examples-description-2":"异常请求,返回错误码error_code=CC.0005,该时间段没有可判题的作品","x-request-examples-text-1":"GET https://{endpoint}/v5/competitions/works?competition_id=10000001&stage_id=1001&read_time=2021-05-30 12:20:20&time_unit=day&offset=0&limit=5&sort_key=works_id&sort_dir=desc","x-request-examples-text-2":"GET https://{endpoint}/v5/competitions/works?competition_id=10000001&stage_id=1001&read_time=2022-05-30 12:20:20&time_unit=day&offset=0&limit=5&sort_key=works_id&sort_dir=desc","x-request-examples-url-1":"GET https://{endpoint}/v5/competitions/works?competition_id=10000001&stage_id=1001&read_time=2021-05-30 12:20:20&time_unit=day&offset=0&limit=5&sort_key=works_id&sort_dir=desc","x-request-examples-url-2":"GET https://{endpoint}/v5/competitions/works?competition_id=10000001&stage_id=1001&read_time=2022-05-30 12:20:20&time_unit=day&offset=0&limit=5&sort_key=works_id&sort_dir=desc","x-support-sdk":"Y","x-version":"v5"}}},"product_short":"CodeCraft","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取指定时间内选手提交的作品","tags":"作品管理","uri":null,"version":"2.0"}