콘텐츠로 이동

수정



POST /api/v1/dashboard/carousel/{carousel_uuid}/modify

개요

기존 캐러셀의 이름, 대시보드 목록 및 재생 간격을 덮어씁니다.

호출 전 및 사용 단계

먼저 캐러셀 상세에서 기존 구성을 읽습니다. 제출할 때 세 필드를 모두 제공해야 하며, 기존 값을 유지하는 필드도 입력해야 합니다. API는 dashboardUUIDs로 기존 목록을 교체하며, 재생 순서는 새 배열에 따라 결정됩니다. 업데이트 후 다시 읽을 수 있습니다.

경로 파라미터

파라미터 이름 유형 필수 설명
carousel_uuid string Y 캐러셀 구성 UUID입니다.
예: csel_example
가져오기 또는 입력 방법: 동일한 워크스페이스 및 호출 자격 증명에서 캐러셀 목록의 content[].uuid에서 복사하거나, 생성 응답의 content.uuid를 사용할 수도 있습니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 유형 필수 설명
dashboardUUIDs array Y 비어 있지 않은 대시보드 UUID 배열입니다. 생성 및 수정 시 전달된 순서를 저장하며, 읽을 때 삭제되었거나 현재 워크스페이스에 없는 참조를 정리합니다.
null 허용: False
예: ["dsbd_example"]
가져오기 또는 입력 방법: 대시보드 목록 응답의 content.data[].uuid에서 값을 가져와 원하는 캐러셀 순서대로 입력합니다.
name string Y 새 캐러셀 이름이며 최대 256자입니다.
null 허용: False
최대 길이: 256
예: 生产巡检轮播
가져오기 또는 입력 방법: 기존 이름을 유지할 수 있으며, 이름을 변경할 경우 현재 자격 증명이 해당 워크스페이스의 다른 캐러셀에서 사용 중이 아닌 이름을 선택합니다.
intervalTime string Y 재생 간격 문자열이며 생성 및 수정 시 모두 제공해야 합니다.
null 허용: False
예: 30s
가져오기 또는 입력 방법: 원하는 재생 간격에 따라 프런트엔드에서 인식 가능한 문자열을 입력합니다(예: 30s).

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/dashboard/carousel/csel_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"dashboardUUIDs":["dsbd_example"],"name":"生产巡检轮播","intervalTime":"60s"}'

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.id integer 캐러셀 레코드의 내부 번호입니다.
content.uuid string 캐러셀 구성 UUID로, 상세 조회, 수정, 삭제에 사용됩니다.
content.accountUUID string 캐러셀이 속한 호출 자격 증명의 ID입니다.
content.workspaceUUID string 캐러셀이 속한 워크스페이스의 UUID입니다.
content.name string 캐러셀 이름입니다.
content.intervalTime string 저장된 캐러셀 재생 간격 문자열입니다.
content.dashboardUUIDs array<string> 저장된 대시보드 UUID로, 캐러셀 순서대로 정렬되어 있습니다.
content.status integer 레코드 상태입니다.
content.createAt number 생성 시간(Unix 초)입니다.
content.updateAt number 최근 업데이트 시간(Unix 초)입니다. 업데이트가 없으면 -1입니다.
content.deleteAt number 삭제 시간(Unix 초)입니다. 삭제되지 않았으면 -1입니다.
content.creator string 생성자 자격 증명 ID입니다.
content.updator string 최근 업데이트한 자격 증명 ID이며, 업데이트가 없으면 빈 문자열입니다.
content.declaration object 또는 null 워크스페이스의 공통 선언입니다.
{
  "code": 200,
  "content": {
    "id": 10,
    "uuid": "csel_example",
    "accountUUID": "wsak_example",
    "workspaceUUID": "wksp_example",
    "name": "生产巡检轮播",
    "intervalTime": "60s",
    "dashboardUUIDs": [
      "dsbd_example"
    ],
    "status": 0,
    "createAt": 1785427200,
    "updateAt": 1785427320,
    "deleteAt": -1,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하세요.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하세요.
406 ft.MissingParameters 캐러셀 이름, 대시보드 목록 또는 간격이 비어 있음 파라미터 누락 비어 있지 않은 이름, 비어 있지 않은 UUID 배열 및 비어 있지 않은 간격 문자열을 사용하세요.
404 ft.DashboardCarouselObjectNotExist 구성이 삭제되었거나 존재하지 않거나 현재 호출 자격 증명 및 워크스페이스에 속하지 않음 해당 캐러셀 객체가 존재하지 않습니다 동일한 Key로 캐러셀 목록에서 구성이 여전히 존재하는지 확인한 후 실제 UUID를 사용하세요.
400 ft.DashboardCarouselNameRepeat 현재 자격 증명에 이미 다른 동일한 이름의 캐러셀이 있거나, 동일한 이름 구성에 대한 동시 쓰기가 있음 해당 캐러셀 이름이 이미 존재합니다 기존 구성을 확인하세요. 동일한 이름의 구성이 이미 있으면 이름을 변경하거나 해당 구성을 직접 조작하고, 동일한 이름의 작업이 동시에 발생하면 이전 작업이 완료된 후 다시 시도하세요.

문서 평가

이 페이지가 도움이 되었나요?