プロジェクト情報の更新

VPC環境で利用できます。

ワークスペースのプロジェクト情報を更新します。基本プロジェクトは情報を更新できません。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名
`project_id`	String	Required	プロジェクト ID プロジェクトリストの照会を参照

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	プロジェクト名英数字、記号を組み合わせて100文字以内で入力セミコロン(`;`)、バーティカルバー(`\|`)、バッククォート(`)は使用不可ワークスペース内では重複不可

リクエスト例

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

curl --location --request PATCH 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234' \
--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' \
--data '{
    "name": "updated_project_name"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	プロジェクトの詳細情報
`result.projectId`	Integer	-	プロジェクト ID
`result.name`	String	-	プロジェクト名
`result.isBaseProject`	Boolean	-	基本プロジェクトかどうか `true` \| `false`
`result.createdUserName`	String	-	プロジェクトを作成したユーザー名
`result.createdTime`	String	-	プロジェクトの作成日時 ISO 8601形式
`result.updatedUserName`	String	-	プロジェクトを最後に更新したユーザー名
`result.updatedTime`	String	-	プロジェクトの最終更新日時 ISO 8601形式

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

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

レスポンス例

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

{
    "code": "0",
    "message": "success",
    "result": {
        "projectId": 1234,
        "name": "updated_project_name",
        "isBaseProject": false,
        "createdUserName": "username",
        "createdTime": "2025-04-23T14:15:20",
        "updatedUserName": "username",
        "updatedTime": "2025-04-23T15:45:04.680736168"
    }
}