SourceBuildプロジェクトリストの照会

Prev Next

Classic/VPC環境で利用できます。

使用可能な SourceBuildプロジェクトリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/sourcebuild/project

リクエストヘッダ

SourcePipeline APIで共通して使用されるヘッダの詳細は、SourcePipelineのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pageNo Number Optional ページ番号
  • 1~N
  • pageSize入力時、必ず入力
pageSize Number Optional ページごとの項目数
  • 1~N
  • pageNo入力時、必ず入力
searchWord String Optional 検索キーワード
  • プロジェクト名が完全一致または一部一致する値を絞り込み

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://vpcsourcepipeline.apigw.ntruss.com/api/v1/sourcebuild/project' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result Object - レスポンス結果
result.projectList Array - ビルドプロジェクトリスト

projectList

projectListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
id Number - ビルドプロジェクト ID
name String - ビルドプロジェクト名
source Object - ビルド対象の情報
source.type String - ビルド対象
  • SourceCommit | GitHub | BitBucket
source.workspace Object - Bitbucketワークスペース情報
  • source.typeがBitbucketの場合、下位情報を含めて表示
source.workspace.id Number - Bitbucketワークスペース ID
source.workspace.name String - Bitbucketワークスペース名
source.repository String - リポジトリ名
source.branch String - ブランチ名

レスポンスステータスコード

SourcePipeline APIで共通して使用されるレスポンスステータスコードの詳細は、SourcePipelineのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": {
        "projectList": [
            {
                "id": 20***,
                "name": "build1",
                "source": {
                    "type": "SourceCommit",
                    "repository": "rep1",
                    "branch": "master"
                }
            }
        ]
    }
}