계정 API

Xanadu API 참조

Release

xanadu

ft:locale

ko-KR

ft:publication_title

Xanadu API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

계정 API

릴리스 버전: Xanadu

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

읽기23분

계정 API는 계정 기록을 검색하고 업데이트 고객 서비스 관리(CSM) 하기 위한 엔드포인트를 제공합니다.

또한 계정을 만들 때 새 소셜 미디어 프로필 기록을 생성할 수 있습니다.

계정 API에는 고객 서비스 플러그인(com.sn_customerservice)이 필요하며 now 네임스페이스 내에서 제공됩니다.

사용자는 전체 API 액세스를 위해 csm_ws_integration 역할이 필요합니다.

계정 - GET /now/account

지정된 계정 집합을 고객 서비스 관리(CSM) 조회합니다.

URL 형식

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

기본 URL: /api/now/account

지원되는 요청 매개변수

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

표 2. 쿼리 매개변수
이름	설명
sysparm_limit	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 응답에서 boolean 매개 변수가 hasMore 반환됩니다. 필터 기준을 충족하는 반환할 기록이 더 있는지 여부를 나타냅니다. 데이터 유형: 숫자 기본값: 10
sysparm_offset	기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다. sysparm_offset 매개변수에 음수를 전달하지 마십시오. 데이터 유형: 숫자 기본값: 0
sysparm_query	결과 세트를 필터링하는 데 사용되는 인코딩된 쿼리입니다. 예: `sysparm_query=caller_id=javascript:gs.getUserID()^active=예` 인코딩된 쿼리는 정렬 기준을 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 ORDERBY 및 ORDERBYDESC 절을 사용합니다. 예를 들어 `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` 는 모든 활성 레코드를 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열

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

헤더

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

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

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

상태 코드

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

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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


매개변수	설명
account_code	애플리케이션이 예산 예측 및 예산 계획을 식별하는 데 사용하는 값의 고유한 조합입니다. 데이터 유형: 문자열 최대 길이: 255
account_parent	이 계정의 상위 계정 Sys_id입니다. 계정 [customer_account] 테이블에 있습니다. 데이터 유형: 문자열
account_path	계정 계층 구조에서 상위 계정에서 하위 계정으로의 경로입니다. 데이터 유형: 문자열 최대 길이: 255
active_escalation	계정과 연결된 활성 에스컬레이션의 Sys_id입니다. 에스컬레이션 [sn_customerservice_escalation] 테이블에 있습니다. 데이터 유형: 문자열
apple_icon	iPhone 홈페이지 책갈피의 아이콘입니다. 데이터 형식: 이미지
banner_image	고객 포털에 나타나는 배너 이미지입니다. 데이터 형식: 이미지
banner_image_light	작은 배너 이미지입니다. 데이터 형식: 이미지
banner_text	고객 포털에 표시되는 배너 텍스트입니다. 데이터 유형: 문자열 최대 길이: 4,000
구/군/시	이 계정과 연결된 회사가 위치한 시/군/구입니다. 데이터 유형: 문자열 최대 길이: 50
연락처	이 계정과 연결된 접촉 창구 기록의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열
국가	이 계정과 연결된 회사가 위치한 국가입니다. 데이터 유형: 문자열 최대 길이: 40 기본값: 미국
고객	계정이 파트너 계정이 아닌 고객 계정인지 여부를 나타내는 플래그입니다. 가능한 값: true: 고객 계정 false: 파트너 계정 데이터 유형: 부울 기본값: false
할인	구매 시 계정에 제공되는 할인입니다. 데이터 유형: 숫자 최대 길이: 15
fax_phone	이 계정과 연결된 회사의 기본 팩스 전화 번호입니다. 데이터 유형: 문자열 최대 길이: 40
fiscal_year	계정과 연결된 회사의 회계 연도입니다. 데이터 유형: 문자열
lat_long_error	위도 및 경도 정보와 비교한 실제 위치의 차이입니다. 데이터 유형: 문자열 최대 길이: 1,000
위도	이 계정과 연결된 회사의 위도입니다. 데이터 유형: 숫자(부동 소수점 숫자) 최대 길이: 40
경도	이 계정과 연결된 회사의 경도입니다. 데이터 유형: 숫자(부동 소수점 숫자) 최대 길이: 40
제조업체	이 계정과 연결된 회사가 상품을 제조하는지 여부를 나타내는 플래그입니다. 가능한 값: true: 상품을 제조합니다. false: 상품을 제조하지 않음 데이터 유형: 부울 기본값: false
market_cap	관련 회사의 상장 주식 시장 가치입니다. 데이터 유형: 숫자(통화) 최대 길이: 20
이름	이 계정과 연결된 회사의 이름입니다. 데이터 유형: 문자열 최대 길이: 80
메모	회사에 대한 추가 정보입니다. 데이터 유형: 문자열 최대 길이: 4,000
num_employees	회사에 고용된 사람의 수입니다. 데이터 형식: 숫자(정수) 최대 길이: 40
번호	이 계정을 식별하는 번호입니다. 데이터 유형: 문자열 최대 길이: 40
상위	이 계정의 상위 계정 Sys_id입니다. 회사 [core_company] 테이블에 있습니다. 데이터 유형: 문자열
파트너	계정이 파트너 계정인지 고객 계정인지를 나타내는 플래그입니다. 가능한 값: true: 파트너 계정 false: 고객 계정 데이터 유형: 부울 기본값: false
전화	회사의 기본 전화 번호입니다. 데이터 유형: 문자열
기본	기본 계정인지 여부를 나타내는 플래그입니다. 가능한 값: true: 기본 계정 false: 보조 계정 데이터 유형: 부울 기본값: false
primary_contact	계정의 기본 접촉 창구 Sys_id입니다. 연락처 [customer_contact] 테이블에 있습니다. 데이터 유형: 문자열
이익을	이 계정에 대해 입력한 수익 정보입니다. 데이터 유형: 숫자(통화) 최대 길이: 40
publicly_traded	이 계정과 연결된 회사가 증권 거래소에 상장되어 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 상장됨 false: 비상장 기업 데이터 유형: 부울
rank_tier	계정 유형입니다. 가능한 값: 블랙리스트 전략의 전술적인 반환 기타 데이터 유형: 문자열 최대 길이: 40
registration_code	고객이 고객 포털에서 로그인을 요청할 때 사용하는 고유 코드입니다. 이 코드는 액세스 권한을 부여하기 전에 회사에서 고객을 확인하는 방법을 제공합니다. 데이터 유형: 문자열 최대 길이: 40
revenue_per_year	이 계정과 연결된 회사에서 생산한 수익입니다. 데이터 유형: 숫자(통화) 최대 길이: 20
상태	회사가 위치한 주입니다. 데이터 유형: 문자열 최대 길이: 40
stock_price	회사 주식의 가격입니다. 데이터 유형: 문자열 최대 길이: 40
stock_symbol	회사의 주식 기호입니다. 데이터 유형: 문자열 최대 길이: 40
주소	회사의 주소입니다. 데이터 유형: 문자열 최대 길이: 255
sys_class_name	연결된 계정 기록이 들어 있는 테이블입니다. 데이터 유형: 문자열
sys_created_by	원래 계정을 만든 사용자입니다. 데이터 유형: 문자열 최대 길이: 40
sys_created_on	계정이 처음 생성된 날짜 및 시간입니다. 데이터 유형: 문자열
sys_id	계정 기록에 대한 Sys_id입니다. 데이터 유형: 문자열
sys_mod_count	계정 정보가 업데이트된 횟수입니다. 데이터 형식: 숫자(정수)
sys_updated_by	계정 정보를 마지막으로 수정한 사용자입니다. 데이터 유형: 문자열 최대 길이: 40
sys_updated_on	계정 정보가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열
주제	이 계정에서 사용하는 고객 포털 테마의 Sys_id입니다. 테마 [sys_ui_theme] 테이블에 있습니다. 데이터 유형: 문자열
vendor	이 계정과 연결된 회사가 벤더인지 여부를 나타내는 플래그입니다. 가능한 값: true: 벤더 false: 벤더가 아님 데이터 유형: 부울 기본값: false
vendor_manager	해당 계정의 벤더 관리자 sys_ids 목록입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열
vendor_type	애플리케이션, 하드웨어, 서비스 또는 소프트웨어와 같은 벤더 유형의 sys_ids 목록입니다. 벤더 유형 [vendor_type] 테이블에 있습니다. 데이터 유형: 문자열
웹 사이트	회사 웹 사이트의 URL입니다. 데이터 유형: 문자열 최대 길이: 1,024
우편번호	회사의 우편 번호입니다. 데이터 유형: 문자열 최대 길이: 40

