콘텐츠로 이동

목록



GET /api/v1/notify_object/list

개요

이름을 기준으로 현재 워크스페이스의 알림 대상을 페이지 단위로 조회합니다.

호출 전 및 사용 단계

결과에는 활성화된 객체와 비활성화된 객체가 포함되며 레코드 id 내림차순으로 정렬됩니다. content.data를 읽고 최상위 pageInfo에서 페이지네이션합니다. 후속 호출에는 각 항목의 uuid를 사용하며 데이터베이스 id는 사용하지 않습니다. hasAutoDisabled는 이번 응답 페이지에만 적용되며 전체 워크스페이스 통계를 나타내지 않습니다. 생성 또는 수정 후에는 이 인터페이스로 설정이 저장되었는지 확인할 수 있습니다.

요청 헤더

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

Query 요청 파라미터

매개변수명 유형 필수 설명
pageIndex integer 페이지 번호, 최소 1, 기본값 1.
null 허용: False
$minValue: 1
예: 1
획득 또는 입력 방법: 첫 페이지는 1부터 증가합니다.
pageSize integer 페이지당 항목 수, 기본값 100, 예시의 10이 아닙니다.
null 허용: False
$maxValue: 100
$minValue: 1
예: 10
획득 또는 입력 방법: 필요에 따라 1~100을 입력합니다.
search string 이름으로 퍼지 검색하며 생략하면 필터링하지 않습니다.
null 허용: True
예: 生产
획득 또는 입력 방법: 알림 대상 이름 키워드를 입력합니다.

파라미터 추가 설명

이 공개 인터페이스는 search, pageIndex, pageSize만 선언합니다. 공유 내부 인터페이스의 types, status, autoDisabled 필터 파라미터를 직접 전달해서는 안 됩니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/notify_object/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=生产' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=10

응답

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

필드 유형 설명
content object 목록 결과 객체입니다.
content.data array<object> 현재 페이지의 알림 대상 배열이며 결과가 없으면 []입니다.
content.data[].id integer 데이터베이스 번호이며 후속 작업에는 uuid를 사용합니다.
content.data[].uuid string 알림 대상 UUID입니다.
content.data[].workspaceUUID string 소속 워크스페이스 UUID입니다.
content.data[].name string 알림 대상 이름입니다.
content.data[].type string 알림 유형입니다. 기존 Jira/ServiceNow 저장 별칭은 jiraWebhook/serviceNowWebhook으로 정규화됩니다.
content.data[].optSet object type에 대응하는 알림 구성이며 구체적인 필드는 아래와 같고 구성되지 않은 필드는 생략될 수 있습니다.
content.data[].openPermissionSet boolean 이 객체의 사용자 지정 작업 권한을 활성화할지 여부입니다.
content.data[].permissionSet array<string> 객체를 작업할 수 있는 역할, 구성원 또는 팀 식별자 배열입니다.
content.data[].permissionSet[] string 단일 권한 주체 식별자입니다.
content.data[].autoDisableAt integer 자동 비활성화 시간(Unix 초)이며 자동 비활성화되지 않은 경우 -1입니다.
content.data[].status integer 레코드 상태이며 0은 활성화, 2는 비활성화입니다. 3은 삭제됨이며 이 조회에서 반환되지 않습니다.
content.data[].creator string 생성 주체입니다.
content.data[].updator string 최근 업데이트 주체이며 업데이트가 없으면 비어 있습니다.
content.data[].createAt integer 생성 Unix 초입니다.
content.data[].updateAt integer 업데이트 Unix 초이며 업데이트가 없으면 -1입니다.
content.data[].deleteAt integer 삭제 Unix 초이며 삭제되지 않았으면 -1입니다.
content.data[].optSet.webhook string 로봇, Slack, Teams, Google Chat, Jira 및 ServiceNow에서 사용하는 콜백 주소입니다. Jira/ServiceNow는 유효한 HTTPS여야 하며 URL 사용자 비밀번호, 프래그먼트 또는 공백을 포함할 수 없습니다. 주소는 사이트 도메인 확인 및 내부 네트워크 정책의 제한을 받습니다.
content.data[].optSet.secret string DingTalk/Lark 등의 로봇은 원래 서명 키를 반환할 수 있습니다. Jira는 원래 키를 반환하지 않고 hasSecret 플래그를 사용합니다.
content.data[].optSet.url string HTTPRequest/simpleHTTPRequest의 필수 비어 있지 않은 콜백 주소이며 도메인 확인 및 내부 네트워크 정책의 제한을 받습니다.
content.data[].optSet.to array<string> mailGroup, sms, vms의 수신 구성원/팀 UUID 배열입니다. 구성원 프로필에 해당 이메일 또는 휴대폰 번호가 구성되어 있어야 하며 임의의 이메일/휴대폰 번호 문자열 배열이 아닙니다.
content.data[].optSet.to[] string 단일 구성원 또는 팀 UUID입니다.
content.data[].optSet.refMembers array<string> HTTPRequest/simpleHTTPRequest 모두 문자열 배열을 허용하고 검증하지만 현재 HTTPRequest만 실제로 refMembersInfo로 확장되어 콘텐츠 파싱에 참여합니다. simpleHTTPRequest는 이 확장을 수행하지 않습니다.
content.data[].optSet.refMembers[] string 연결된 구성원 또는 팀 UUID 문자열입니다.
content.data[].optSet.headersConfig object 사용자 지정 요청 헤더 구성입니다. Jira/ServiceNow의 headers와 다릅니다. 조회 인터페이스는 민감한 값을 원래대로 복원하므로 반환 데이터를 저장 전에 적절히 처리해야 합니다.
content.data[].optSet.headersConfig.isOpen boolean 구성이 존재하는 경우 반드시 불리언 값을 제공해야 하며 true일 때만 사용자 지정 헤더를 전송합니다.
content.data[].optSet.headersConfig.items array<object> 구성이 존재하는 경우 반드시 배열을 전달해야 하며 최대 50개 항목입니다. isOpen=false인 경우에도 항목을 검증합니다.
content.data[].optSet.headersConfig.items[] object 단일 사용자 지정 요청 헤더 객체입니다.
content.data[].optSet.headersConfig.items[].key string 비어 있지 않은 문자열이며 앞뒤 공백을 제거한 후 최대 256자이고 대소문자를 구분하지 않고 중복을 제거합니다.
content.data[].optSet.headersConfig.items[].value string 비어 있지 않은 문자열이며 최대 4096자입니다.
content.data[].optSet.headersConfig.items[].isSensitive boolean 필수 불리언 값이며 true인 값은 저장 시 암호화되고 상세 및 목록에서 원래 값이 복원됩니다.
content.data[].optSet.bodyTemplate string HTTPRequest만 사용자 지정 요청 본문 템플릿을 지원하며 문자열은 최대 5120자입니다. 빈 문자열 또는 null은 구성되지 않은 것으로 간주하며 공백만 있는 경우 활성화되지 않습니다. 저장 시 유형과 길이만 검증하고 템플릿 구문이나 변수는 검증하지 않습니다. 실제 전송은 사이트 템플릿 기능에 의존하므로 실제 알림으로 검증해야 합니다. simpleHTTPRequest는 비어 있지 않은 템플릿을 지원하지 않습니다.
content.data[].optSet.token string telegramBot은 구성된 Bot Token을 반환합니다. Jira/ServiceNow는 bearer 자격 증명을 반환하지 않고 hasToken 플래그를 사용합니다.
content.data[].optSet.chat_id string telegramBot의 필수 대상 채팅 ID 문자열입니다.
content.data[].optSet.message_thread_id string telegramBot의 선택적 토픽 ID이며 존재할 경우 문자열입니다.
content.data[].optSet.auth_type string 또는 null Jira/ServiceNow 전용: null이면 별도 인증 헤더를 생성하지 않으며 basic, bearer, api_key를 모두 지원합니다. secret은 Jira만 지원합니다. 생략 시 Jira는 기본값 secret, ServiceNow는 기본값 basic입니다.
content.data[].optSet.username string Jira/ServiceNow basic 인증 사용자 이름이며 비어 있지 않고 콜론이나 줄바꿈을 포함할 수 없습니다.
content.data[].optSet.api_key_header string Jira/ServiceNow api_key 인증 헤더 이름이며 Content-Type일 수 없습니다.
content.data[].optSet.headers object Jira/ServiceNow 전용입니다. 헤더 이름은 유효하고 대소문자를 구분하지 않고 중복되지 않아야 하며 값에는 줄바꿈이 없어야 합니다. Content-Type은 application/json만 가능합니다. 동일 주체의 업데이트에서 생략하면 기존 헤더를 유지하고 {}는 비웁니다. 조회 시 값은 마스킹되어 빈 문자열이 됩니다.
content.data[].optSet.headers.动态键 string 사용자 지정 헤더의 문자열 값입니다. 업데이트 시 동일한 이름의 빈 값은 동일 주체의 이전 값을 유지할 수 있으며 새 헤더는 빈 값을 가질 수 없습니다.
content.data[].optSet.hasSecret boolean Jira secret 모드 전용이며 서명 키가 구성되었는지 여부입니다.
content.data[].optSet.hasPassword boolean Jira/ServiceNow basic 모드 전용이며 비밀번호가 구성되었는지 여부입니다.
content.data[].optSet.hasToken boolean Jira/ServiceNow bearer 모드 전용이며 Token이 구성되었는지 여부입니다.
content.data[].optSet.hasApiKey boolean Jira/ServiceNow api_key 모드 전용이며 Key가 구성되었는지 여부입니다.
content.data[].optSet.hasHeaderValues object Jira/ServiceNow 전용이며 반환되는 각 헤더에 비어 있지 않은 값이 저장되었는지 표시합니다.
content.data[].optSet.hasHeaderValues.动态键 boolean 헤더 이름에 해당하는 구성 상태입니다.
content.data[].optSet.deliveryStatus string Jira/ServiceNow의 구성 표시 식별자이며 현재 값은 configured이고 실제 전송 성공을 의미하지 않습니다.
content.data[].optSet.credentialsRequired boolean Jira/ServiceNow에 현재 인증 방식에 필요한 자격 증명 또는 헤더 값이 아직 누락되었는지 여부입니다.
content.data[].creatorInfo object 또는 string 생성자 요약이며 프로필이 없을 때 목록에서는 {}이고 상세에서는 빈 문자열일 수 있습니다.
content.data[].creatorInfo.uuid string 계정 또는 API Key UUID입니다.
content.data[].creatorInfo.status integer 계정 상태입니다.
content.data[].creatorInfo.wsAccountStatus integer 워크스페이스 내 계정 상태입니다.
content.data[].creatorInfo.username string 사용자 이름입니다.
content.data[].creatorInfo.name string 표시 이름입니다.
content.data[].creatorInfo.iconUrl string 프로필 이미지 URL입니다.
content.data[].creatorInfo.email string 이메일 또는 API Key 식별자입니다.
content.data[].creatorInfo.mobile string 휴대폰 번호이며 비어 있을 수 있습니다.
content.data[].creatorInfo.countryCode string 휴대폰 번호 국가 코드이며 비어 있을 수 있습니다.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임이며 비어 있을 수 있습니다.
content.data[].updatorInfo object 또는 string 수정자 요약이며 프로필이 없을 때 목록에서는 {}이고 상세에서는 빈 문자열일 수 있습니다. 상세는 현재 생성자 기준으로만 조회하므로 업데이트 주체가 다르면 프로필이 없을 수 있습니다.
content.data[].updatorInfo.uuid string 계정 또는 API Key UUID입니다.
content.data[].updatorInfo.status integer 계정 상태입니다.
content.data[].updatorInfo.wsAccountStatus integer 워크스페이스 내 계정 상태입니다.
content.data[].updatorInfo.username string 사용자 이름입니다.
content.data[].updatorInfo.name string 표시 이름입니다.
content.data[].updatorInfo.iconUrl string 프로필 이미지 URL입니다.
content.data[].updatorInfo.email string 이메일 또는 API Key 식별자입니다.
content.data[].updatorInfo.mobile string 휴대폰 번호이며 비어 있을 수 있습니다.
content.data[].updatorInfo.countryCode string 휴대폰 번호 국가 코드이며 비어 있을 수 있습니다.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임이며 비어 있을 수 있습니다.
content.data[].allow_operation boolean 또는 null 사용자 지정 작업 권한 계산 결과입니다. true는 허용, false는 거부이며, null은 객체 사용자 지정 권한이 활성화되지 않았음을 의미하고 인터페이스 권한은 여전히 충족해야 합니다.
content.data[].permissionSetInfo object permissionSet 식별자를 키로 하는 주체 요약이며 permissionSet가 비어 있지 않은 경우에만 나타납니다.
content.data[].permissionSetInfo.主体标识 object 구성원은 계정 요약, 팀/역할은 {name,status}이며 유효하지 않은 주체는 빈 객체일 수 있습니다.
content.data[].permissionSetInfo.主体标识.name string 팀 또는 역할 표시 이름이며 구성원 필드는 creatorInfo와 동일합니다.
content.data[].permissionSetInfo.主体标识.status integer 주체 상태이며 0은 정상입니다.
content.data[].permissionSetInfo.主体标识.uuid string 계정 또는 API Key UUID입니다.
content.data[].permissionSetInfo.主体标识.wsAccountStatus integer 워크스페이스 내 계정 상태입니다.
content.data[].permissionSetInfo.主体标识.username string 사용자 이름입니다.
content.data[].permissionSetInfo.主体标识.iconUrl string 프로필 이미지 URL입니다.
content.data[].permissionSetInfo.主体标识.email string 이메일 또는 API Key 식별자입니다.
content.data[].permissionSetInfo.主体标识.mobile string 휴대폰 번호이며 비어 있을 수 있습니다.
content.data[].permissionSetInfo.主体标识.countryCode string 휴대폰 번호 국가 코드이며 비어 있을 수 있습니다.
content.data[].permissionSetInfo.主体标识.acntWsNickname string 워크스페이스 닉네임이며 비어 있을 수 있습니다.
content.data[].funcServerInfo object 과거 자체 구축 알림 함수 객체에만 반환될 수 있으며 이 공개 생성 인터페이스로 해당 유형을 생성하는 것은 지원되지 않습니다.
content.data[].funcServerInfo.isActive boolean 함수 서비스가 활성 상태인지 여부입니다.
content.data[].funcServerInfo.lastPingAt integer 최근 하트비트 Unix 초이며 하트비트가 없으면 -1입니다.
content.data[].funcServerInfo.status integer 함수 서비스 상태입니다.
content.hasAutoDisabled boolean 이번 페이지에 autoDisableAt이 -1이 아닌 객체가 있는지 여부입니다.
content.declaration object 또는 null 워크스페이스 공통 선언입니다.
pageInfo object 최상위 페이지네이션 객체입니다.
pageInfo.pageIndex integer 현재 페이지 번호입니다.
pageInfo.pageSize integer 페이지당 항목 수입니다.
pageInfo.count integer 현재 페이지의 실제 항목 수입니다.
pageInfo.totalCount integer 이름 검색 조건에 맞는 전체 항목 수입니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 42,
        "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,
        "creatorInfo": {},
        "updatorInfo": {},
        "allow_operation": null
      }
    ],
    "hasAutoDisabled": false,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표 및 예시를 확인합니다.
500 ft.InternalServerError 구성 필드 누락 또는 잘못된 유형, 데이터베이스 또는 캐시 처리 실패 내부 오류 이 페이지에서 해당 알림 유형의 구성을 확인하고 traceId를 기록합니다. 쓰기 작업 실패 후에는 대상이 이미 저장되었는지 먼저 조회한 뒤 재시도합니다.

문서 평가

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