プロジェクト情報の更新

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

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://maiu.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 Required API処理結果コード
message String Required API処理結果メッセージ
result Object Required プロジェクトの詳細情報
result.projectId Integer Required プロジェクト ID
result.name String Required プロジェクト名
result.isBaseProject Boolean Required 基本プロジェクトかどうか
  • true | false
result.createdUserName String Required プロジェクトを作成したユーザー名
result.createdTime String Required プロジェクトの作成日時
  • ISO 8601形式
result.updatedUserName String Required プロジェクトを最後に更新したユーザー名
result.updatedTime String Required プロジェクトの最終更新日時
  • 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"
    }
}