ActivitySubscriptions API

Zurich API 참조

Release

zurich

ft:locale

ko-KR

ft:publication_title

Zurich API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

ActivitySubscriptions API

릴리스 버전: Zurich

업데이트 날짜 2025년 07월 31일

소요 시간: 28분

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

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

ActivitySubscriptions - GET /now/actsub/activities

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

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

URL 형식

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

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

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 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 목록입니다. 활동 패싯에 대한 자세한 내용은 활동 컨텍스트에 대한 패싯 만들기를 참조하세요. 데이터 유형: 문자열 기본값: 활동 컨텍스트에 대해 구성된 모든 활동 패싯 유형을 반환합니다. 테이블: 활동 패싯 [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
st시작	응답 본문에 포함할 첫 번째 결과 행의 인덱스 값입니다. 결과 행 인덱스는 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 전달되었는지 확인` 또는 `유효한 스트림 및 사용자가 전달되었는지 확인` 요청에 AND context_instance 쿼리 매개변수 중 context 하나 또는 둘 다 없음을 나타냅니다. 이러한 매개변수는 필수입니다. `stFrom은 마지막보다 클 수 없습니다.` 는 stFrom 쿼리 매개변수 값이 쿼리 매개변수 값을 초과 last 함을 나타냅니다. `start_date 제공하십시오. end_date` 요청에 별도로 사용할 수 없는 쿼리 end_date 매개변수 중 start_date 하나만 포함되어 있음을 나타냅니다. `start_date end_date보다 앞설 수 없음` 은 지정된 start_date 쿼리 매개변수 값이 지정된 end_date 쿼리 매개변수 값 이후에 발생함을 나타냅니다. `제공된 컨텍스트가 시스템에 구성되지 않음은` 쿼리 매개변수 값이 유효한 활동 컨텍스트를 context 나타내지 않음을 나타냅니다. `유효한 context_instance 전달되었는지 확인은` 쿼리 매개변수 값이 지정된 활동 컨텍스트의 유효한 인스턴스를 나타내지 않음을 context_instance 나타냅니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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


이름	설명
결과	Result 객체입니다. 데이터 유형: 객체 `"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 잘리지 않습니다. 이 컨텍스트 및 컨텍스트 인스턴스에 사용할 수 있는 추가 활동이 없습니다. 데이터 유형: 문자열
결과.메시지	요청 처리 중에 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열
결과.상태	요청에 대해 반환된 HTTP 상태 코드입니다. 유효한 값: 상태 코드를 참조하십시오. 데이터 유형: 숫자
결과.스트림	Sys_id 요청 context 쿼리 매개변수에 지정되어 있습니다. 데이터 유형: 문자열 테이블: 활동 컨텍스트 [sn_actsub_activity_context]
결과.사용자	Sys_id 요청 context_instance 쿼리 매개변수에 지정되어 있습니다. 활동 컨텍스트에 적합한 테이블에 있습니다. 데이터 유형: 문자열

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}

주: