Edit project
- Print
- PDF
Edit project
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Edit a SourcePipeline project.
Requests
API URL
PATCH {SOURCEPIPELINE_API_URL}/project/{projectId}
Request parameters
| Item | Type | Requirement status | Description | Remarks |
|---|---|---|---|---|
| projectId | string | Y | Project ID |
Request queries
None
Request bodies
{
"description": "string",
"tasks": [
{
"name": "string",
"type": "string",
"config": {
"projectId": "number",
"target": {
"info": {
"branch": "string"
}
}
},
"linkedTasks": ["string"]
}
],
"trigger": {
"repository": [
{
"type": "string",
"name": "string",
"branch": "string"
}
],
"sourcepipeline": [
{
"id" : "number"
}
],
"schedule": [
{
"day": ["string"],
"time": "string",
"timeZone": "string",
"scheduleOnlyWithChange" : "boolean"
}
],
}
}
| Item | Type | Requirement status | Description | Remarks |
|---|---|---|---|---|
| description | string | N | Project description | |
| tasks.name | string | Y | Task name | |
| tasks.type | string | Y | Task type | SourceBuild | SourceDeploy |
| tasks.config.projectId | number | Y | Task project ID | View with sourceBuildProjectList API View with sourceDeployProjectList API |
| tasks.config.stageId | number | N (Required if tasks.type = SourceDeploy) | SourceDeploy stage ID | View with sourceDeployStageList API |
| tasks.config.scenarioId | number | N (Required if tasks.type = SourceDeploy) | SourceDeploy scenario ID | View with sourceDeployScenarioList API |
| tasks.config.target.info.branch | string | N (Optional if tasks.type = SourceBuild) | Connection info - Branch | View with sourceCommitBranchList API |
| tasks.linkedTasks | string[] | Y | Preceding task. Name of the task to be executed beforehand | |
| trigger.repository.type | string | N (Required if trigger.repository exists) | Push trigger - Repository type | "sourcecommit" |
| trigger.repository.name | string | N (Required if trigger.repository exists) | Push trigger - Repository name | View with sourceCommitRepositoryList API |
| trigger.repository.branch | string | N (Required if trigger.repository exists) | Push trigger - Branch | View with sourceCommitBranchList API |
| trigger.sourcepipeline.id | number | N (Required if trigger.sourcepipeline exists) | Pipeline trigger - Pipeline ID | View with sourcePipelineProjectList API |
| trigger.schedule.day | string[] | N (Required if trigger.schedule exists) | Scheduled trigger - Day | "MON" | "TUE" | "WED"| "THU" | "FRI" | "SAT" | "SUN" |
| trigger.schedule.time | string | N (Required if trigger.schedule exists) | Scheduled trigger - Time | Enter in [HH:mm] format. Example: "13:10" |
| trigger.schedule.timeZone | string | N (Required if trigger.schedule exists) | Scheduled trigger - Time zone | View with sourcePipelineTimeZone API |
| trigger.schedule.scheduleOnlyWithChange | boolean | N (Required if trigger.schedule exists) | Scheduled trigger - Whether to execute on change |
Responses
Response bodies
{
"result": "boolean"
}
| Item | Type | Description | Remarks |
|---|---|---|---|
| result | boolean | Project change result |
Was this article helpful?