cURL 요청

curl "https://instance.servicenow.com/api/now/account?sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
"result": [
  {
   "banner_image_light": "",
   "country": "USA",
   "parent": "",
   "notes": "",
   "stock_symbol": "",
   "discount": "",
   "active_escalation": "",
   "sys_updated_on": "2019-01-03 19:37:55",
   "apple_icon": "",
   "number": "ACCT0000003",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:25:17",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "BR1 3QR",
    "profits": "0",
    "phone": "+44 20 8466 9992",
    "fax_phone": "",
    "name": "Boxeo EMEA",
    "banner_text": "",
    "account_code": "~~~~3",
    "primary": "false",
    "city": "Bromley",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "3eedd08413651200042ab3173244b088",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "18 London Rd",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-EMEA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~3",
    "primary_contact": "ff66c1254fb81200025ba3618110c76e",
    "customer": "true"
  },
  {
    "banner_image_light": "",
    "country": "USA",
    "parent": "",
    "notes": "",
    "stock_symbol": "",
    "discount": "",
    "active_escalation": "",
    "sys_updated_on": "2019-01-03 19:38:04",
    "apple_icon": "",
    "number": "ACCT0000004",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:19:24",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "V5L 2G4",
    "profits": "0",
    "phone": "+1 604-255-9797",
    "fax_phone": "",
    "name": "Boxeo Canada",
    "banner_text": "",
    "account_code": "~~~~4",
    "primary": "false",
    "city": "Vancouver",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "609cd80413651200042ab3173244b03e",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "1362 Venables St,, BC V5L 2G4, Canada",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-CANADA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~4",
    "primary_contact": "c07424a54f781200025ba3618110c746",
    "customer": "true"
  }
 ]
}

계정 - GET /now/account/{id}

지정된 고객 서비스 관리(CSM) 계정을 조회합니다.