Creating a Requirement Plan
Function
This API is used to create a requirement plan.
Calling Method
For details, see Calling APIs.
URI
POST /v3/plan/{project_id}/management
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: Regular expression: [A-Za-z0-9]{32} Options: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition: Group name. Constraints: N/A Options: N/A Default value: N/A |
type |
Yes |
String |
Definition: Plan type. Constraints: N/A Value range: gantt (Gantt chart) mind (mind map) Default value: mind |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Plan list. |
status |
String |
Definition: Processing status of a request. Value range: success: successful error: failed |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Plan ID. Value range: N/A |
name |
String |
Definition: Plan title. Value range: N/A |
type |
String |
Definition: Plan type. Value range: gantt (Gantt chart) mind (mind map) |
project_id |
String |
Definition: Project ID. Value range: N/A |
creator |
creator object |
Definition: Creator information. |
Parameter |
Type |
Description |
---|---|---|
user_id |
String |
Definition: User ID of the creator. Value range: N/A |
domain_id |
String |
Definition: Tenant ID. Value range: N/A |
nick_name |
String |
Definition: Creator alias. Value range: N/A |
first_name |
String |
Definition: Username of the creator. Value range: N/A |
Example Requests
{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/management { "name" : "test", "type" : "gantt" }
Example Responses
Status code: 200
Creates a requirement plan response.
{ "result" : { "id" : "bf56512ab4e544c29d03d068711ca56a", "name" : "test", "type" : "gantt", "project_id" : "919bb351ef424e2daaf3dd80c179fae9", "creator" : { "user_id" : "a360371833bf4c558f796fd707b44daf", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "nick_name" : "Sam", "first_name" : "devcloud_devcloud_s00404480_01" } }, "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
Creates a requirement plan response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot