プロジェクトの修正
- 印刷する
- PDF
プロジェクトの修正
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
SourcePipelineプロジェクトを修正します。
リクエスト
API URL
PATCH {SOURCEPIPELINE_API_URL}/project/{projectId}
リクエスト Parameter
| 項目 | タイプ | 要否 | 説明 | 備考 |
|---|---|---|---|---|
| projectId | string | Y | プロジェクト ID |
リクエスト Query
なし
リクエスト Body
{
"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"
}
],
}
}
| 項目 | タイプ | 要否 | 説明 | 備考 |
|---|---|---|---|---|
| description | string | N | プロジェクトの説明 | |
| tasks.name | string | Y | タスク名 | |
| tasks.type | string | Y | タスクタイプ | SourceBuild | SourceDeploy |
| tasks.config.projectId | number | Y | タスクのプロジェクト ID | sourceBuildProjectList APIで照会 sourceDeployProjectList APIで照会 |
| tasks.config.stageId | number | N (tasks.type = SourceDeployの場合、必須) | SourceDeploy stage ID | sourceDeployStageList APIで照会 |
| tasks.config.scenarioId | number | N (tasks.type = SourceDeployの場合、必須) | SourceDeploy scenario ID | sourceDeployScenarioList APIで照会 |
| tasks.config.target.info.branch | string | N (tasks.type = SourceBuildの場合、任意入力) | 関連付け情報 - ブランチ | sourceCommitBranchList APIで照会 |
| tasks.linkedTasks | string[] | Y | 先行タスク。事前に実行するタスク名 | |
| trigger.repository.type | string | N (trigger.repositoryがある場合、必須) | Pushトリガー - リポジトリタイプ | "sourcecommit" |
| trigger.repository.name | string | N (trigger.repositoryがある場合、必須) | Pushトリガー - リポジトリ名 | sourceCommitRepoisotryList APIで照会 |
| trigger.repository.branch | string | N (trigger.repositoryがある場合、必須) | Pushトリガー - ブランチ | sourceCommitBranchList APIで照会 |
| trigger.sourcepipeline.id | number | N (trigger.sourcepipelineがある場合、必須) | パイプライントリガー - パイプライン ID | sourcePipelineProjectList APIで照会 |
| trigger.schedule.day | string[] | N (trigger.scheduleがある場合、必須) | 予約トリガー - 曜日 | "MON" | "TUE" | "WED"| "THU" | "FRI" | "SAT" | "SUN" |
| trigger.schedule.time | string | N (trigger.scheduleがある場合、必須) | 予約トリガー - 時間 | [HH:mm] 形式で入力。例: "13:10" |
| trigger.schedule.timeZone | string | N (trigger.scheduleがある場合、必須) | 予約トリガー - タイムゾーン | sourcePipelineTimeZone APIで照会 |
| trigger.schedule.scheduleOnlyWithChange | boolean | N (trigger.scheduleがある場合、必須) | 予約トリガー - 変更時の実行有無 |
レスポンス
レスポンス Body
{
"result": "boolean"
}
| 項目 | タイプ | 説明 | 備考 |
|---|---|---|---|
| result | boolean | プロジェクト変更の結果 |
この記事は役に立ちましたか?