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

VPC環境で利用できます。

ワークスペースのプロジェクトリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/workspaces/{workspace_name}/projects

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名

リクエスト例

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

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	APIリターン情報
`result.projects`	Array	-	プロジェクトリスト: projects
`totalCount`	Integer	-	プロジェクトの総数

`projects`

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

フィールド	タイプ	必須の有無	説明
`projectId`	Integer	-	プロジェクト ID
`name`	String	-	プロジェクト名
`isBaseProject`	Boolean	-	基本プロジェクトかどうか `true` \| `false`
`createdUserName`	String	-	プロジェクトを作成したユーザー名
`createdTime`	String	-	プロジェクトの作成日時 ISO 8601形式
`updatedUserName`	String	-	プロジェクトを最後に更新したユーザー名
`updatedTime`	String	-	プロジェクトの最終更新日時 ISO 8601形式

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

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

レスポンス例

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

{
    "code": "0",
    "message": "success",
    "result": {
        "projects": [
            {
                "projectId": 1001,
                "name": "project_one",
                "isBaseProject": true,
                "createdUserName": "user1",
                "createdTime": "2025-04-23T13:56:56",
                "updatedUserName": "user1",
                "updatedTime": "2025-04-23T13:56:56"
            },
            {
                "projectId": 1002,
                "name": "project_two",
                "isBaseProject": false,
                "createdUserName": "user2",
                "createdTime": "2025-04-23T14:34:56",
                "updatedUserName": "user2",
                "updatedTime": "2025-04-23T14:34:56"
            },
            {
                "projectId": 1003,
                "name": "project_three",
                "isBaseProject": false,
                "createdUserName": "user3",
                "createdTime": "2025-04-23T14:12:48",
                "updatedUserName": "user3",
                "updatedTime": "2025-04-23T14:12:48"
            }
        ],
        "totalCount": 3
    }
}