概要

SourcePipelineプロジェクトの詳細情報を照会します。

リクエスト

API URL

GET  {SOURCEPIPELINE_API_URL}/project/{projectId}

リクエスト Parameter

項目	タイプ	必須有無	説明	備考
projectId	string	Y	プロジェクト ID	projectList APIで照会

リクエスト Query

なし

リクエスト Body

なし

レスポンス

レスポンス Body

{
    "id": "number",
    "name": "string",
    "description": "string",
    "tasks": [
        {
            "id": "number",
            "name": "string",
            "type": "string",
            "config": {
                "projectId": "number",
                "target": {
                    "type": "string",
                    "name": "string",
                    "info": {
                        "repository": "string",
                        "branch": "string"
                    }
                }
            },
            "linkedTasks": ["string"]
        }
    ],
    "trigger": {
        "repository": [
            {
                "type": "string",
                "name": "string",
                "branch": "string"
            }
        ],
        "sourcepipeline": [
            {
                "id" : "number",
                "name" : "string"
            }
        ],
        "schedule": [
            {
                "day": ["string"],
                "time": "string",
                "timeZone": "string",
                "scheduleOnlyWithChange" : "boolean"
            }
        ],
    }
}

項目	タイプ	説明	備考
id	number	プロジェクト ID
name	string	プロジェクト名
description	string	プロジェクトの説明
tasks.id	number	タスク ID
tasks.name	string	タスク名
tasks.type	string	タスクタイプ	SourceBuild, SourceDeploy
tasks.linkedTasks	string[]	先行タスク。事前に実行するタスク名
tasks.config.projectId	number	タスクのプロジェクト ID	required both type SourceBuild and SourceDeploy
tasks.config.stageId	number	SourceDeploy stage ID	required if tasks.type is SourceDeploy
tasks.config.scenarioId	number	SourceDeploy scenario ID	required if tasks.type is SourceDeploy
tasks.config.target.type	string	関連付け情報のタイプ	SourceCommit, GitHub, Bitbucket, Github Enterprise Server, SourceBuild, ObjectStorage, KubernetesService
tasks.config.target.name	string	関連付け情報のプロジェクト名	required if tasks.config.target.type is SourceBuild
tasks.config.target.info.repository	string	関連付け情報 - リポジトリ	required if tasks.config.target.type is SourceCommit
tasks.config.target.info.branch	string	関連付け情報 - ブランチ	required if tasks.config.target.type is SourceCommit
tasks.config.target.info.workspace.id	string	関連付け情報 - Bitbucket workspace id	required if tasks.config.target.type is Bitbucket
tasks.config.target.info.workspace.name	string	関連付け情報 - Bitbucket workspace名	required if tasks.config.target.type is Bitbucket
tasks.config.target.info.authType	string	関連付け情報 - Github Enterprise Serverのログインタイプ	require id tasks.config.target.type is Github Enterprise Server
tasks.config.target.info.url	string	関連付け情報 - Github Enterprise Server Repository URL	require id tasks.config.target.type is Github Enterprise Server and tasks.config.target.info.authType is ssh
tasks.config.target.info.serverUrl	string	関連付け情報 - Github Enterprise Server URL	require id tasks.config.target.type is Github Enterprise Server and tasks.config.target.info.authType is OAuth, Personal Access Token, Username/Password
tasks.config.target.info.owner	string	関連付け情報 - Github Enterprise Serverの所有者	require id tasks.config.target.type is Github Enterprise Server
tasks.config.target.info.projectName	string	関連付け情報 - ビルドプロジェクト名	required if tasks.config.target.type is SourceBuild
tasks.config.target.info.file	string	関連付け情報 - オブジェクトストレージファイル名(パスを含む)	required if tasks.config.target.type is ObjectStorage
tasks.config.target.info.manifest	string	関連付け情報 - NKS manifestファイル	required if tasks.config.target.type is KubernetesService
tasks.config.target.info.fullManifest	string	関連付け情報 - NKS manifestファイルリスト	required if tasks.config.target.type is KubernetesService
trigger.repository.type	string	Pushトリガー - リポジトリタイプ	"sourcecommit"
trigger.repository.name	string	Pushトリガー - リポジトリ名
trigger.repository.branch	string	Pushトリガー - ブランチ
trigger.sourcepipeline.id	number	パイプライントリガー - パイプライン ID
trigger.sourcepipeline.name	string	パイプライントリガー - パイプライン名
trigger.schedule.day	string[]	予約トリガー - 曜日	"MON" \| "TUE" \| "WED"\| "THU" \| "FRI" \| "SAT" \| "SUN"
trigger.schedule.time	string	予約トリガー - 時間
trigger.schedule.timeZone	string	予約トリガー - タイムゾーン
trigger.schedule.scheduleOnlyWithChange	boolean	予約トリガー - 変更時の実行有無

この記事は役に立ちましたか?

概要
リクエスト
レスポンス
- レスポンス Body

タグ

SourcePipeline