콘텐츠로 이동

생성



POST /api/v1/dashboard/carousel/add

개요

입력 순서대로 대시보드 캐러셀 구성을 하나 생성합니다.

호출 전 및 사용 단계

먼저 대시보드 목록에서 필요한 대시보드 UUID가 있는지 확인합니다. 세 가지 Body 필드는 모두 입력해야 합니다. 서버는 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/add' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"dashboardUUIDs":["dsbd_example"],"name":"生产巡检轮播","intervalTime":"30s"}'

응답

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": "30s",
    "dashboardUUIDs": [
      "dsbd_example"
    ],
    "status": 0,
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "creator": "wsak_example",
    "updator": "",
    "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 배열 및 비어 있지 않은 간격 문자열을 사용합니다.
400 ft.DashboardCarouselNameRepeat 현재 주체에 동일한 이름의 캐러셀이 이미 있거나 동일한 이름의 구성이 생성 또는 수정 중임 해당 캐러셀 이름이 이미 존재합니다. 기존 구성을 확인합니다. 동일한 이름의 구성이 이미 있으면 이름을 변경하거나 해당 구성을 직접 조작하고, 동일한 이름의 작업이 동시에 발생하면 이전 작업이 완료된 후 다시 시도합니다.

문서 평가

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