ActivitySubscription API

워싱턴 DC API 참조

Release

washingtondc

ft:locale

ko-KR

ft:publication_title

워싱턴 DC API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

ActivitySubscription API

릴리스 버전: Washingtondc

업데이트 날짜 2024년 02월 01일

읽기28분

ActivitySubscriptions API는 구독 및 활동 피드 프레임워크에서 활동 엔터티를 검색하는 엔드포인트를 제공합니다.

이 API를 사용하려면 com.snc.activity_subscriptions(구독 및 활동 피드 프레임워크) 플러그인을 활성화해야 합니다. Customer Central(com.sn_csm_customer_central) 플러그인을 활성화하여 필요한 모든 테이블에 구성을 시드하십시오. 고객 정보 센터 구성 설정에 대한 자세한 내용은 고객 정보 센터 구성을 참조하십시오.

ActivitySubscriptions - /now/actsub/activities를 가져옵니다.

구독 및 활동 피드 프레임워크에서 활동 기록을 검색합니다.

이 엔드포인트에 액세스하는 데 필요한 역할은 없지만 반환되는 데이터는 사용자 액세스 설정에 의해 제한됩니다.

URL 형식

버전이 지정된 URL: / api/now/{api_version}/actsub/activities

기본 URL: / api/now/actsub/activities

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 2. 쿼리 매개변수
이름	설명
이전	날짜/시간 값입니다. 요청은 이 날짜 및 시간 이전에 생성된 기록만 반환합니다. 데이터 유형: 문자열 형식: YYYY-MM-DD hh:mm:ss 또는 YYYY-MM-DD
컨텍스트	필수 활동 컨텍스트의 Sys_id입니다. 활동 컨텍스트 [sn_actsub_activity_context] 테이블에 있습니다. 미리 정의된 활동 컨텍스트에는 소비자 및 연락처가 포함됩니다. 데이터 유형: 문자열
context_instance	필수 검색할 활동의 개시자를 나타내는 지정된 활동 컨텍스트의 인스턴스 Sys_id입니다. 활동 컨텍스트에 적합한 테이블에 있습니다. 예를 들어, 소비자 활동 컨텍스트의 sys_id으로 설정하는 context 경우 이 매개변수를 활동을 검색하려는 소비자에 대한 소비자 [csm_consumer] 테이블 기록의 sys_id로 설정합니다. 데이터 유형: 문자열
end_date	날짜/시간 값입니다. 요청은 및 이 매개변수에 의해 start_date 정의된 기간 동안 작성된 기록만 반환합니다. 와 함께 start_date설정해야 합니다. 데이터 유형: 문자열 형식: YYYY-MM-DD hh:mm:ss 또는 YYYY-MM-DD
측면	지정된 활동 컨텍스트에 대해 검색할 활동 패싯 유형의 sys_ids쉼표로 구분된 목록입니다. 이러한 sys_ids 활동 패싯[sn_actsub_facet] 테이블에 있습니다. 활동 패싯에 대한 자세한 내용은 활동 컨텍스트에 대한 패싯 생성을 참조하십시오. 데이터 유형: 문자열 기본값: 활동 컨텍스트에 대해 구성된 모든 활동 패싯 유형을 반환합니다.
마지막	응답 본문에서 빠진 첫 번째 결과 행의 인덱스 값입니다. 결과 행 인덱스는 0에서 시작하므로 응답 본문에 포함된 마지막 행은 인덱스 last가 -1인 행입니다. 예를 들어 `last=5` 를 설정하면 인덱스가 5 이상인 행은 생략되고 인덱스 값이 0에서 4 사이인 처음 5개의 결과 행만 반환됩니다. `stFrom=1` 및 `last=5`를 설정하면 첫 번째 결과 행을 건너뛰고 두 번째부터 다섯 번째 결과 행(인덱스 값 1-4 포함)을 반환합니다. 데이터 유형: 숫자(정수) 기본값: com.snc.actsub.activities.api.fetch.limit 시스템 속성의 값입니다(기본값은 10).
record_id	동적 패싯을 렌더링할 때 사용할 기록의 Sys_id입니다. 검색하려는 활동 유형에 적합한 테이블에 있습니다. 예를 들어 케이스 기록에 대한 활동을 가져오려면 이 매개변수를 해당 케이스 기록의 sys_id 설정합니다. 동적 패싯에 대한 자세한 내용은 활동 컨텍스트에 대한 패싯 생성을 참조하십시오. 데이터 유형: 문자열
start_date	날짜/시간 값입니다. 요청은 이 매개변수 및 end_date로 정의된 기간 동안 생성된 기록만 반환합니다. 와 함께 end_date설정해야 합니다. 데이터 유형: 문자열 형식: YYYY-MM-DD hh:mm:ss 또는 YYYY-MM-DD
stFrom에서	응답 본문에 포함할 첫 번째 결과 행의 인덱스 값입니다. 결과 행 인덱스는 0에서 시작합니다. 예를 들어 `stFrom=2` 는 처음 두 결과 행을 건너뛰고 세 번째 행부터 결과를 반환합니다. 데이터 유형: 숫자(정수) 기본값: 0

표 3. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
없음

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 5. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 응답 본문 result.message 매개 변수는 오류의 특성을 설명합니다. 오류 메시지 예: `유효한 컨텍스트 및 context_instance` 전달되었는지 확인하거나 `유효한 스트림 및 사용자가 전달되었는지 확인`은 요청에 및 context_instance 쿼리 매개 변수 중 하나 또는 둘 모두가 context 없음을 나타냅니다. 이러한 매개변수는 필수입니다. `stFrom can't be greater than last`는 last 질의 매개변수 값이 질의 매개변수 값을 초과한다는 것을 stFrom 나타낸다. `start_date 제공하십시오. end_date`는 요청에 and end_date 쿼리 매개 변수 중 start_date 하나만 포함되어 있으므로 별도로 사용할 수 없음을 나타냅니다. `start_date end_date보다 앞설 수 없다는` 것은 지정된 쿼리 파라미터 값이 지정된 start_dateend_date 쿼리 파라미터 값 이후에 발생한다는 것을 나타낸다. `제공된 컨텍스트가 시스템에 구성되지 않았` 으면 쿼리 매개변수 값이 유효한 활동 컨텍스트를 context 나타내지 않음을 나타냅니다. 유효한 `context_instance 전달되면` 쿼리 매개변수 값이 지정된 활동 컨텍스트의 context_instance 유효한 인스턴스를 나타내지 않음을 나타내는지 확인하십시오.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


이름	설명
결과	결과 객체입니다. 데이터 유형: 객체 `"result": { "activities": [Array], "message": "String", "status": Number, "stream": "String", "user": "String" }`
결과.활동	각 객체가 지정된 활동 컨텍스트 및 컨텍스트 인스턴스의 활동 기록을 나타내는 객체의 배열입니다. 데이터 유형: 배열 `"activities": [ { "activity_type_id": "String", "content_fields": [Array], "created": "String", "icon": "String", "source_table_name": "String", "subheader_fields": [Array], "subobject_sys_id": "String", "subobject_table_name": "String", "sys_id": "String", "title": "String" } ]`
result.activities.activity_type_id	이 활동 기록의 유형에 해당하는 활동 유형 [sn_actsub_activity_type] 테이블의 기록 Sys_id입니다. 데이터 유형: 문자열
result.activities.content_fields	각 객체가 활동 기록의 타일에 컨텐츠로 표시할 필드를 나타내는 객체의 배열입니다. 데이터 유형: 배열 `"content_fields": [ { "deeplink_to_subobject": "String", "display_as_timeago": "String", "label": "String", "show_label": "String", "type": "String", "value": "String" } ]`
result.activities.content_fields.deeplink_to_subobject	컨텐츠 필드가 이 활동이 수행된 객체의 기록에 대한 하이퍼링크로 표시되는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 컨텐츠 필드가 이 활동이 수행된 객체의 기록에 대한 하이퍼링크로 표시됩니다. false: 컨텐츠 필드가 이 활동이 수행된 객체의 기록에 대한 하이퍼링크로 표시됩니다. 데이터 유형: 문자열
result.activities.content_fields.display_as_timeago	컨텐츠 필드가 시간 전 형식으로 표시되는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 컨텐츠 필드가 시간 전 형식으로 표시됩니다. false: 컨텐츠 필드가 시간 전 형식으로 표시되지 않습니다. 데이터 유형: 문자열
result.activities.content_fields.레이블	컨텐츠 필드의 레이블입니다. 데이터 유형: 문자열
result.activities.content_fields.show_label	이 활동 기록에 대한 타일의 컨텐츠 필드 값에 대해 컨텐츠 필드 레이블이 표시되는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 이 활동 기록에 대한 타일의 컨텐츠 필드 값에 대해 컨텐츠 필드 레이블이 표시됩니다. false: 이 활동 기록에 대한 타일의 컨텐츠 필드 값에 대해 컨텐츠 필드 레이블이 표시되지 않습니다. 데이터 유형: 문자열
result.activities.content_fields. 유형	컨텐츠 필드의 유형입니다. 데이터 유형: 문자열
result.activities.content_fields.가치	컨텐츠 필드의 값입니다. 데이터 유형: 문자열
결과.활동.작성됨	이 활동 기록의 작성 날짜/시간입니다. 데이터 유형: 문자열 형식: YYYY-DD-MM hh:mm:ss
결과.활동.아이콘	이 활동 기록의 타일에 표시되는 아이콘의 이름입니다. 데이터 유형: 문자열
result.activities.source_table_name	이 활동 기록이 있는 테이블의 이름입니다. 이 활동 기록과 연관된 유형에 대해 활동 유형[sn_actsub_activity_type] 테이블에 정의된 활동 소스에 의해 결정됩니다. 데이터 유형: 문자열
result.activities.subheader_fields	각 객체가 이 활동 기록에 대한 타일의 하위 헤더에 표시되는 필드를 나타내는 객체의 배열입니다. 데이터 유형: 배열 `"subheader_fields": [ { "deeplink_to_subobject": "String", "display_as_timeago": "String", "label": "String", "show_label": "String", "type": "String", "value": "String" } ]`
result.activities.subheader_fields.deeplink_to_subobject	하위 헤더 필드가 이 활동이 수행된 객체의 기록에 대한 하이퍼링크로 표시되는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 하위 헤더 필드가 이 활동이 수행된 객체의 기록에 대한 하이퍼링크로 표시됩니다. false: 하위 헤더 필드가 이 활동이 수행된 객체의 레코드에 대한 하이퍼링크로 표시되지 않습니다. 데이터 유형: 문자열
result.activities.subheader_fields.display_as_timeago	하위 헤더 필드가 시간 전 형식으로 표시되는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 하위 헤더 필드가 시간 전 형식으로 표시됩니다. false: 하위 헤더 필드가 시간 전 형식으로 표시되지 않습니다. 데이터 유형: 문자열
result.activities.subheader_fields.레이블	하위 헤더 필드의 레이블입니다. 데이터 유형: 문자열
result.activities.subheader_fields.show_label	이 활동 기록에 대한 타일의 하위 헤더 필드 값에 대해 하위 헤더 필드 레이블을 표시할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 이 활동 기록에 대한 타일의 하위 헤더 필드 값에 대해 하위 헤더 필드 레이블이 표시됩니다. false: 이 활동 기록에 대한 타일의 하위 헤더 필드 값에 대해 하위 헤더 필드 레이블이 표시되지 않습니다. 데이터 유형: 문자열
result.activities.subheader_fields.유형	하위 헤더 필드의 유형입니다. 데이터 유형: 문자열
result.activities.subheader_fields.가치	하위 헤더 필드의 값입니다. 데이터 유형: 문자열
result.activities.subobject_sys_id	이 활동이 수행된 객체에 대한 기록 Sys_id입니다. 매개변수 값에 지정된 subobject_table_name 테이블에 있습니다. 데이터 유형: 문자열
result.activities.subobject_table_name	이 활동이 수행된 객체에 대한 기록이 포함된 테이블의 이름입니다. 이 활동 기록과 연관된 활동 유형이 포함된 그룹의 활동 그룹[sn_actsub_subscribable_object] 테이블에 정의된 테이블 이름에 의해 결정됩니다. 데이터 유형: 문자열
result.activities.sys_id	이 활동 기록의 Sys_id입니다. 응답 본문 매개변수 값으로 지정된 source_table_name 테이블에 있습니다. 데이터 유형: 문자열
결과.활동.제목	이 활동 기록의 타일에 표시되는 제목입니다. 데이터 유형: 문자열
result.hasMoreRecords	응답 본문의 활동 목록이 쿼리 매개변수 값에 의해 last 잘리는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 응답 본문의 활동 목록이 쿼리 매개 변수 값에 의해 last 잘립니다. 더 높은 last 쿼리 매개변수 값을 사용하여 요청을 반복하면 이 컨텍스트 및 컨텍스트 인스턴스에 대한 추가 활동이 반환됩니다. false: 응답 본문의 활동 목록이 쿼리 매개변수 값에 의해 last 잘리지 않습니다. 이 컨텍스트 및 컨텍스트 인스턴스에 사용할 수 있는 추가 활동이 없습니다. 데이터 유형: 문자열
result.message	요청 처리 중에 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열
result.status	요청에 대해 반환된 HTTP 상태 코드입니다. 유효한 값은 다음과 같습니다. 상태 코드를 참조하십시오. 데이터 유형: 숫자
결과.스트림	요청 context 쿼리 매개변수에 지정된 Sys_id. 활동 컨텍스트 [sn_actsub_activity_context] 테이블에 있습니다. 데이터 유형: 문자열
결과.사용자	요청 context_instance 쿼리 매개변수에 지정된 Sys_id. 활동 컨텍스트에 적합한 테이블에 있습니다. 데이터 유형: 문자열

cURL 요청

특정 연락처에 대한 두 번째 및 세 번째 활동 기록을 요청하여 2020년의 데이터로 제한:

curl "https://instance.servicenow.com/api/now/actsub/activities\
?context=4a6a035a73d30010e37d71ef64f6a714\
&context_instance=ddce70866f9331003b3c498f5d3ee417\
&stFrom=1&last=3\
&start_date=2020-01-01%2000:00:00&end_date=2020-12-31%2023:59:59" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

응답 본문에는 지정된 연락처에 대해 요청된 두 개의 활동 기록이 포함됩니다.

{
  "result": {
    "hasMoreRecords": true,
    "activities": [
      {
        "subobject_table_name": "sn_customerservice_case",
        "source_table_name": "sn_customerservice_case",
        "content_fields": [
          {
            "value": "Test",
            "show_label": "false",
            "type": "string",
            "label": "Short description",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          }
        ],
        "created": "2020-05-29 18:42:16",
        "activity_type_id": "baf0aace73530010e37d71ef64f6a748",
        "title": "Lamar Wilson created case",
        "subobject_sys_id": "1687360e8d819010f87705a074e52ac9",
        "icon": "clipboard_outline",
        "sys_id": "1687360e8d819010f87705a074e52ac9",
        "subheader_fields": [
          {
            "value": "CS0001007",
            "show_label": "false",
            "type": "string",
            "label": "Number",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "true"
          },
          {
            "value": "2020-05-29 18:42:16",
            "show_label": "false",
            "type": "glide_date_time",
            "label": "Created",
            "display_as_timeago": "true",
            "deeplink_to_subobject": "false"
          },
          {
            "value": "",
            "show_label": "false",
            "type": "reference",
            "label": "Assigned to",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          },
          {
            "value": "Lamar Wilson",
            "show_label": "false",
            "type": "reference",
            "label": "Contact",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          }
        ]
      },
      {
        "subobject_table_name": "kb_knowledge",
        "source_table_name": "kb_use",
        "content_fields": [
          {
            "value": "How to Set Up a Broadband Router",
            "show_label": "false",
            "type": "string",
            "label": "Short description",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "false"
          }
        ],
        "created": "2020-05-26 10:00:00",
        "activity_type_id": "4a8c329273d30010e37d71ef64f6a7c1",
        "title": "Lamar Wilson viewed knowledge article",
        "subobject_sys_id": "f855a0a89f011200550bf7b6077fcf4f",
        "icon": "document_outline",
        "sys_id": "b929dd5873941010e37d71ef64f6a719",
        "subheader_fields": [
          {
            "value": "KB0000110",
            "show_label": "false",
            "type": "string",
            "label": "Number",
            "display_as_timeago": "false",
            "deeplink_to_subobject": "true"
          },
          {
            "value": "2020-05-26 10:00:00",
            "show_label": "false",
            "type": "glide_date_time",
            "label": "Created",
            "display_as_timeago": "true",
            "deeplink_to_subobject": "false"
          }
        ]
      }
    ]
  }
}

ActivitySubscriptions - GET /now/actsub/facets/{activity_context}/{context_instance}

구독 및 활동 피드 프레임워크에서 활동 컨텍스트에 대해 구성된 패싯을 검색합니다. 활동 유형, 그룹 및 컨텍스트 설정에 따라 결정된 각 패싯에 대한 활동 수와 데이터를 표시합니다.

이 엔드포인트에 액세스하려면 사용자에게 actsub_user 또는 관리자 역할이 있어야 합니다. 반환되는 데이터는 사용자 액세스 설정에 의해 제한됩니다.

활동 컨텍스트 패싯에 대한 자세한 내용은 활동 컨텍스트에 대한 패싯 생성을 참조하십시오.

URL 형식

버전이 지정된 URL: /api/now/{api_version}/ actsub/facets/{activity_context}/{context_instance}

기본 URL: / api/now/actsub/facets/{activity_context}/{context_instance}

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
activity_context	활동 컨텍스트의 Sys_id입니다. 활동 컨텍스트 [sn_actsub_activity_context] 테이블에 있습니다. 미리 정의된 활동 컨텍스트에는 소비자 및 연락처가 포함됩니다. 다음으로 이동 고객 정보 센터 > 고객 활동 > 활동 컨텍스트 인스턴스에 대해 정의된 활동 컨텍스트의 전체 목록을 보려면 데이터 유형: 문자열
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
context_instance	패싯을 검색할 활동의 개시자를 나타내는 지정된 활동 컨텍스트의 인스턴스 Sys_id입니다. 활동 컨텍스트[sn_actsub_activity_context] 테이블의 활동 컨텍스트 기록에 지정된 컨텍스트 테이블에 있습니다. 예를 들어, 연락처 활동 컨텍스트의 sys_id으로 설정하는 activity_context 경우 이 매개변수를 검색하려는 활동 패싯이 있는 연락처에 대한 연락처 [customer_contact] 레코드의 sys_id로 설정해야 합니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수
이름	설명
end_date	날짜/시간 값입니다. 요청은 및 이 매개변수에 의해 start_date 정의된 기간 동안 작성된 기록만 반환합니다. 와 함께 start_date설정해야 합니다. 데이터 유형: 문자열 형식: YYYY-MM-DD hh:mm:ss 또는 YYYY-MM-DD
측면	지정된 활동 컨텍스트에 대해 검색할 활동 패싯의 쉼표로 구분된 sys_ids 목록입니다. 활동 컨텍스트에 대해 정의된 활동 패싯 유형을 보려면 다음으로 이동합니다. 고객 정보 센터 > 고객 활동 > 활동 컨텍스트 을 클릭하고 패싯 관련 목록을 검토합니다. 데이터 유형: 문자열 기본값: 활동 컨텍스트에 대해 구성된 모든 활동 패싯을 반환합니다.
get_activity_count	응답 본문의 각 패싯에 대한 활동 수를 포함할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 패싯 활동 수를 포함합니다. false: 패싯 활동 수를 생략합니다. 데이터 유형: 부울 기본값: false
lazy_load	응답 본문에서 패싯 활동 데이터 및 활동 수를 생략하여 성능을 향상시킬지 여부를 나타내는 플래그입니다. 이 매개변수는 보다 우선합니다 get_activity_count. 유효한 값은 다음과 같습니다. true: 패싯 활동 데이터 및 활동 수를 생략합니다. false: 패싯 활동 데이터 및 활동 수를 검색합니다. 데이터 유형: 부울 기본값: false
start_date	날짜/시간 값입니다. 요청은 이 매개변수 및 end_date로 정의된 기간 동안 생성된 기록만 반환합니다. 와 함께 end_date설정해야 합니다. 데이터 유형: 문자열 형식: YYYY-MM-DD hh:mm:ss 또는 YYYY-MM-DD

