수정¶
POST /api/v1/channel/{channel_uuid}/modify
개요¶
지정한 채널의 이름, 설명, 알림 대상 또는 에스컬레이션 설정을 부분적으로 업데이트합니다.
호출 전 및 사용 단계¶
먼저 채널 간략 목록에서 대상 UUID와 기존 설정을 복사합니다. 생략한 필드는 현재 값을 유지하며, 알림 배열이나 에스컬레이션 객체를 전달하면 해당 필드가 전체 교체됩니다. 기본 채널은 원래 이름을 유지하지만 설명과 알림 설정은 조정할 수 있습니다. 에스컬레이션 알림을 비활성화하려면 triggerTime=0, notifyTarget=[]을 제출하세요. 하위 필드가 없는 빈 객체는 사용하지 마세요. 채널과 에스컬레이션 트리거 설정은 단계별로 저장됩니다. 타임아웃이나 오류가 발생하면 먼저 채널 상태를 조회한 뒤 재시도할 필드를 결정하여 중복 생성을 방지하세요. 에스컬레이션 알림은 규칙을 활성화하거나 업데이트한 후 새로 생성되었고, 아직 종료되지 않았으며 담당자가 없는 Issue를 대상으로 합니다. triggerTime을 초과하면 스케줄러 작업이 확인하며, 정확한 카운트다운은 아닙니다. 또한 현재 작업은 워크스페이스에 유효한 담당자 없음 에스컬레이션 알림 정책이 있어야 동작합니다. 메시지를 받지 못한 경우 알림 정책, 알림 대상 및 사이트 작업 스위치를 확인하세요.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| channel_uuid | string | Y | 현재 워크스페이스의 채널 UUID입니다. 예시: chan_example획득 또는 입력 방법: 채널 간략 목록의 content[].uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| notifyTarget[*] | string | 단일 알림 대상 UUID입니다. 예시: notify_example획득 또는 입력 방법: 알림 대상 목록으로 동일한 워크스페이스에 설정된 알림 대상을 조회하고 content.data[].uuid를 가져옵니다. |
|
| notifyUpgradeCfg.notifyTarget[*] | string | 단일 에스컬레이션 알림 대상 UUID입니다. 예시: notify_example획득 또는 입력 방법: 알림 대상 목록으로 동일한 워크스페이스에 설정된 알림 대상을 조회하고 content.data[].uuid를 가져옵니다. |
|
| description | string | 채널 설명이며 최대 256자입니다. 빈 문자열 허용: True null 허용: False 최대 길이: 256 예시: 생산 이상 협업 채널획득 또는 입력 방법: 채널 용도에 맞게 입력하며, 빈 문자열을 전달하면 비울 수 있습니다. |
|
| name | string | 채널 이름이며 최대 256자입니다. null 허용: False 최대 길이: 256 예시: 생산 이상획득 또는 입력 방법: 채널 간략 목록에서 기존 이름을 확인한 뒤 이 워크스페이스에서 사용되지 않는 이름을 선택합니다. |
|
| notifyTarget | array | 전체 알림 대상 UUID 배열이며, []를 전달하면 설정이 비워집니다. null 허용: False 예시: ["notify_example"]획득 또는 입력 방법: 알림 대상 목록으로 동일한 워크스페이스에 설정된 알림 대상을 조회하고 content.data[].uuid를 가져옵니다. |
|
| notifyUpgradeCfg | json | 전체 에스컬레이션 알림 설정입니다. 이 객체를 전달하는 경우 triggerTime과 notifyTarget을 반드시 함께 제공해야 합니다. null 허용: False 예시: {"triggerTime": 300, "notifyTarget": ["notify_example"]}획득 또는 입력 방법: 업무 대기 시간에 따라 초 단위를 선택하고 실제 알림 대상 UUID를 사용합니다. |
|
| notifyUpgradeCfg.notifyTarget | array | 조건부 필수 | 전체 에스컬레이션 알림 대상 UUID 목록입니다. triggerTime=0과 조합하여 비활성화에 사용합니다. null 허용: False 예시: ["notify_example"]획득 또는 입력 방법: 알림 대상 목록으로 동일한 워크스페이스에 설정된 알림 대상을 조회하고 content.data[].uuid를 가져옵니다. |
| notifyUpgradeCfg.triggerTime | integer | 조건부 필수 | 에스컬레이션 알림을 기다리는 초 수입니다. 0이 아니면 규칙을 활성화하기 위해 알림 대상이 최소 하나 더 필요합니다. null 허용: False 예시: 300획득 또는 입력 방법: 양의 정수 초를 입력하며, 예를 들어 300은 5분 대기를 의미합니다. 비활성화 시에는 빈 notifyTarget 배열과 함께 0을 전달합니다. |
파라미터 추가 설명¶
알림 대상 목록과 에스컬레이션 설정은 동시에 제출할 필요가 없습니다. 설명만 조정할 때는 나머지 두 필드를 생략하면 됩니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/channel/chan_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"description":"생산 이상 처리 및 에스컬레이션 협업"}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 데이터베이스 레코드 번호입니다. 채널 작업에는 uuid를 사용하세요. |
| content.uuid | string | 채널 UUID이며, 수정, 삭제 또는 구독에 사용합니다. |
| content.workspaceUUID | string | 채널이 속한 워크스페이스입니다. |
| content.name | string | 채널 이름입니다. default는 기본 채널을 의미합니다. |
| content.description | string | 채널 설명입니다. |
| content.notifyTarget | array<string> |
해당 채널에 직접 설정된 알림 대상 UUID입니다. |
| content.notifyTarget[] | string | 단일 알림 대상 UUID입니다. |
| content.notifyUpgradeCfg | object | 에스컬레이션 알림 설정이며, 설정되지 않은 경우 빈 객체입니다. |
| content.notifyUpgradeCfg.triggerTime | integer | 에스컬레이션 알림을 트리거하는 대기 시간(초)입니다. |
| content.notifyUpgradeCfg.notifyTarget | array<string> |
에스컬레이션 알림 대상 UUID 목록입니다. |
| content.notifyUpgradeCfg.notifyTarget[] | string | 에스컬레이션 알림 대상 UUID입니다. |
| content.status | integer | 레코드 상태이며 정상일 때 0입니다. |
| content.creator | string | 생성을 호출한 주체입니다. |
| content.updator | string | 최근 업데이트 주체이며, 업데이트가 없으면 빈 문자열일 수 있습니다. |
| content.createAt | integer | 생성 시간, Unix 초입니다. |
| content.updateAt | integer | 업데이트 시간, Unix 초이며 업데이트가 없으면 -1입니다. |
| content.deleteAt | integer | 삭제 시간, Unix 초이며 삭제되지 않았으면 -1입니다. |
| content.declaration | object 또는 null | 워크스페이스의 공용 선언입니다. |
{
"code": 200,
"content": {
"id": 42,
"uuid": "chan_example",
"workspaceUUID": "wksp_example",
"name": "생산 이상",
"description": "생산 이상 처리 및 에스컬레이션 협업",
"notifyTarget": [
"notify_example"
],
"notifyUpgradeCfg": {
"triggerTime": 300,
"notifyTarget": [
"notify_example"
]
},
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427260,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 필드 유형, 길이, 열거형 또는 필드 이름이 선언을 위반함 | 파라미터 파싱 실패 | 파라미터 표에 따라 요청을 확인하고, 에스컬레이션 설정에는 두 개의 하위 필드를 제공합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 단일 JSON 객체를 전달합니다. |
| 404 | ft.NotFoundChannel | 대상 채널이 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 속하지 않음 | 지정한 채널을 찾을 수 없음 | 채널 간략 목록에서 유효한 UUID를 다시 가져옵니다. |
| 400 | ft.ChannelNameRepeat | 대상 이름이 다른 활성 채널에서 이미 사용 중임 | 채널 이름 중복 | 이 워크스페이스에서 사용되지 않는 채널 이름을 선택합니다. |