생성¶
POST /api/v1/notify_object/create
개요¶
워크스페이스 알림 대상 및 알림 설정을 생성합니다.
호출 전 및 사용 단계¶
알림 방식에 따라 type과 optSet을 선택합니다. mailGroup/sms/vms는 멤버 또는 팀 UUID를 사용하고, 봇은 플랫폼에서 webhook을 가져옵니다. HTTP 콜백은 url을 사용합니다. 저장 성공은 알림 설정이 저장되었다는 것만 의미하며, 봇 또는 HTTP 수신 측이 알림을 수신했음을 의미하지 않습니다. 예시 주소는 반드시 실제 사용 가능한 주소로 변경해야 합니다. 생성 후 uuid를 알림 정책에 사용할 수 있습니다. 중복 생성 시 이름 중복으로 실패하며, 시간 초과 후에는 먼저 목록으로 확인하세요.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| permissionSet[*] | string | 단일 역할, 멤버 또는 팀 식별 문자열입니다. *는 객체 수준 작업 제한을 해제함을 의미하며, 여전히 API 인증을 통과해야 합니다. 예시: wsAdmin가져오기 또는 입력 방법: 멤버는 워크스페이스 멤버 목록의 계정 UUID를, 팀은 멤버 그룹 목록의 group_ UUID를, 역할은 역할 목록의 역할 UUID 또는 기존 역할 식별자(예: wsAdmin)를 사용합니다. 표시 이름을 입력하지 마세요. |
|
| optSet.webhook | string | 봇, Slack, Teams, Google Chat, Jira 및 ServiceNow에서 사용하는 콜백 주소입니다. Jira/ServiceNow는 유효한 HTTPS여야 하며 URL 사용자 비밀번호, 프래그먼트 또는 공백을 포함할 수 없습니다. 주소는 사이트 도메인 확인 및 인트라넷 정책의 영향을 받습니다. 예시: https://hooks.example.com/notify가져오기 또는 입력 방법: 대상 플랫폼의 봇, Workflow, Jira 또는 ServiceNow 통합 설정에서 콜백 주소를 가져옵니다. |
|
| optSet.secret | string | dingTalkRobot/feishuRobot의 선택적 서명 키입니다. Jira는 auth_type=secret일 때 반드시 제공해야 합니다. Jira 동일 ID로 업데이트할 때는 생략하여 유지할 수 있으며, 다른 봇은 optSet을 교체할 때 다시 포함해야 합니다. 예시: <robot-or-jira-secret>가져오기 또는 입력 방법: DingTalk/Lark 봇의 서명 설정에서 가져오거나 Jira 수신 측 규칙에 따라 설정합니다. |
|
| optSet.url | string | HTTPRequest/simpleHTTPRequest의 필수 비어 있지 않은 콜백 주소이며, 도메인 확인 및 인트라넷 정책의 영향을 받습니다. 예시: https://receiver.example.com/alerts가져오기 또는 입력 방법: 알림 HTTP 요청을 수신할 수 있는 실제 서비스 주소를 준비합니다. |
|
| optSet.to | array<string> |
mailGroup, sms, vms의 수신 멤버/팀 UUID 배열입니다. 멤버 프로필에 해당 이메일 또는 휴대폰 번호가 설정되어 있어야 하며, 임의의 이메일/휴대폰 번호 문자열 배열이 아닙니다. 예시: ["acnt_example"]가져오기 또는 입력 방법: 멤버 목록 또는 멤버 그룹 목록에서 UUID를 가져옵니다. |
|
| optSet.to[*] | string | 단일 멤버 또는 팀 UUID입니다. 예시: acnt_example가져오기 또는 입력 방법: 워크스페이스 멤버 목록 또는 멤버 그룹 목록에서 멤버/팀 UUID를 복사합니다. |
|
| optSet.refMembers | array<string> |
HTTPRequest/simpleHTTPRequest 모두 문자열 배열을 받아 검증하지만, 현재 HTTPRequest만 실제로 refMembersInfo로 확장되어 콘텐츠 파싱에 참여하며 simpleHTTPRequest는 이 확장을 수행하지 않습니다. 예시: ["acnt_example"]가져오기 또는 입력 방법: 워크스페이스 멤버 목록 또는 멤버 그룹 목록에서 연결할 멤버/팀 UUID를 선택합니다. |
|
| optSet.refMembers[*] | string | 연결된 멤버 또는 팀 UUID 문자열입니다. 예시: acnt_example가져오기 또는 입력 방법: 워크스페이스 멤버 목록 또는 멤버 그룹 목록에서 계정/팀 UUID를 복사합니다. |
|
| optSet.headersConfig | object | 사용자 지정 요청 헤더 설정입니다. Jira/ServiceNow의 headers와 다릅니다. 읽기 API는 민감한 값을 복원하므로, 반환 데이터를 저장 전에 안전하게 처리해야 합니다. 예시: {"isOpen": true, "items": [{"key": "X-Notify-Source", "value": "guance", "isSensitive": false}]}가져오기 또는 입력 방법: HTTP 수신 서비스 규칙에 따라 입력하며, HTTPRequest/simpleHTTPRequest에만 적용됩니다. |
|
| optSet.headersConfig.isOpen | boolean | 설정이 존재할 때는 반드시 불리언 값을 제공해야 하며, true일 때만 사용자 지정 헤더를 전송합니다. 예시: true가져오기 또는 입력 방법: 사용자 지정 요청 헤더를 활성화하려면 true, 비활성화하려면 false를 사용합니다. |
|
| optSet.headersConfig.items | array<object> |
설정이 존재할 때 반드시 배열을 전달해야 하며 최대 50개 항목입니다. isOpen=false여도 항목을 검증합니다. 예시: [{"key": "X-Notify-Source", "value": "guance", "isSensitive": false}]가져오기 또는 입력 방법: 수신 측 요구에 따라 요청 헤더 목록을 입력하고, 필요하지 않으면 []를 전달합니다. |
|
| optSet.headersConfig.items[*] | object | 단일 사용자 지정 요청 헤더 객체입니다. 예시: {"key": "X-Notify-Source", "value": "guance", "isSensitive": false}가져오기 또는 입력 방법: 각 헤더는 key/value/isSensitive 세 필드를 사용합니다. |
|
| optSet.headersConfig.items[*].key | string | 비어 있지 않은 문자열이며, 앞뒤 공백을 제거한 후 최대 256자이고 대소문자를 구분하지 않고 중복을 제거합니다. 예시: X-Notify-Source가져오기 또는 입력 방법: 수신 측에서 지정한 HTTP 헤더 이름을 사용합니다. |
|
| optSet.headersConfig.items[*].value | string | 비어 있지 않은 문자열이며 최대 4096자입니다. 예시: guance가져오기 또는 입력 방법: 수신 측에 필요한 값을 입력하며, 자격 증명은 통제된 설정에서만 가져옵니다. |
|
| optSet.headersConfig.items[*].isSensitive | boolean | 필수 불리언 값이며, true인 값은 저장 시 암호화되고 상세 및 목록에서 원래 값이 복원됩니다. 예시: false가져오기 또는 입력 방법: 자격 증명 또는 기타 민감한 값에는 true를 사용합니다. |
|
| optSet.bodyTemplate | string | HTTPRequest만 사용자 지정 요청 본문 템플릿을 지원하며 문자열은 최대 5120자입니다. 빈 문자열 또는 null은 설정되지 않은 것으로 간주하며, 공백만 있는 경우 활성화되지 않습니다. 저장 시 유형과 길이만 검증하고 템플릿 구문이나 변수는 검증하지 않습니다. 실제 전송은 사이트 템플릿 기능에 의존하므로 실제 알림으로 반드시 검증해야 합니다. simpleHTTPRequest는 비어 있지 않은 템플릿을 지원하지 않습니다. 예시: {"title":"告警通知"}가져오기 또는 입력 방법: HTTP 수신 측 규칙에 따라 텍스트 템플릿을 제공하고, 실제 알림으로 자리 표시자와 콘텐츠 형식을 먼저 검증하세요. |
|
| optSet.token | string | telegramBot은 필수이며 비어 있지 않아야 합니다. Jira/ServiceNow auth_type=bearer의 인증 자격 증명입니다. 예시: <telegram-or-bearer-token>가져오기 또는 입력 방법: telegramBot은 Bot 관리에서 생성한 Token을 사용하고, Jira/ServiceNow bearer는 수신 측에서 할당한 Token을 사용합니다. |
|
| optSet.chat_id | string | telegramBot 필수 대상 채팅 ID 문자열입니다. 예시: -1000000000000가져오기 또는 입력 방법: Telegram 대상 채팅에서 chat_id를 확인하고 문자열로 제출합니다. |
|
| optSet.message_thread_id | string | telegramBot 선택적 토픽 ID이며, 존재할 경우 문자열입니다. 예시: 123가져오기 또는 입력 방법: Telegram 포럼 토픽이 필요할 때 대상 토픽에서 가져옵니다. |
|
| optSet.auth_type | string 또는 null | Jira/ServiceNow 전용입니다. null이면 독립 인증 헤더를 생성하지 않으며 basic, bearer, api_key를 모두 지원합니다. secret은 Jira만 지원합니다. 생략 시 Jira는 secret, ServiceNow는 basic이 기본입니다. 예시: bearer가져오기 또는 입력 방법: Jira 또는 ServiceNow 수신 측이 지원하는 인증 방식에 따라 선택합니다. |
|
| optSet.username | string | Jira/ServiceNow basic 인증 사용자 이름이며 비어 있지 않아야 하고 콜론 또는 줄 바꿈을 포함할 수 없습니다. 예시: notify-integration가져오기 또는 입력 방법: 수신 측 통합 계정에서 가져옵니다. |
|
| optSet.password | string | Jira/ServiceNow basic 인증 비밀번호이며 비어 있지 않고 줄 바꿈을 포함하지 않습니다. 동일 ID로 업데이트할 때 생략하여 유지할 수 있습니다. 예시: <integration-password>가져오기 또는 입력 방법: 수신 측 통합 계정에서 가져옵니다. |
|
| optSet.api_key_header | string | Jira/ServiceNow api_key 인증 헤더 이름이며 Content-Type일 수 없습니다. 예시: X-API-Key가져오기 또는 입력 방법: 수신 측 규칙에 따라 유효한 HTTP 헤더 이름을 선택합니다. |
|
| optSet.api_key | string | Jira/ServiceNow api_key 인증 자격 증명이며 비어 있지 않고 줄 바꿈을 포함하지 않습니다. 예시: <integration-api-key>가져오기 또는 입력 방법: 수신 측에서 생성하거나 할당한 API Key를 사용합니다. |
|
| optSet.headers | object | Jira/ServiceNow 전용입니다. 헤더 이름은 유효하고 대소문자를 구분하지 않으며 중복될 수 없고, 값은 줄 바꿈을 포함하지 않습니다. Content-Type은 application/json만 가능합니다. 동일 ID로 업데이트할 때 생략하면 기존 헤더를 유지하고, {}는 비웁니다. 읽기 시 값은 빈 문자열로 마스킹됩니다. 예시: {"X-Source": "guance"}가져오기 또는 입력 방법: Jira/ServiceNow 수신 측 요구에 따라 사용자 지정 헤더를 제공하며, 키는 헤더 이름이고 값은 문자열입니다. |
|
| optSet.headers.동적 키 | string | 사용자 지정 헤더의 문자열 값입니다. 업데이트 시 동일한 이름의 빈 값은 동일 ID의 이전 값을 유지할 수 있으며, 새 헤더는 빈 값일 수 없습니다. 예시: guance가져오기 또는 입력 방법: 대상 플랫폼에 필요한 실제 헤더 이름(예: X-Source)을 사용합니다. |
|
| name | string | Y | 알림 대상 이름입니다. Jira/ServiceNow는 공백 제거 후 비어 있지 않고 길이가 200을 초과하지 않아야 합니다. 다른 유형은 비어 있지 않은 식별 가능한 이름을 사용하는 것이 좋습니다. null 허용: False 예시: 生产回调가져오기 또는 입력 방법: 알림 대상 목록에서 검색하여 중복 이름을 제외한 후 입력합니다. |
| openPermissionSet | boolean | 사용자 지정 작업 권한을 활성화할지 여부입니다. 생성 시 기본값은 false이며, 수정 시 생략하면 유지됩니다. 생성자와 Owner 및 고급 설정에 해당하는 주체는 별도로 허용될 수 있습니다. null 허용: False 예시: false가져오기 또는 입력 방법: 기본적으로 API 권한을 상속하며, 객체 수준 제한이 필요하면 true로 설정하고 permissionSet을 구성합니다. |
|
| optSet | json | 알림 유형에 따라 전체 JSON 객체를 제공합니다. 생성 시 명시적으로 제공해야 하며, 일반 유형 수정 시 전체를 교체하고 Jira/ServiceNow는 동일 ID 규칙에 따라 자격 증명을 유지합니다. null 허용: False 예시: {"url": "https://receiver.example.com/alerts"}가져오기 또는 입력 방법: type에 따라 아래 표의 해당 설정을 선택하고, 수신 플랫폼 또는 멤버 목록에서 실제 값을 가져옵니다. |
|
| permissionSet | array | 사용자 지정 가능한 작업 주체의 전체 배열입니다. 수정 시 전체를 교체하고 []는 비웁니다. 특수 값 *는 API 인증을 통과한 모든 주체가 이 객체 수준 검사를 통과하도록 허용하며, 익명 액세스를 개방하는 것은 아닙니다. null 허용: False 예시: ["wsAdmin"]가져오기 또는 입력 방법: 멤버는 워크스페이스 멤버 목록의 계정 UUID를, 팀은 멤버 그룹 목록의 group_ UUID를, 역할은 역할 목록의 역할 UUID 또는 기존 역할 식별자(예: wsAdmin)를 사용합니다. 표시 이름을 입력하지 마세요. |
|
| type | string | Y | 필수이며 null이 아닌 지원되는 알림 유형이어야 하며, trigger 기본값은 없습니다. null 허용: True 선택 가능한 값: ['dingTalkRobot', 'HTTPRequest', 'wechatRobot', 'mailGroup', 'feishuRobot', 'sms', 'vms', 'simpleHTTPRequest', 'jiraWebhook', 'serviceNowWebhook', 'slackIncomingWebhook', 'teamsWorkflowWebhook', 'googleChatWebhook', 'telegramBot'] 예시: HTTPRequest가져오기 또는 입력 방법: 대상 알림 플랫폼에 따라 열거형을 선택합니다. HTTPRequest는 HTTP 콜백, simpleHTTPRequest는 간소화된 HTTP 콜백입니다. |
파라미터 추가 설명¶
Jira/ServiceNow의 원래 비밀번호, API Key, Token 및 사용자 지정 헤더 값은 반환되지 않으며, has*와 credentialsRequired로 설정 여부를 판단합니다. 기타 기존 봇 및 HTTP 설정은 기존 민감한 값을 반환할 수 있습니다. 전체 응답 내용을 제3자에게 전달하지 마세요.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/notify_object/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"type":"HTTPRequest","name":"生产回调","optSet":{"url":"https://receiver.example.com/alerts"}}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 저장된 알림 대상 레코드이며, 목록/상세의 계정 요약 및 권한 판단은 포함하지 않습니다. |
| content.id | integer 또는 null | 데이터베이스 번호입니다. 생성 응답에서는 아직 할당되지 않았을 수 있으며, 이후 작업에는 uuid를 사용합니다. |
| content.uuid | string | 알림 대상 UUID입니다. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.name | string | 알림 대상 이름입니다. |
| content.type | string | 알림 유형입니다. 기존 Jira/ServiceNow 저장 별칭은 jiraWebhook/serviceNowWebhook으로 정규화됩니다. |
| content.optSet | object | type에 대응하는 알림 설정이며, 구체적인 필드는 아래와 같고 설정되지 않은 필드는 생략될 수 있습니다. |
| content.openPermissionSet | boolean | 이 객체의 사용자 지정 작업 권한을 활성화할지 여부입니다. |
| content.permissionSet | array<string> |
객체를 작업할 수 있는 역할, 멤버 또는 팀 식별자 배열입니다. |
| content.permissionSet[] | string | 단일 권한 주체 식별자입니다. |
| content.autoDisableAt | integer | 자동 비활성화 시간(Unix 초)입니다. 자동 비활성화되지 않은 경우 -1입니다. |
| content.status | integer | 레코드 상태입니다. 0은 활성화, 2는 비활성화이며, 3은 삭제됨으로 이 조회에서 반환되지 않습니다. |
| content.creator | string | 생성 주체입니다. |
| content.updator | string | 최근 업데이트 주체이며, 업데이트되지 않은 경우 비어 있습니다. |
| content.createAt | integer | 생성 Unix 초입니다. |
| content.updateAt | integer | 업데이트 Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.deleteAt | integer | 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.optSet.webhook | string | 봇, Slack, Teams, Google Chat, Jira 및 ServiceNow에서 사용하는 콜백 주소입니다. Jira/ServiceNow는 유효한 HTTPS여야 하며 URL 사용자 비밀번호, 프래그먼트 또는 공백을 포함할 수 없습니다. 주소는 사이트 도메인 확인 및 인트라넷 정책의 영향을 받습니다. |
| content.optSet.secret | string | DingTalk/Lark 등 봇은 원래 서명 키를 반환할 수 있습니다. Jira는 원래 키를 반환하지 않고 hasSecret 플래그를 사용합니다. |
| content.optSet.url | string | HTTPRequest/simpleHTTPRequest의 필수 비어 있지 않은 콜백 주소이며, 도메인 확인 및 인트라넷 정책의 영향을 받습니다. |
| content.optSet.to | array<string> |
mailGroup, sms, vms의 수신 멤버/팀 UUID 배열입니다. 멤버 프로필에 해당 이메일 또는 휴대폰 번호가 설정되어 있어야 하며, 임의의 이메일/휴대폰 번호 문자열 배열이 아닙니다. |
| content.optSet.to[] | string | 단일 멤버 또는 팀 UUID입니다. |
| content.optSet.refMembers | array<string> |
HTTPRequest/simpleHTTPRequest 모두 문자열 배열을 받아 검증하지만, 현재 HTTPRequest만 실제로 refMembersInfo로 확장되어 콘텐츠 파싱에 참여하며 simpleHTTPRequest는 이 확장을 수행하지 않습니다. |
| content.optSet.refMembers[] | string | 연결된 멤버 또는 팀 UUID 문자열입니다. |
| content.optSet.headersConfig | object | 사용자 지정 요청 헤더 설정입니다. Jira/ServiceNow의 headers와 다릅니다. 읽기 API는 민감한 값을 복원하므로, 반환 데이터를 저장 전에 안전하게 처리해야 합니다. |
| content.optSet.headersConfig.isOpen | boolean | 설정이 존재할 때는 반드시 불리언 값을 제공해야 하며, true일 때만 사용자 지정 헤더를 전송합니다. |
| content.optSet.headersConfig.items | array<object> |
설정이 존재할 때 반드시 배열을 전달해야 하며 최대 50개 항목입니다. isOpen=false여도 항목을 검증합니다. |
| content.optSet.headersConfig.items[] | object | 단일 사용자 지정 요청 헤더 객체입니다. |
| content.optSet.headersConfig.items[].key | string | 비어 있지 않은 문자열이며, 앞뒤 공백을 제거한 후 최대 256자이고 대소문자를 구분하지 않고 중복을 제거합니다. |
| content.optSet.headersConfig.items[].value | string | 비어 있지 않은 문자열이며 최대 4096자입니다. |
| content.optSet.headersConfig.items[].isSensitive | boolean | 필수 불리언 값이며, true인 값은 저장 시 암호화되고 상세 및 목록에서 원래 값이 복원됩니다. |
| content.optSet.bodyTemplate | string | HTTPRequest만 사용자 지정 요청 본문 템플릿을 지원하며 문자열은 최대 5120자입니다. 빈 문자열 또는 null은 설정되지 않은 것으로 간주하며, 공백만 있는 경우 활성화되지 않습니다. 저장 시 유형과 길이만 검증하고 템플릿 구문이나 변수는 검증하지 않습니다. 실제 전송은 사이트 템플릿 기능에 의존하므로 실제 알림으로 반드시 검증해야 합니다. simpleHTTPRequest는 비어 있지 않은 템플릿을 지원하지 않습니다. |
| content.optSet.token | string | telegramBot은 설정된 Bot Token을 반환합니다. Jira/ServiceNow는 bearer 자격 증명을 반환하지 않고 hasToken 플래그를 사용합니다. |
| content.optSet.chat_id | string | telegramBot 필수 대상 채팅 ID 문자열입니다. |
| content.optSet.message_thread_id | string | telegramBot 선택적 토픽 ID이며, 존재할 경우 문자열입니다. |
| content.optSet.auth_type | string 또는 null | Jira/ServiceNow 전용입니다. null이면 독립 인증 헤더를 생성하지 않으며 basic, bearer, api_key를 모두 지원합니다. secret은 Jira만 지원합니다. 생략 시 Jira는 secret, ServiceNow는 basic이 기본입니다. |
| content.optSet.username | string | Jira/ServiceNow basic 인증 사용자 이름이며 비어 있지 않아야 하고 콜론 또는 줄 바꿈을 포함할 수 없습니다. |
| content.optSet.api_key_header | string | Jira/ServiceNow api_key 인증 헤더 이름이며 Content-Type일 수 없습니다. |
| content.optSet.headers | object | Jira/ServiceNow 전용입니다. 헤더 이름은 유효하고 대소문자를 구분하지 않으며 중복될 수 없고, 값은 줄 바꿈을 포함하지 않습니다. Content-Type은 application/json만 가능합니다. 동일 ID로 업데이트할 때 생략하면 기존 헤더를 유지하고, {}는 비웁니다. 읽기 시 값은 빈 문자열로 마스킹됩니다. |
| content.optSet.headers.동적 키 | string | 사용자 지정 헤더의 문자열 값입니다. 업데이트 시 동일한 이름의 빈 값은 동일 ID의 이전 값을 유지할 수 있으며, 새 헤더는 빈 값일 수 없습니다. |
| content.optSet.hasSecret | boolean | Jira secret 모드 전용이며, 서명 키가 설정되었는지 여부입니다. |
| content.optSet.hasPassword | boolean | Jira/ServiceNow basic 모드 전용이며, 비밀번호가 설정되었는지 여부입니다. |
| content.optSet.hasToken | boolean | Jira/ServiceNow bearer 모드 전용이며, Token이 설정되었는지 여부입니다. |
| content.optSet.hasApiKey | boolean | Jira/ServiceNow api_key 모드 전용이며, Key가 설정되었는지 여부입니다. |
| content.optSet.hasHeaderValues | object | Jira/ServiceNow 전용이며, 반환되는 각 헤더에 비어 있지 않은 값이 저장되었는지 표시합니다. |
| content.optSet.hasHeaderValues.동적 키 | boolean | 헤더 이름에 대응하는 설정 상태입니다. |
| content.optSet.deliveryStatus | string | Jira/ServiceNow의 설정 표시 식별자이며 현재 configured입니다. 실제 전송 성공을 의미하지 않습니다. |
| content.optSet.credentialsRequired | boolean | Jira/ServiceNow에 현재 인증 방식에 필요한 자격 증명 또는 헤더 값이 아직 누락되었는지 여부입니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"id": null,
"uuid": "notify_example",
"workspaceUUID": "wksp_example",
"name": "生产回调",
"type": "HTTPRequest",
"optSet": {
"url": "https://receiver.example.com/alerts"
},
"openPermissionSet": false,
"permissionSet": [],
"autoDisableAt": -1,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"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 객체를 제출합니다. |
| 400 | ft.NofityObjectNameRepeat | 동일 워크스페이스에 같은 이름의 활성 또는 비활성 알림 대상이 이미 있음 | 같은 이름의 알림 대상이 이미 존재함 | 먼저 기존 이름을 검색하고 사용 중이지 않은 이름을 사용합니다. |
| 406 | ft.InvalidParameter | Jira/ServiceNow 이름, 주소, 인증 모드, 자격 증명 또는 요청 헤더가 규칙에 맞지 않음 | 파라미터 {}가 유효하지 않음 |
오류에서 지적된 필드에 따라 파라미터 표대로 수정하며, 읽기 전용 has* 플래그를 비밀 값 대신 반환할 수 없습니다. |
| 406 | ft.InvalidType | 알림 유형이 지원되지 않거나 null로 전달됨 | 유효하지 않은 type | 생성 파라미터 열거형의 비어 있지 않은 유형을 사용하고, trigger 또는 기존 별칭으로 생성하지 마세요. |
| 406 | ft.InvalidAddress | 콜백 도메인을 확인할 수 없음 | 도메인 {}을(를) 확인할 수 없음 |
확인 가능한 대상 콜백 도메인을 사용하고 사이트 DNS를 확인하세요. |
| 406 | ft.IntranetError | 콜백 주소가 사이트 인트라넷 제한에 해당함 | 인트라넷 주소를 입력할 수 없음 | 사이트에서 허용하는 콜백 대상을 사용하거나 관리자가 주소 정책을 확인하도록 하세요. |
| 500 | ft.InternalServerError | 설정 필드 누락 또는 유형이 유효하지 않음, 데이터베이스 또는 캐시 처리 실패 | 내부 오류 | 이 페이지에 따라 해당 알림 유형의 설정을 확인하고 traceId를 기록하세요. 쓰기 작업 실패 후에는 대상이 이미 저장되었는지 먼저 조회한 후 재시도하세요. |
| 403 | ft.ForbiddenFreeEditionWorkspace | 워크스페이스 버전에서 선택한 알림 유형 생성을 허용하지 않음 | 무료 플랜 워크스페이스는 이 기능을 지원하지 않습니다. 상용 플랜을 개통하여 제한을 해제할 수 있습니다 | 워크스페이스 버전의 알림 방식 지원 여부를 확인하고, 지원되는 유형을 선택하거나 버전을 업그레이드하세요. |
| 406 | ft.UnsupportShortMessage | 무료 또는 체험 워크스페이스에서 SMS 알림 대상 생성 | 무료 플랜 워크스페이스는 短信 알림 대상을 지원하지 않습니다 |
현재 버전에서 지원하는 방식을 선택하세요. |
| 406 | ft.UnsupportOnCall | 무료 또는 체험 워크스페이스에서 전화 알림 대상 생성 | 워크스페이스가 电话 알림 대상을 지원하지 않습니다 |
현재 버전에서 지원하는 방식을 선택하세요. |