프로젝트 정보 수정

Prev Next

VPC 환경에서 이용 가능합니다.

워크스페이스 내 프로젝트의 정보를 수정합니다. 기본 프로젝트는 정보를 수정할 수 없습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PATCH /api/v1/workspaces/{workspace_name}/projects/{project_id}

요청 헤더

Media AI Understanding API 에서 공통으로 사용하는 헤더에 대한 정보는 Media AI Understanding 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
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 AI Understanding API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Media AI Understanding 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "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"
    }
}