표 9. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
없음

머리글

표 10. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 11. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 12. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 응답 본문 result.message 매개 변수는 오류의 특성을 설명합니다. 오류 메시지 예: 유효한 활동 컨텍스트 `세부 정보가 전달되는지 확인`은 경로 매개변수 값이 유효한 활동 컨텍스트를 activity_context 나타내지 않거나, 경로 매개변수 값이 지정된 활동 컨텍스트의 유효한 인스턴스를 나타내지 않거나, context_instance 둘 다를 나타냅니다. `start_date 제공하십시오. end_date`는 요청에 and end_date 쿼리 매개 변수 중 start_date 하나만 포함되어 있으므로 별도로 사용할 수 없음을 나타냅니다. `start_date end_date보다 앞설 수 없다는` 것은 지정된 쿼리 파라미터 값이 지정된 start_dateend_date 쿼리 파라미터 값 이후에 발생한다는 것을 나타낸다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


이름	설명
결과	각 개체가 활동 패싯을 나타내는 개체의 배열입니다. 데이터 유형: 배열 `"result": [ { "activity_count": Number, "children": [Array], "facets": [Array], "icon": "String", "is_dynamic": "String", "message": "String", "name": "String", "status": Number } ]`
result.activity_count	이 패싯에 포함된 활동 기록 수(및 해당 하위 패싯(있는 경우)입니다. 쿼리 매개변수가 False이고 get_activity_count 쿼리 매개변수가 true인 경우에만 lazy_load 표시됩니다. 데이터 유형: 숫자
결과.하위	각 객체가 활동 기록(동적 패싯인 경우) 또는 하위 패싯(정적 패싯인 경우)을 나타내는 객체의 배열입니다. 데이터 유형: 배열 `"children": [ { "activity_count": Number "facet": "String", "icon": "String", "title": "String" } ]`
result.children.activity_count	이 하위 패싯(및 하위 패싯이 있는 경우)에 포함된 활동 기록 수입니다. 쿼리 매개변수가 False이고 쿼리 매개변수가 lazy_loadget_activity_count True인 경우에만 표시됩니다. 데이터 유형: 숫자
결과.children.생성됨	이 활동 기록의 작성 날짜/시간입니다. 데이터 유형: 문자열 형식: YYYY-MM-DD hh:mm:ss
결과.하위식.패싯	이 하위 패싯 기록의 Sys_id입니다. 활동 패싯 [sn_actsub_facet] 테이블에 있습니다. 데이터 유형: 문자열
결과.children.icon	이 하위 패싯과 연결된 아이콘의 이름입니다. 데이터 유형: 문자열
result.children.sys_id	이 활동 기록의 Sys_id입니다. 상위 패싯 유형에 적합한 테이블에 있습니다. 예를 들어, 케이스 패싯에 포함된 활동 기록에는 케이스 [sn_customerservice_case] 테이블에 있는 sys_id이 있습니다. 데이터 유형: 문자열
결과.하위식.메타데이터	각 개체가 이 패싯 유형의 활동 패싯 [sn_actsub_facet] 테이블 레코드에 구성된 패싯 필드에 대한 활동 기록 데이터를 포함하는 개체의 배열입니다. 데이터 유형: 배열 `"metadata": [ { "key": "String", "label": "String", "type": "String", "value": "String" } ]`
result.children.metadata.key	이 패싯 필드의 이름입니다. 데이터 유형: 문자열
결과.하위.메타데이터.레이블	이 패싯 필드의 레이블입니다. 데이터 유형: 문자열
결과.하위.메타데이터.유형	이 패싯 필드의 유형입니다. 데이터 유형: 문자열
결과.하위.메타데이터.값	이 패싯 필드의 값입니다. 데이터 유형: 문자열
결과.하위.제목	이 활동 기록 또는 하위 패싯의 이름입니다. 데이터 유형: 문자열
결과.패싯	이 패싯 기록과 연결된 sys_ids의 배열입니다. 활동 패싯 [sn_actsub_facet] 테이블에 있습니다. 동적 패싯의 경우 이 배열에는 패싯 자체의 sys_id 포함됩니다. 정적 패싯의 경우 패싯의 하위 항목인 모든 패싯의 sys_ids 대신 포함됩니다. 데이터 유형: 배열 `"facets": [ "510d7e2e73570010e37d71ef64f6a70d", "bc9bfaaa73570010e37d71ef64f6a771" ]`
result.icon	이 패싯과 연결된 아이콘의 이름입니다. 데이터 유형: 문자열
result.is_dynamic	이 패싯이 동적 패싯인지 여부를 나타내는 플래그입니다. 이 값은 응답 본문 매개변수에 children 포함된 정보의 유형을 결정합니다. 유효한 값은 다음과 같습니다. true: 동적 패싯입니다. 응답 본문 매개변수 값에는 children 활동 기록 상세 정보가 포함되며 매개변수에는 facets 동적 패싯 sys_id 포함됩니다. false: 정적 패싯(패싯 그룹)입니다. 응답 본문 매개변수 값에는 children 하위 패싯이 포함되며 매개변수에는 facets 이러한 하위 패싯의 sys_ids 포함됩니다. 데이터 유형: 부울
result.message	요청 처리 중 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열
result.name	패싯 또는 패싯 그룹의 이름입니다. 데이터 유형: 문자열
result.status	요청에 대해 반환된 HTTP 상태 코드입니다. 유효한 값은 다음과 같습니다. 상태 코드 테이블을 참조하십시오. 데이터 유형: 숫자

cURL 요청

연락처에 대한 채팅, 전화 및 지식 문서 패싯 및 활동 수 검색:

curl "https://instance.servicenow.com/api/now/actsub/facets/4a6a035a73d30010e37d71ef64f6a714/ddce70866f9331003b3c498f5d3ee417\
?get_activity_count=true\
&facets=510d7e2e73570010e37d71ef64f6a70d,bc9bfaaa73570010e37d71ef64f6a771,c72d7e2e73570010e37d71ef64f6a7b8" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

응답 본문에는 요청된 3개의 패싯이 패싯 그룹의 하위로 포함되며 활동 수가 표시됩니다.

{
  "result": [
    {
      "is_dynamic": false,
      "name": "Interactions",
      "activity_count": 4.0,
      "facets": [
        "510d7e2e73570010e37d71ef64f6a70d",
        "bc9bfaaa73570010e37d71ef64f6a771"
      ],
      "children": [
        {
          "facet": "510d7e2e73570010e37d71ef64f6a70d",
          "icon": "chat_outline",
          "activity_count": 2.0,
          "title": "Chat"
        },
        {
          "facet": "bc9bfaaa73570010e37d71ef64f6a771",
          "icon": "phone_outline",
          "activity_count": 2.0,
          "title": "Phone"
        }
      ]
    },
    {
      "is_dynamic": false,
      "name": "Portal Activity",
      "activity_count": 5.0,
      "facets": [
        "c72d7e2e73570010e37d71ef64f6a7b8"
      ],
      "children": [
        {
          "facet": "c72d7e2e73570010e37d71ef64f6a7b8",
          "icon": "document_outline",
          "activity_count": 5.0,
          "title": "Knowledge articles"
        }
      ]
    }
  ]
}