업체 관리 개방형 API

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 157분
  • 업체 관리 개방형 API는 소비자, 계정 또는 접촉 창구와 같이 기업과 관계가 있는 당사자를 관리하기 위한 엔드포인트를 제공합니다. 이 API를 사용하여 소비자 [csm_consumer], 계정 [customer_account] 및 연락처 [customer_contact] 테이블에서 데이터를 생성, 업데이트 및 검색합니다.

    파티 관리 개방형 API는 TM Forum Party Management API REST 사양의 구현입니다ServiceNow®. 이 구현은 TMF632 업체 관리 API 적합성 프로필 v5.0.0 – TM 포럼, 2025년 6월을 기반으로 합니다. Party Management Open API는 TM Forum에서 적합성 인증을 받았습니다.

    이 API는 sn_tmf_api 네임스페이스 내에서 제공됩니다. 호출 사용자에게 sn_tmf_api.party_integrator 역할이 있어야 합니다. Customer Service Base Entities(com.snc.cs_base) 플러그인은 특히 모든 GET 작업에 필요합니다.

    이 API는 필수 매개변수, 요청 본문 확인, 추가 REST 작업 및 필드 매핑을 사용자 지정하도록 확장할 수 있습니다. 전화번호와 같은 중요한 필드에는 업데이트 또는 검색을 위해 특수 ACL 권한이 필요할 수 있습니다.

    업체 관리 – DELETE /api/sn_tmf_api/v1/party/individual/{id}

    소비자 [csm_consumer] 및 연락처 [customer_contact] 테이블에서 지정된 기록을 비활성화합니다.

    URL 형식

    버전 관리된 URL: /api/sn_tmf_api/{api_version}/party/individual/{id}

    기본 URL: /api/sn_tmf_api/v1/party/individual/{id}

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    ID 비활성 상태로 설정할 소비자 또는 접촉 창구 기록의 Sys_id 또는 external_id입니다.

    테이블: 소비자[csm_consumer] 및 연락처[customer_contact]

    데이터 유형: 문자열

    표 2. 쿼리 매개변수
    이름 설명
    안 함
    표 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 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.

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

    이름 설명
    없음

    cURL 요청

    다음 예에서는 지정된 기록을 삭제합니다.

    curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/individual/dca96eaa11f43110f877366201dea6c1" \
    --request DELETE \
    --header "Accept:application/json" \
    --user 'user':'password' \

    응답 본문을 반환하지 않습니다. 성공 또는 실패 표시기의 참조 상태 코드입니다.

    업체 관리 – GET /api/sn_tmf_api/v1/party/individual

    엔터프라이즈와 관계가 있는 모든 개인(당사자) 기록의 목록을 조회합니다. 특정 필드 또는 ID를 기준으로 결과를 필터링할 수 있습니다.

    URL 형식

    버전이 지정된 URL: /api/sn_tmf_api/v1/party/individual

    기본 URL: /api/sn_tmf_api/v1/party/individual

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    표 8. 쿼리 매개변수
    이름 설명
    필드 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다.
    유효한 필드:
    • @type
    • familyName
    • 성별
    • givenName
    • href
    • ID
    • middleName
    • 이름
    • 국적
    • 상태
    • 직위

    데이터 유형: 문자열

    기본값: 모든 필드를 반환합니다.

    ID sys_id별로 당사자 관리를 필터링합니다. 지정된 sys_ids가 응답에 반환됩니다.

    데이터 유형: 문자열

    제한 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다.

    데이터 유형: 숫자

    기본값: 20

    최대: 100

    오프셋 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다.

    데이터 유형: 숫자

    기본값: 0

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

    헤더

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

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

    기본값: application/json

    표 11. 응답 헤더
    머리글 설명
    컨텐츠-범위 페이지 매김된 호출에서 반환되는 콘텐츠의 범위입니다.

    예를 들어 offset=2 및 limit=3인 경우 Content-Range 헤더의 값은 항목 3-5입니다.

    콘텐츠-형식 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    링크
    쿼리 결과를 탐색하는 다음 링크가 포함되어 있습니다.
    • 첫 번째
    • 마지막
    • 다음
    • 이전
    X-합계-카운트 페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 기록 수를 지정합니다.

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 12. 상태 코드
    상태 코드 설명
    200 요청이 성공적으로 처리되었습니다. 응답에서 전체 자원이 반환되었습니다(페이지 매김 없음).
    206 응답으로 반환된 부분 자원입니다(페이지 매김 포함).
    400 잘못된 요청. 가능한 이유:
    • 잘못된 경로 매개변수
    • 잘못된 URI
    404 기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다.

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

    이름 설명
    contactMedium 당사자에게 연락하기 위한 수단 목록입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 개인의 도시입니다.

    데이터 유형: 문자열

    contactMedium.country 개인의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAddress 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 파티 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다. 사용 중인 연락 채널의 종류를 지정하는 비즈니스 수준 속성을 나타냅니다.
    가능한 값:
    • 이메일
    • businessPhone
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 개인의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 개인의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    familyName 개인의 성입니다.

    데이터 유형: 문자열

    성별 개인의 성별입니다.

    데이터 유형: 문자열

    givenName 개인의 이름입니다.

    데이터 유형: 문자열

    href 사용자 또는 소비자 또는 접촉 창구 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열

    ID 검색할 사용자, 소비자 또는 접촉 창구 기록의 Sys_id입니다.

    테이블: 소비자[csm_consumer] 또는 연락처[customer_contact]

    데이터 유형: 문자열

    middleName 개인의 중간 이름입니다.

    데이터 유형: 문자열

    이름 사용자 또는 접촉 창구 개인의 사용자 이름입니다.

    데이터 유형: 문자열

    국적 개인의 국적입니다.

    데이터 유형: 문자열

    파티특성 당사자와 연결된 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [
     {
      "@type": "String",
      "name": " String",
      "value": "String",
      "valueType": "String"
     }
    ]
    partyCharacteristics.@type 서브클래싱할 때 서브클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 문자열특성
    • StringArrayCharacteristic
    • 정수 특성
    • 부울 특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 사용자, 소비자, 고객 접촉 창구가 있습니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id이 소비자[csm_consumer] 테이블 partyOrPartyRole.role 에 속하는 경우 소비자로 설정됩니다. 마찬가지로 sys_id가 연락처 [customer_contact] 테이블 partyOrPartyRole.role 에 속하는 경우 연락처 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "role":"String"
    }
    partyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    partyOrPartyRole.role 당사자 역할의 유형입니다.
    가능한 값:
    • 소비자
    • 연락처

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [
     {
      "role": "String",
      "partyOrPartyRole": {Object}
     }
    ]
    relatedParty.partyOrPartyRole 관련 당사자와 기록 컨텍스트에서 수행하는 역할에 대한 정보를 나타냅니다.

    예를 들어 역할이 회사인 경우 partyOrPartyRole.id 회사 [core_company] 기록 partyOrPartyRole.name 의 sys_id 포함하고 회사 이름을 포함합니다. 이 구조를 사용하면 당사자 참조와 해당 역할이 모두 명시적으로 정의되고 쉽게 식별할 수 있습니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "id": "String",
      "name": "String"
    }
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다.
    사용자에게 사용할 수 있는 값:
    • 조직
    • 개별

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    • 사용자에게 사용할 수 있는 값:
      • 회사
      • 부서
    • 고객에게 사용할 수 있는 값: 계정
    • 소비자에 사용할 수 있는 값: 사용자

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 현재 엔터티의 컨텍스트에서 관련 당사자가 수행하는 비즈니스 역할입니다.
    가능한 값:
    • 회사(관련 당사자가 사용자인 경우)
    • 부서(관련 당사자가 사용자인 경우)
    • 계정(관련 당사자가 고객인 경우)
    • 사용자(관련 당사자가 소비자인 경우)

    데이터 유형: 문자열

    상태 개인의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • 활성: 개인이 활성 상태입니다.
    • 비활성: 개인이 비활성 상태입니다.

    데이터 유형: 부울

    직위 개인의 접두사 또는 직위입니다. 예: Dr., Mr., Ms.).

    데이터 유형: 문자열

    cURL 요청

    인스턴스의 모든 당사자 관리 기록 목록을 조회합니다.

    curl"http://instance.servicenow.com/api/v1/sn_tmf_api/party/individual" \
    --request GET \
    --header "Accept:application/json" \
    --user 'user:password' 

    개별 접촉 창구 당사자의 응답 본문입니다.

    [
    {
       "id": "34d92aaa11f43110f877366201dea67b",
       "href": "api/sn_tmf_api/party/individual/34d92aaa11f43110f877366201dea67b",
       "name": "carlos.star",
       "givenName": "Carlos",
       "middleName": "",
       "familyName": "Star",
       "gender": "",
       "title": "",
       "partyCharacteristics": [
         {
           "name": "notification",
           "value": "Enable",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "preferredLanguage",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "dateFormat",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "timeFormat",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "timeZone",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "vip",
           "value": false,
           "valueType": "boolean",
           "@type": "BooleanCharacteristic"
         },
         {
           "name": "webServiceAccessOnly",
           "value": false,
           "valueType": "boolean",
           "@type": "BooleanCharacteristic"
         },
         {
           "name": "source",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "eduStatus",
           "value": "Faculty",
           "valueType": "string",
           "@type": "StringCharacteristic"
         }
       ],
       "contactMedium": [
         {
           "preferred": false,
           "mediumType": "email",
           "emailAddress": "carlos.star@example.com",
           "@type": "EmailContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "businessPhone",
           "phoneNumber": "",
           "@type": "BusinessPhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "homePhone",
           "phoneNumber": "",
           "@type": "HomePhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "mobilePhone",
           "phoneNumber": "",
           "@type": "MobilePhoneContactMedium"
         }
       ],
       "externalReference": [],
       "relatedParty": [
         {
           "role": "Company",
           "partyOrPartyRole": {
             "id": "9e2fd2ee11b43110f877366201dea674",
             "name": "Startech svcs",
             "@type": "Organization"
           }
         },
         {
           "role": "Department",
           "partyOrPartyRole": {
             "id": "",
             "name": "",
             "@type": "Organization"
           }
         }
       ],
       "status": "Active",
       "@type": "Individual",
       "partyOrPartyRole": {
         "name": "Contact",
         "@type": "Party"
       }
     }
    ]

    개별 소비자 당사자의 응답 본문입니다.

    [
    {
       "id": "168bfc6953a46210132bddeeff7b129f",
       "href": "api/sn_tmf_api/party/individual/168bfc6953a46210132bddeeff7b129f",
       "givenName": "yyyg",
       "middleName": "hhh",
       "familyName": "bhhhbjhh",
       "gender": "",
       "nationality": "",
       "title": "",
       "partyCharacteristics": [
         {
           "name": "notes",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "user",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "notification",
           "value": "Enable",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "preferredLanguage",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "dateFormat",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "timeFormat",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "timeZone",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         }
       ],
       "contactMedium": [
         {
           "preferred": false,
           "mediumType": "businessPhone",
           "phoneNumber": "",
           "@type": "BusinessPhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "homePhone",
           "phoneNumber": "",
           "@type": "HomePhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "mobilePhone",
           "phoneNumber": "",
           "@type": "MobilePhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "fax",
           "phoneNumber": "",
           "@type": "FaxContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "postalAddress",
           "@type": "GeographicalAddressContactMedium",
           "city": "ygyg",
           "locationId": "a39bfc6953a46210132bddeeff7b12b7",
           "country": "",
           "postCode": "hh",
           "stateOrProvince": "gyg",
           "street1": "hgg",
           "street2": ""
         }
       ],
       "externalReference": [],
       "relatedParty": [
         {
           "role": "User",
           "partyOrPartyRole": {
             "id": "",
             "name": "",
             "@type": "Individual"
           }
         }
       ],
       "status": "Active",
       "@type": "Individual",
       "partyOrPartyRole": {
         "name": "Consumer",
         "@type": "Party"
       }
     }
    ]

    업체 관리 - GET /api/sn_tmf_api/v1/party/individual/{id}

    소비자 [csm_consumer] 또는 연락처 [customer_contact] 테이블에서 지정된 기록을 조회합니다. 특정 필드별로 결과를 필터링할 수 있습니다.

    URL 형식

    버전 관리된 URL: /api/sn_tmf_api/{api_version}/party/individual

    기본 URL: /api/sn_tmf_api/v1/party/individual

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    ID 검색할 소비자 또는 접촉 창구 기록의 Sys_id 또는 external_id입니다.

    테이블: 소비자[csm_consumer] 또는 연락처[customer_contact]

    데이터 유형: 문자열

    표 14. 쿼리 매개변수
    이름 설명
    필드 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다.
    유효한 필드:
    • @type
    • familyName
    • 성별
    • givenName
    • href
    • ID
    • middleName
    • 이름
    • 국적
    • 상태
    • 직위

    데이터 유형: 문자열

    기본값: 모든 필드 반환

    표 15. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    안 함

    헤더

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

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

    기본값: application/json

    표 17. 응답 헤더
    머리글 설명
    안 함

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 18. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

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

    이름 설명
    contactMedium 당사자에게 연락하기 위한 수단 목록입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 개인의 도시입니다.

    데이터 유형: 문자열

    contactMedium.country 개인의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAddress 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 파티 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다. 사용 중인 연락 채널의 종류를 지정하는 비즈니스 수준 속성을 나타냅니다.
    가능한 값:
    • 이메일
    • businessPhone
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 개인의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 개인의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    familyName 개인의 성입니다.

    데이터 유형: 문자열

    성별 개인의 성별입니다.

    데이터 유형: 문자열

    givenName 개인의 이름입니다.

    데이터 유형: 문자열

    href 사용자 또는 소비자 또는 접촉 창구 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열

    ID 검색할 사용자, 소비자 또는 접촉 창구 기록의 Sys_id입니다.

    테이블: 소비자[csm_consumer] 또는 연락처[customer_contact]

    데이터 유형: 문자열

    middleName 개인의 중간 이름입니다.

    데이터 유형: 문자열

    이름 사용자 또는 접촉 창구 개인의 사용자 이름입니다.

    데이터 유형: 문자열

    국적 개인의 국적입니다.

    데이터 유형: 문자열

    파티특성 당사자와 연결된 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [
     {
      "@type": "String",
      "name": " String",
      "value": "String",
      "valueType": "String"
     }
    ]
    partyCharacteristics.@type 서브클래싱할 때 서브클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 문자열특성
    • StringArrayCharacteristic
    • 정수 특성
    • 부울 특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 사용자, 소비자, 고객 접촉 창구가 있습니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id이 소비자[csm_consumer] 테이블 partyOrPartyRole.role 에 속하는 경우 소비자로 설정됩니다. 마찬가지로 sys_id가 연락처 [customer_contact] 테이블 partyOrPartyRole.role 에 속하는 경우 연락처 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "role":"String"
    }
    partyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    partyOrPartyRole.role 당사자 역할의 유형입니다.
    가능한 값:
    • 소비자
    • 연락처

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [
     {
      "role": "String",
      "partyOrPartyRole": {Object}
     }
    ]
    relatedParty.partyOrPartyRole 관련 당사자와 기록 컨텍스트에서 수행하는 역할에 대한 정보를 나타냅니다.

    예를 들어 역할이 회사인 경우 partyOrPartyRole.id 회사 [core_company] 기록 partyOrPartyRole.name 의 sys_id 포함하고 회사 이름을 포함합니다. 이 구조를 사용하면 당사자 참조와 해당 역할이 모두 명시적으로 정의되고 쉽게 식별할 수 있습니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "id": "String",
      "name": "String"
    }
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다.
    사용자에게 사용할 수 있는 값:
    • 조직
    • 개별

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    • 사용자에게 사용할 수 있는 값:
      • 회사
      • 부서
    • 고객에게 사용할 수 있는 값: 계정
    • 소비자에 사용할 수 있는 값: 사용자

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 현재 엔터티의 컨텍스트에서 관련 당사자가 수행하는 비즈니스 역할입니다.
    가능한 값:
    • 회사(관련 당사자가 사용자인 경우)
    • 부서(관련 당사자가 사용자인 경우)
    • 계정(관련 당사자가 고객인 경우)
    • 사용자(관련 당사자가 소비자인 경우)

    데이터 유형: 문자열

    상태 개인의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • 활성: 개인이 활성 상태입니다.
    • 비활성: 개인이 비활성 상태입니다.

    데이터 유형: 부울

    직위 개인의 접두사 또는 직위입니다. 예: Dr., Mr., Ms.).

    데이터 유형: 문자열

    cURL 요청

    테이블에서 지정된 기록 12345를 조회합니다.

    curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/individual/12345" \
    --request GET \
    --header "Accept:application/json" \
    --user 'user':'password' \

    응답 본문.

    {
      "id": "12345",
      "givenName": "JohnTest6",
      "middleName": "A.",
      "familyName": "Doe",
      "gender": "male",
      "nationality": "American",
      "title": "Mr",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "emailAddress": "john.doe18723@example.com",
          "@type": "EmailContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "mobilePhone",
          "phoneNumber": "+1-202-555-0198",
          "@type": "PhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "businessPhone",
          "phoneNumber": "+1-202-555-0198",
          "@type": "BusinessPhoneContactMedium"
        },
        {
          "preferred":false,
          "mediumType":"faxPhone",
          "phoneNumber":"123456789",
          "@type":"FaxContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "homePhone",
          "phoneNumber": "+1-202-555-0198",
          "@type": "HomePhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "@type": "GeographicAddressContactMedium",
          "locationId":"25ab9e240a0a0bb3009eb9ef8dd0a2c0",
          "city": "Town",
          "country": "USA",
          "postCode": "07960",
          "stateOrProvince": "New Jersey",
          "street1": "1820 Harris Houston Road, Charlotte",
          "street2": "East Tower - 10th Floor"
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "@type": "GeographicAddressContactMedium",
          "locationId":"25aba17a0a0a0bb3007efd809d6e695c",
          "city": "Webster",
          "country": "USA",
          "postCode": "76022",
          "stateOrProvince": "TN",
          "street1": "17077 Texas Avenue, Webster",
          "street2": "East Tower - 11th Floor"
        }
      ],
      "externalReference": [
        {
          "externalIdentifierType": "facebook",
          "id": "http://facebook.com/johndoe"
        }
      ],
      "partyCharacteristic": [
        {
          "name": "notes",
          "value": "notes about the consumer",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "dateFormat",
          "value": "dd-mm-yyyy",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "timeformat",
          "value": "hh.mm.ss (12 hour)",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "notification",
          "value": "Enable",
          "valueType": "string",
          "@type": "string"
        }
      ],
      "relatedParty": [
        {
          "role": "User",
          "partyOrPartyRole": {
            "id": "36901a6381116a50f8776cfcbee15f3c",
            "name": "Hr",
            "@type": "Individual"
          }
        }
      ],
      "status": "active",
      "@type": "Individual",
      "partyOrPartyRole": {
        "role": "Consumer",
        "@type":"Party"
      }
    }

    업체 관리 – GET/api/ sn_tmf_api/v1/party/organization/{id}

    계정 [customer_account] 테이블에서 지정된 기록을 조회합니다. 특정 필드 또는 ID를 기준으로 결과를 필터링할 수 있습니다.

    URL 형식

    버전이 지정된 URL: /api/sn_tmf_api/v1/party/organization/{id}

    기본 URL: /api/sn_tmf_api/v1/party/organization/{id}

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    ID 검색할 회사 또는 계정 기록의 Sys_id입니다.

    테이블: 계정 [customer_account] 또는 회사 [csm_company]

    데이터 유형: 문자열

    표 20. 쿼리 매개변수
    이름 설명
    필드 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다.
    유효한 필드:
    • @type
    • href
    • ID
    • 법적 이름
    • 이름
    • 상태
    • 거래 이름

    데이터 유형: 문자열

    기본값: 모든 필드 반환

    ID sys_id별로 당사자 관리를 필터링합니다. 지정된 sys_ids가 응답에 반환됩니다.

    데이터 유형: 문자열

    제한 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다.

    데이터 유형: 숫자

    기본값: 20

    최대: 100

    오프셋 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다.

    데이터 유형: 숫자

    기본값: 0

    표 21. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    안 함

    헤더

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

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

    기본값: application/json

    표 23. 응답 헤더
    머리글 설명
    안 함

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 24. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

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

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

    이름 설명
    @type 이 값은 항상 조직입니다.

    데이터 유형: 문자열

    contactMedium 당사자에게 연락하기 위한 수단 목록입니다. 연락 매체는 개인 또는 조직과 같은 당사자와 소통하거나 연락하는 방식을 나타냅니다. 예를 들어, 해당 당사자와 연결된 연락 채널 또는 방법입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 접촉 매체의 유형입니다. 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 조직의 시입니다.

    데이터 유형: 문자열

    contactMedium.country 조직의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAdress 조직 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다.
    가능한 값:
    • businessPhone
    • 이메일
    • 팩스 전화
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 조직 접촉 창구의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 조직의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    externalReference 외부 시스템에 있는 업체의 식별자 목록입니다.

    데이터 유형: 객체 배열

    "externalReference": [ 
     { 
      "externalIdentifierType": "String", 
      "name": "String" 
     }
    ]
    externalReference.externalIdentifierType 외부 시스템 내의 엔터티 유형입니다.

    데이터 유형: 문자열

    externalReference.name 사람이 판독할 수 있는 외부 시스템 또는 참조 이름입니다.

    데이터 유형: 문자열

    href 계정 기록에 대한 상대 링크(URI)입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    ID 외부 엔터티 계정 기록의 Sys_id입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    법적 이름 조직의 법적 이름입니다.

    데이터 유형: 문자열

    이름 조직의 이름입니다.

    데이터 유형: 문자열

    파티특성 당사자가 취할 수 있는 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [ 
     { 
      "@type": "String" 
      "name": "String",   
      "value": "String", 
      "valueType": "String"
     } 
    ]
    partyCharacteristics.@type 서브클래싱 시, @type 하위 클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 부울 특성
    • 정수 특성
    • StringArrayCharacteristic
    • 문자열특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 회사 또는 계정입니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id가 계정 [customer_account] 테이블 partyOrPartyRole.role 에 속하는 경우 계정으로 설정됩니다. 마찬가지로 sys_id가 회사 [core_company] 테이블 partyOrPartyRole.role 에 속하는 경우 회사로 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole": {
      "@type": "String",
      "name":"String",
      "role":"String",
    }
    PartyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    PartyOrPartyRole.name 계정 또는 회사의 유형을 정의합니다.

    데이터 유형: 문자열

    PartyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 계정
    • 회사

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [ 
     { 
      "partyOrPartyRole": {Object},
      "role": "String"
     }
    ]
    relatedParty.partyOrPartyRole 이 당사자와 관련된 역할입니다.

    데이터 유형: 객체 배열

    "partyOrPartyRole": [ 
     { 
      "@type": "String", 
      "id": "String",
      "name": "String",
     }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다. 값은 항상 조직입니다.

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 연결된 특정 엔터티의 맥락에서 관련 당사자 또는 당사자 역할이 수행하는 역할입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    상태 조직의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • active: 조직이 활성 상태입니다.
    • 비활성: 조직이 비활성 상태입니다.

    데이터 유형: 부울

    거래 이름 조직이 거래하는 이름입니다.

    데이터 유형: 문자열

    cURL 요청

    다음 GET 호출은 sys_id 12345인 지정된 당사자 관리 조직 기록에 대한 필드를 반환합니다.

    curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/organization/12345" \
    --request GET \
    --header "Accept:application/json" \
    --user 'user':'password' \

    응답 본문.

    {
       "id": "2154376",
       "name": "Advances Super Computing",
       "href": "api/sn_tmf_api/party/organization/2154376",
       "legalName": "Hello",
       "tradingName": "World",
       "contactMedium": [
         {
           "preferred": "false",
           "mediumType": "email",
           "@type": "EmailContactMedium",
           "emailAddress": "user@servicenow.com"
         },
         {
           "preferred": "false",
           "mediumType": "phone",
           "@type": "PhoneContactMedium",
           "phone": "(555) 555-5555"
         },
         {
           "preferred": "false",
           "mediumType": "faxPhone",
           "@type": "FaxPhoneContactMedium",
           "fax_phone": ""
         }
       ],
       "externalReference": [
         {
           "externalIdentifierType": "Facebook",
           "name": "facebook.com"
         },
         {
           "externalIdentifierType": "Twitter",
           "name": "twitter.com"
         }
       ],
       "partyCharacteristic": [
         {
           "name": "notes",
           "value": "efdxcjkn ",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "registrationCode",
           "value": "23456789",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "accountCode",
           "value": "####30",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "identificationNumber",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "taxId",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "industry",
           "value": "",
           "valueType": "choice",
           "@type": "StringCharacteristic"
         },
         {
           "name": "numEmployees",
           "value": "",
           "valueType": "integer",
           "@type": "IntergerCharacteristic"
         },
         {
           "name": "rankTier",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "publiclyTraded",
           "value": "false",
           "valueType": "boolean",
           "@type": "BooleanCharacteristic"
         },
         {
           "name": "stockSymbol",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "stockPrice",
           "value": "",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "vendorType",
           "value": "Services, Applications",
           "valueType": "list",
           "@type": "StringArrayCharacteristic"
         },
         {
           "name": "marketCap",
           "value": "0",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "profits",
           "value": "0",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "revenuePerYear",
           "value": "0",
           "valueType": "string",
           "@type": "StringCharacteristic"
         },
         {
           "name": "website",
           "value": "sdfgh.com",
           "valueType": "string",
           "@type": "StringCharacteristic"
         }
       ],
       "relatedParty": [
         {
           "role": "primary",
           "partyOrPartyRole": {
             "@type": "Organization",
             "id": "b88d14843bc02300bfe04d72f3efc4cd",
             "name": "Amy Chen"
           }
         },
         {
           "role": "other",
           "partyOrPartyRole": {
             "@type": "Organization",
             "id": "016b7a36ff14a610f8dfffffffffffcb",
             "name": "Kutty"
           }
         },
         {
           "role": "other",
           "partyOrPartyRole": {
             "@type": "Organization",
             "id": "e8bb9d1aff94a210f8dfffffffffff1d",
             "name": "World"
           }
         }
       ],
       "organizationChildRelationship": [
         {
           "relationshipType": "partner_account",
           "organization": {
             "id": "9e2fd2ee11b43110f877366201dea674",
             "name": "Startech svcs",
             "href": "api/sn_tmf_api/party/organization/9e2fd2ee11b43110f877366201dea674",
             "@type": "Organization"
           }
         },
         {
           "relationshipType": "New type",
           "organization": {
             "id": "9e2fd2ee11b43110f877366201dea674",
             "name": "Startech svcs",
             "href": "api/sn_tmf_api/party/organization/9e2fd2ee11b43110f877366201dea674",
             "@type": "Organization"
           }
         },
         {
           "relationshipType": "child",
           "organization": {
             "id": "9e2fd2ee11b43110f877366201dea674",
             "name": "Startech svcs",
             "href": "api/sn_tmf_api/party/organization/null",
             "@type": "Organization"
           }
         }
       ],
       "organizationParentRelationship": {
         "relationshipType": "parent",
         "organization": {
           "id": "ffc68911c35420105252716b7d40dd55",
           "name": "Funco Intl",
           "href": "undefinedffc68911c35420105252716b7d40dd55",
           "@type": "Organization"
         }
       },
       "status": "inActive",
       "@type": "Organization",
       "partyOrPartyRole": {
         "name": "customer_partner_vendor_manufacturer",
         "role": "Account",
         "@type": "Party"
       }
     }

    업체 관리 - GET /api/sn_tmf_api/v1/party/organization

    회사 [core_company] 및 계정 [customer_account] 테이블에서 조직 수준 당사자 기록 을 검색합니다. 특정 필드 또는 ID를 기준으로 결과를 필터링할 수 있습니다.

    URL 형식

    버전이 지정된 URL: /api/sn_tmf_api/v1/party/organization

    기본 URL: /api/sn_tmf_api/v1/party/organization

    지원되는 요청 매개변수

    표 25. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    표 26. 쿼리 매개변수
    이름 설명
    필드 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다.
    유효한 필드:
    • @type
    • href
    • ID
    • 법적 이름
    • 이름
    • 상태
    • 거래 이름

    데이터 유형: 문자열

    기본값: 모든 필드 반환

    ID sys_id별로 당사자 관리를 필터링합니다. 지정된 sys_ids가 응답에 반환됩니다.

    데이터 유형: 문자열

    제한 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다.

    데이터 유형: 숫자

    기본값: 20

    최대: 100

    오프셋 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다.

    데이터 유형: 숫자

    기본값: 0

    표 27. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    contactMedium 당사자에게 연락하기 위한 수단 목록입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 개인의 도시입니다.

    데이터 유형: 문자열

    contactMedium.country 개인의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAddress 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 파티 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다. 사용 중인 연락 채널의 종류를 지정하는 비즈니스 수준 속성을 나타냅니다.
    가능한 값:
    • 이메일
    • businessPhone
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 개인의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 개인의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시/도에 있는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    familyName 개인의 성입니다.

    데이터 유형: 문자열

    성별 개인의 성별입니다.

    데이터 유형: 문자열

    givenName 개인의 이름입니다.

    데이터 유형: 문자열

    href 사용자 또는 소비자 또는 접촉 창구 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열

    middleName 개인의 중간 이름입니다.

    데이터 유형: 문자열

    이름 사용자 또는 접촉 창구 개인의 사용자 이름입니다.

    데이터 유형: 문자열

    국적 개인의 국적입니다.

    데이터 유형: 문자열

    파티특성 당사자와 연결된 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [
     {
      "@type": "String",
      "name": " String",
      "value": "String",
      "valueType": "String"
     }
    ]
    partyCharacteristics.@type 서브클래싱 시 이 매개변수는 서브클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 문자열특성
    • StringArrayCharacteristic
    • 정수 특성
    • 부울 특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 사용자, 소비자, 고객 접촉 창구가 있습니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id이 소비자[csm_consumer] 테이블 partyOrPartyRole.role 에 속하는 경우 소비자로 설정됩니다. 마찬가지로 sys_id가 연락처 [customer_contact] 테이블 partyOrPartyRole.role 에 속하는 경우 연락처 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "role":"String"
    }
    partyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    partyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 소비자
    • 연락처

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 및 당사자 역할 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [
      {
        "role": "String",
        "partyOrPartyRole": {Object}
      }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다.
    사용자에게 사용할 수 있는 값:
    • 조직
    • 개별

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id
    업체 관리 또는 업체 역할 관리 시스템에서 연결된 엔터티의 ID입니다.
    • 사용자에게 사용할 수 있는 값:
      • 회사
      • 부서
    • 고객에게 사용할 수 있는 값: 계정
    • 소비자에 사용할 수 있는 값: 사용자

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 현재 엔터티의 컨텍스트에서 관련 당사자가 수행하는 비즈니스 역할입니다.
    가능한 값:
    • 회사(관련 당사자가 사용자인 경우)
    • 부서(관련 당사자가 사용자인 경우)
    • 계정(관련 당사자가 고객인 경우)
    • 사용자(관련 당사자가 소비자인 경우)

    데이터 유형: 문자열

    상태 개인의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • 활성: 개인이 활성 상태입니다.
    • 비활성: 개인이 활성 상태가 아닙니다.

    데이터 유형: 부울

    직위 개인의 접두사 또는 직위입니다. 예: Dr., Mr., Ms.).

    데이터 유형: 문자열

    헤더

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

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

    기본값: application/json

    표 29. 응답 헤더
    머리글 설명
    안 함

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 30. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

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

    이름 설명
    없음

    cURL 요청

    엔터프라이즈와 관련된 모든 조직 기록이 반환됩니다.

    curl"http://instance.servicenow.com/api/sn_tmf_api/v1/party/organization" \
    --request GET \
    --header "Accept:application/json" \
    --user 'user':'password'

    응답 본문.

    [
      {
        "id": "0bd6717c184da610f87765359bc696d3",
        "name": "SERVICENOW 144",
        "href": "api/sn_tmf_api/party/organization0bd6717c184da610f87765359bc696d3",
        "legalName": "",
        "tradingName": "",
        "contactMedium": [
          {
            "preferred": "false",
            "mediumType": "email",
            "@type": "EmailContactMedium",
            "emailAddress": "user@email.com"
          },
          {
            "preferred": "false",
            "mediumType": "phone",
            "@type": "PhoneContactMedium",
            "phone": "+1-555-555-5555"
          },
          {
            "preferred": "false",
            "mediumType": "faxPhone",
            "@type": "FaxPhoneContactMedium",
            "fax_phone": ""
          }
        ],
        "externalReference": [
          {
            "externalIdentifierType": "Instagram",
            "name": ""
          }
        ],
        "partyCharacteristic": [
          {
            "name": "notes",
            "value": "Testing for update the notes",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "registrationCode",
            "value": "111122112211",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "accountCode",
            "value": "accountcode1",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "identificationNumber",
            "value": "",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "taxId",
            "value": "CTNUM1000123",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "industry",
            "value": "technology_services",
            "valueType": "choice",
            "@type": "StringCharacteristic"
          },
          {
            "name": "numEmployees",
            "value": "",
            "valueType": "integer",
            "@type": "IntergerCharacteristic"
          },
          {
            "name": "rankTier",
            "value": "rankTier",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "publiclyTraded",
            "value": "false",
            "valueType": "boolean",
            "@type": "BooleanCharacteristic"
          },
          {
            "name": "stockSymbol",
            "value": "Market",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "stockPrice",
            "value": "1000",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "vendorType",
            "value": "Hardware",
            "valueType": "list",
            "@type": "StringArrayCharacteristic"
          },
          {
            "name": "marketCap",
            "value": "0",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "profits",
            "value": "0",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "revenuePerYear",
            "value": "0",
            "valueType": "string",
            "@type": "StringCharacteristic"
          },
          {
            "name": "website",
            "value": "",
            "valueType": "string",
            "@type": "StringCharacteristic"
          }
        ],
        "relatedParty": [],
        "organizationChildRelationship": [
          {
            "relationshipType": "Partner Account",
            "organization": {
              "id": "396b47201841a610f87765359bc696cf",
              "name": "child",
              "href": "api/sn_tmf_api/party/organization396b47201841a610f87765359bc696cf",
              "@type": "Organization"
            }
          }
        ],
        "organizationParentRelationship": {
          "relationshipType": "parent",
          "organization": {
            "id": "9e2fd2ee11b43110f877366201dea674",
            "name": "Startech svcs",
            "href": "api/sn_tmf_api/party/organization9e2fd2ee11b43110f877366201dea674",
            "@type": "Organization"
          }
        },
        "@type": "Organization",
        "partyOrPartyRole": {
          "name": "customer_partner",
          "role": "Account",
          "@type": "Party"
        }
      }
    ]

    업체 관리 – PATCH/api/sn_tmf_api/v1/party/individual/{id}

    전체 자원을 바꾸지 않고 소비자 [csm_consumer] 또는 연락처 [customer_contact] 테이블에서 기존 개별 업체 기록을 업데이트합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_tmf_api/v1/party/individual

    기본 URL: /api/sn_tmf_api/v1/party/individual

    지원되는 요청 매개변수

    표 31. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    ID 소비자 또는 접촉 창구의 Sys_id입니다.

    테이블: 소비자[csm_consumer] 또는 연락처[customer_contact]

    데이터 유형: 문자열

    표 32. 쿼리 매개변수
    이름 설명
    안 함
    표 33. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    contactMedium 당사자에게 연락하기 위한 수단 목록입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 개인의 도시입니다.

    데이터 유형: 문자열

    contactMedium.country 개인의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAddress 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 파티 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다. 사용 중인 연락 채널의 종류를 지정하는 비즈니스 수준 속성을 나타냅니다.
    가능한 값:
    • 이메일
    • businessPhone
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 개인의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 개인의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시/도에 있는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    familyName 개인의 성입니다.

    데이터 유형: 문자열

    성별 개인의 성별입니다.

    데이터 유형: 문자열

    givenName 개인의 이름입니다.

    데이터 유형: 문자열

    href 사용자 또는 소비자 또는 접촉 창구 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열

    middleName 개인의 중간 이름입니다.

    데이터 유형: 문자열

    이름 사용자 또는 접촉 창구 개인의 사용자 이름입니다.

    데이터 유형: 문자열

    국적 개인의 국적입니다.

    데이터 유형: 문자열

    파티특성 당사자와 연결된 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [
     {
      "@type": "String",
      "name": " String",
      "value": "String",
      "valueType": "String"
     }
    ]
    partyCharacteristics.@type 서브클래싱 시 이 매개변수는 서브클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 문자열특성
    • StringArrayCharacteristic
    • 정수 특성
    • 부울 특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 사용자, 소비자, 고객 접촉 창구가 있습니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id이 소비자[csm_consumer] 테이블 partyOrPartyRole.role 에 속하는 경우 소비자로 설정됩니다. 마찬가지로 sys_id가 연락처 [customer_contact] 테이블 partyOrPartyRole.role 에 속하는 경우 연락처 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "role":"String"
    }
    partyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    partyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 소비자
    • 연락처

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 및 당사자 역할 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [
      {
        "role": "String",
        "partyOrPartyRole": {Object}
      }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다.
    사용자에게 사용할 수 있는 값:
    • 조직
    • 개별

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id
    업체 관리 또는 업체 역할 관리 시스템에서 연결된 엔터티의 ID입니다.
    • 사용자에게 사용할 수 있는 값:
      • 회사
      • 부서
    • 고객에게 사용할 수 있는 값: 계정
    • 소비자에 사용할 수 있는 값: 사용자

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 현재 엔터티의 컨텍스트에서 관련 당사자가 수행하는 비즈니스 역할입니다.
    가능한 값:
    • 회사(관련 당사자가 사용자인 경우)
    • 부서(관련 당사자가 사용자인 경우)
    • 계정(관련 당사자가 고객인 경우)
    • 사용자(관련 당사자가 소비자인 경우)

    데이터 유형: 문자열

    상태 개인의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • 활성: 개인이 활성 상태입니다.
    • 비활성: 개인이 활성 상태가 아닙니다.

    데이터 유형: 부울

    직위 개인의 접두사 또는 직위입니다. 예: Dr., Mr., Ms.).

    데이터 유형: 문자열

    헤더

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

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

    기본값: application/json

    표 35. 응답 헤더
    머리글 설명
    안 함

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 36. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

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

    이름 설명
    contactMedium 당사자에게 연락하기 위한 수단 목록입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 개인의 도시입니다.

    데이터 유형: 문자열

    contactMedium.country 개인의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAddress 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 파티 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다. 사용 중인 연락 채널의 종류를 지정하는 비즈니스 수준 속성을 나타냅니다.
    가능한 값:
    • 이메일
    • businessPhone
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 개인의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 개인의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    familyName 개인의 성입니다.

    데이터 유형: 문자열

    성별 개인의 성별입니다.

    데이터 유형: 문자열

    givenName 개인의 이름입니다.

    데이터 유형: 문자열

    href 사용자 또는 소비자 또는 접촉 창구 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열

    ID 검색할 사용자, 소비자 또는 접촉 창구 기록의 Sys_id입니다.

    테이블: 소비자[csm_consumer] 또는 연락처[customer_contact]

    데이터 유형: 문자열

    middleName 개인의 중간 이름입니다.

    데이터 유형: 문자열

    이름 사용자 또는 접촉 창구 개인의 사용자 이름입니다.

    데이터 유형: 문자열

    국적 개인의 국적입니다.

    데이터 유형: 문자열

    파티특성 당사자와 연결된 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [
     {
      "@type": "String",
      "name": " String",
      "value": "String",
      "valueType": "String"
     }
    ]
    partyCharacteristics.@type 서브클래싱할 때 서브클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 문자열특성
    • StringArrayCharacteristic
    • 정수 특성
    • 부울 특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 사용자, 소비자, 고객 접촉 창구가 있습니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id이 소비자[csm_consumer] 테이블 partyOrPartyRole.role 에 속하는 경우 소비자로 설정됩니다. 마찬가지로 sys_id가 연락처 [customer_contact] 테이블 partyOrPartyRole.role 에 속하는 경우 연락처 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "role":"String"
    }
    partyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    partyOrPartyRole.role 당사자 역할의 유형입니다.
    가능한 값:
    • 소비자
    • 연락처

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [
     {
      "role": "String",
      "partyOrPartyRole": {Object}
     }
    ]
    relatedParty.partyOrPartyRole 관련 당사자와 기록 컨텍스트에서 수행하는 역할에 대한 정보를 나타냅니다.

    예를 들어 역할이 회사인 경우 partyOrPartyRole.id 회사 [core_company] 기록 partyOrPartyRole.name 의 sys_id 포함하고 회사 이름을 포함합니다. 이 구조를 사용하면 당사자 참조와 해당 역할이 모두 명시적으로 정의되고 쉽게 식별할 수 있습니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "id": "String",
      "name": "String"
    }
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다.
    사용자에게 사용할 수 있는 값:
    • 조직
    • 개별

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    • 사용자에게 사용할 수 있는 값:
      • 회사
      • 부서
    • 고객에게 사용할 수 있는 값: 계정
    • 소비자에 사용할 수 있는 값: 사용자

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 현재 엔터티의 컨텍스트에서 관련 당사자가 수행하는 비즈니스 역할입니다.
    가능한 값:
    • 회사(관련 당사자가 사용자인 경우)
    • 부서(관련 당사자가 사용자인 경우)
    • 계정(관련 당사자가 고객인 경우)
    • 사용자(관련 당사자가 소비자인 경우)

    데이터 유형: 문자열

    상태 개인의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • 활성: 개인이 활성 상태입니다.
    • 비활성: 개인이 비활성 상태입니다.

    데이터 유형: 부울

    직위 개인의 접두사 또는 직위입니다. 예: Dr., Mr., Ms.).

    데이터 유형: 문자열

    cURL 요청

    전체 자원을 바꾸지 않고 소비자 [csm_consumer] 또는 연락처 [customer_contact] 테이블에서 기존의 개별 당사자 기록을 sys_id 12345로 업데이트합니다.

    curl "http://localhost:8080/api/sn_tmf_api/v1/party/Individual/12345" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user 'user':'password'
    --data "{
      \"name\": \"John.Doe\",
      \"givenName\": \"John\",
      \"middleName\": \"A.\",
      \"familyName\": \"Doe\",
      \"gender\": \"male\",
      \"nationality\": \"American\",
      \"title\": \"Mr\",
      \"contactMedium\": [
        {
          \"preferred\": true,
          \"mediumType\": \"email\",
          \"emailAddress\": \"john.doe@gmail.com\",
          \"@type\": \"EmailContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"businessPhone\",
          \"phoneNumber\": \"+1-202-555-0188\",
          \"@type\": \"PhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"homePhone\",
          \"phoneNumber\": \"+1-202-555-0198\",
          \"@type\": \"HomePhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"postalAddress\",
          \"@type\": \"GeographicAddressContactMedium\",
          \"locationId\":\"92656927259338967\",
          \"city\": \"Morristown\",
          \"country\": \"USA\",
          \"postCode\": \"07960\",
          \"stateOrProvince\": \"New Jersey\",
          \"street1\": \"240 Headquarters Plazza\", 
          \"street2\": \"East Tower - 10th Floor\"
        }
      ],
      \"partyCharacteristic\": [
        {
            \"name\": \"notification\",
            \"value\": \"enable\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
        },
        {
            \"name\": \"dateFormat\",
            \"value\": \"MM/DD/YYYY\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
        },
        {
            \"name\": \"timeFormat\",
            \"value\": \"12-hour\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
        },
        {
            \"name\": \"timeZone\",
            \"value\": \"EST\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
        },
        {
            \"name\": \"vip\",
            \"value\": true,
            \"valueType\": \"boolean\",
            \"@type\": \"string\"
        },
        {
            \"name\": \"webServiceAccessOnly\",
            \"value\": false,
            \"valueType\": \"boolean\",
            \"@type\": \"string\"
        },
        {
            \"name\": \"source\",
            \"value\": \"Third-party system\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
        },
        {
            \"name\": \"eduStatus\",
            \"value\": \"Graduated\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
        }
      ],
      \"relatedParty\": [
        {
          \"role\": \"Company\",
          \"partyOrPartyRole\": {
            \"id\": \"86c1f3193790200044e0bfc8bcbe5d95\",
            \"name\": \"Acme Corporation\",
            \"@type\": \"Organization\"
          }
        },
        {
          \"role\": \"Department\",
          \"partyOrPartyRole\": {
            \"id\": \"c3fdd27a7b9822105e0d5494548cb6b0\",
            \"name\": \"Acme Corporation\",
            \"@type\": \"Organization\"
          }
        }
      ],
      \"status\": \"active\",
      \"@type\": \"Individual\",
      \"partyOrPartyRole\": {
        \"role\": \"Consumer\",
        \"@type\":\"Party\"
      }
    }" \

    응답 본문.

    {
       "name": "Jane Smith",
      "givenName": "Jane",
      "middleName": "B.",
      "familyName": "Smith",
      "gender": "female",
      "nationality": "American",
      "title": "Ms",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "emailAddress": "jane.smith@example.com",
          "@type": "EmailContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "mobilePhone",
          "phoneNumber": "+1-416-555-1234",
          "@type": "PhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "businessPhone",
          "phoneNumber": "+1-416-555-5678",
          "@type": "BusinessPhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "fax",
          "fax": "987654321",
          "@type": "FaxContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "homePhone",
          "phoneNumber": "+1-416-555-4321",
          "@type": "HomePhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "@type": "GeographicAddressContactMedium",
          "locationId": "03e588a17be062105e0d5494548cb68c",
          "city": "Toronto",
          "country": "Canada",
          "postCode": "M5H 2N2",
          "stateOrProvince": "Ontario",
          "street1": "123 Queen St W",
          "street2": "Suite 1500"
        }
      ],
      "externalReference": [
        {
          "externalIdentifierType": "linkedin",
          "id": "http://linkedin.com/in/janesmith"
        }
      ],
      "partyCharacteristic": [
        {
          "name": "notes",
          "value": "General consumer information.",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "userName",
          "value": "janesmith",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "vip",
          "value": false,
          "valueType": "boolean",
          "@type": "string"
        },
        {
          "name": "source",
          "value": "CRM System",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "dateFormat",
          "value": "yyyy-mm-dd",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "timeformat",
          "value": "HH:mm:ss (24 hour)",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "notification",
          "value": "Disabled",
          "valueType": "string",
          "@type": "string"
        }
      ],
      "relatedParty": [
        {
          "role": "User",
          "partyOrPartyRole": {
            "id": "c456def03710200044e0bfc8bcbe5d99",
            "name": "Global Corp",
            "@type": "Individual"
          }
        }
      ],
      "status": "active",
      "@type": "Individual",
      "partyOrPartyRole": {
        "role": "Consumer",
        "@type": "Party"
      },
       "warning": [
        "relatedParty[0] is incorrect. User does not exist"
      ]
    }

    업체 관리 - PATCH /api/sn_tmf_api/v1/party/organization/{id}

    전체 자원을 바꾸지 않고 계정 [customer_account] 테이블에서 기존의 개별 당사자 기록을 업데이트합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_tmf_api/v1/party/organization/{id}

    기본 URL: /api/sn_tmf_api/v1/party/organization/{id}

    지원되는 요청 매개변수

    표 37. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    표 38. 쿼리 매개변수
    이름 설명
    안 함
    표 39. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    @type 이 값은 항상 조직입니다.

    데이터 유형: 문자열

    contactMedium 당사자에게 연락하기 위한 수단 목록입니다. 연락 매체는 개인 또는 조직과 같은 당사자와 소통하거나 연락하는 방식을 나타냅니다. 예를 들어, 해당 당사자와 연결된 연락 채널 또는 방법입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 접촉 매체의 유형입니다. 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 조직의 시입니다.

    데이터 유형: 문자열

    contactMedium.country 조직의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAdress 조직 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다.
    가능한 값:
    • businessPhone
    • 이메일
    • 팩스 전화
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 조직 접촉 창구의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 조직의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    externalReference 외부 시스템에 있는 업체의 식별자 목록입니다.

    데이터 유형: 객체 배열

    "externalReference": [ 
     { 
      "externalIdentifierType": "String", 
      "name": "String" 
     }
    ]
    externalReference.externalIdentifierType 외부 시스템 내의 엔터티 유형입니다.

    데이터 유형: 문자열

    externalReference.name 사람이 판독할 수 있는 외부 시스템 또는 참조 이름입니다.

    데이터 유형: 문자열

    href 계정 기록에 대한 상대 링크(URI)입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    ID 외부 엔터티 계정 기록의 Sys_id입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    법적 이름 조직의 법적 이름입니다.

    데이터 유형: 문자열

    이름 조직의 이름입니다.

    데이터 유형: 문자열

    파티특성 당사자가 취할 수 있는 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [ 
     { 
      "@type": "String" 
      "name": "String",   
      "value": "String", 
      "valueType": "String"
     } 
    ]
    partyCharacteristics.@type 서브클래싱 시, @type 하위 클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 부울 특성
    • 정수 특성
    • StringArrayCharacteristic
    • 문자열특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 회사 또는 계정입니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id가 계정 [customer_account] 테이블 partyOrPartyRole.role 에 속하는 경우 계정으로 설정됩니다. 마찬가지로 sys_id가 회사 [core_company] 테이블 partyOrPartyRole.role 에 속하는 경우 회사로 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole": {
      "@type": "String",
      "name":"String",
      "role":"String",
    }
    PartyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    PartyOrPartyRole.name 계정 또는 회사의 유형을 정의합니다.

    데이터 유형: 문자열

    PartyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 계정
    • 회사

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [ 
     { 
      "partyOrPartyRole": {Object},
      "role": "String"
     }
    ]
    relatedParty.partyOrPartyRole 이 당사자와 관련된 역할입니다.

    데이터 유형: 객체 배열

    "partyOrPartyRole": [ 
     { 
      "@type": "String", 
      "id": "String",
      "name": "String",
     }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다. 값은 항상 조직입니다.

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 연결된 특정 엔터티의 맥락에서 관련 당사자 또는 당사자 역할이 수행하는 역할입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    상태 조직의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • active: 조직이 활성 상태입니다.
    • 비활성: 조직이 비활성 상태입니다.

    데이터 유형: 부울

    거래 이름 조직이 거래하는 이름입니다.

    데이터 유형: 문자열

    헤더

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

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

    기본값: application/json

    표 41. 응답 헤더
    머리글 설명
    안 함

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 42. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

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

    이름 설명
    @type 이 값은 항상 조직입니다.

    데이터 유형: 문자열

    contactMedium 당사자에게 연락하기 위한 수단 목록입니다. 연락 매체는 개인 또는 조직과 같은 당사자와 소통하거나 연락하는 방식을 나타냅니다. 예를 들어, 해당 당사자와 연결된 연락 채널 또는 방법입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 접촉 매체의 유형입니다. 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 조직의 시입니다.

    데이터 유형: 문자열

    contactMedium.country 조직의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAdress 조직 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다.
    가능한 값:
    • businessPhone
    • 이메일
    • 팩스 전화
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 조직 접촉 창구의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 조직의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    externalReference 외부 시스템에 있는 업체의 식별자 목록입니다.

    데이터 유형: 객체 배열

    "externalReference": [ 
     { 
      "externalIdentifierType": "String", 
      "name": "String" 
     }
    ]
    externalReference.externalIdentifierType 외부 시스템 내의 엔터티 유형입니다.

    데이터 유형: 문자열

    externalReference.name 사람이 판독할 수 있는 외부 시스템 또는 참조 이름입니다.

    데이터 유형: 문자열

    href 계정 기록에 대한 상대 링크(URI)입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    ID 외부 엔터티 계정 기록의 Sys_id입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    법적 이름 조직의 법적 이름입니다.

    데이터 유형: 문자열

    이름 조직의 이름입니다.

    데이터 유형: 문자열

    파티특성 당사자가 취할 수 있는 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [ 
     { 
      "@type": "String" 
      "name": "String",   
      "value": "String", 
      "valueType": "String"
     } 
    ]
    partyCharacteristics.@type 서브클래싱 시, @type 하위 클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 부울 특성
    • 정수 특성
    • StringArrayCharacteristic
    • 문자열특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 회사 또는 계정입니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id가 계정 [customer_account] 테이블 partyOrPartyRole.role 에 속하는 경우 계정으로 설정됩니다. 마찬가지로 sys_id가 회사 [core_company] 테이블 partyOrPartyRole.role 에 속하는 경우 회사로 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole": {
      "@type": "String",
      "name":"String",
      "role":"String",
    }
    PartyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    PartyOrPartyRole.name 계정 또는 회사의 유형을 정의합니다.

    데이터 유형: 문자열

    PartyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 계정
    • 회사

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [ 
     { 
      "partyOrPartyRole": {Object},
      "role": "String"
     }
    ]
    relatedParty.partyOrPartyRole 이 당사자와 관련된 역할입니다.

    데이터 유형: 객체 배열

    "partyOrPartyRole": [ 
     { 
      "@type": "String", 
      "id": "String",
      "name": "String",
     }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다. 값은 항상 조직입니다.

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 연결된 특정 엔터티의 맥락에서 관련 당사자 또는 당사자 역할이 수행하는 역할입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    상태 조직의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • active: 조직이 활성 상태입니다.
    • 비활성: 조직이 비활성 상태입니다.

    데이터 유형: 부울

    거래 이름 조직이 거래하는 이름입니다.

    데이터 유형: 문자열

    cURL 요청

    이는 당사자 관리 조직 기록에 대해 지정된 필드를 반환합니다.

    curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/organization" \
    --request PATCH\
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user 'user':'password' \
    --data "{
      \"name\": \"SERVICENOW 144\",
      \"legalName\": \"Acme Corp Ltd.\",
      \"tradingName\": \"Acme Inc.\",
      \"contactMedium\": [
        {
          \"preferred\": true,
          \"mediumType\": \"email\",
          \"emailAddress\": \"athammhd@email.com\",
          \"@type\": \"EmailContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"phone\",
          \"phoneNumber\": \"+1-202-555-0198\",
          \"@type\": \"PhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"businessPhone\",
          \"phoneNumber\": \"+1-202-555-0198\",
          \"@type\": \"BusinessPhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"homePhone\",
          \"phoneNumber\": \"+1-202-555-0198\",
          \"@type\": \"HomePhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"postalAddress\",
          \"validFor\": {
            \"startDateTime\": \"2017-03-15T07:49:25.246Z\"
          },
          \"@type\": \"GeographicAddressContactMedium\",
          \"city\": \"chennai\",
          \"country\": \"INDIA\",
          \"postCode\": \"608001\",
          \"stateOrProvince\": \"tamil nadu\",
          \"street1\": \"samcon street\",
          \"street2\": \"adyar,chennai\"
        }
      ],
      \"externalReference\": [
        {
          \"externalIdentifierType\": \"Instagram\",
          \"id\": \"Instagram\"
        }
      ],
      \"partyCharacteristic\": [
        {
          \"name\": \"notes\",
          \"value\": \"Testing for update the notes\",
          \"valueType\": \"string\",
          \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"customer\",
          \"value\": \"true\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"registrationCode\",
          \"value\": \"001\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
         \"name\": \"vendorType\",
         \"value\": [\"Hardware\"],
         \"valueType\": \"array\",
          \"@type\": \"StringArrayCharacteristic\"
         },
         {
          \"name\": \"industry\",
          \"value\": \"technology_services\",
          \"valueType\": \"choice\",
            \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"taxId\",
          \"value\": \"CTNUM1000123\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"numEmployees\",
          \"value\": \"EMP1000\",
          \"valueType\": \"integer\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"rankTier\",
          \"value\": \"rankTier\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"publiclyTraded\",
          \"value\": \"false\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"stockSymbol\",
          \"value\": \"Market\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"stockPrice\",
          \"value\": \"1000\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"vendor\",
          \"value\": \"false\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"manufacturer\",
          \"value\": \"false\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"marketCap\",
          \"value\": \"0\",
          \"valueType\": \"currency\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"profits\",
          \"value\": \"0\",
          \"valueType\": \"currency\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"revenuePerYear\",
          \"value\": \"0\",
          \"valueType\": \"currency\",
           \"@type\": \"StringCharacteristics\"
        }
      ],
      \"relatedParty\": [
        {
          \"role\": \"primaryContact\",
          \"partyOrPartyRole\": {
            \"id\": \"eaf68911c35420105252716b7d40ddde\",
            \"name\": \"John Doe\",
            \"@type\": \"Individual\"
          }
        },
        {
          \"role\": \"other\",
          \"partyOrPartyRole\": {
            \"id\": \"776a22ea11f43110f877366201dea6b7\",
            \"name\": \"Mary Star\",
            \"@type\": \"Individual\"
          }
        }
      ],
      \"organizationChildRelationship\": [
        {
          \"relationshipType\": \"partneraccount\",
          \"organization\": {
            \"id\": \"0fef075b2fe06a10b79db3bf42faf31a\",
            \"name\": \"mhd\",
            \"@type\": \"Organization\"
          }
        }
      ],
      \"organizationParentRelationship\": 
        {
          \"relationshipType\": \"Account\",
          \"organization\": {
            \"id\": \"9e2fd2ee11b43110f877366201dea674\",
            \"name\": \"Global Holdings Ltd.\",
            \"@type\": \"Organization\"
          }
        },
      \"status\": \"active\",
      \"@type\": \"Organization\",
      \"partyOrPartyRole\": {
        \"@type\":\"Party\",
        \"name\":\"Customer\",
        \"role\": \"Account\" 
      }
    }" \

    응답 본문.

    {
      "name": "SERVICENOW 144",
      "legalName": "Acme Corp Ltd.",
      "tradingName": "Acme Inc.",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "emailAddress": "athammhd@email.com",
          "@type": "EmailContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "phone",
          "phoneNumber": "+1-202-555-0198",
          "@type": "PhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "businessPhone",
          "phoneNumber": "+1-202-555-0198",
          "@type": "BusinessPhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "homePhone",
          "phoneNumber": "+1-202-555-0198",
          "@type": "HomePhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "validFor": {
            "startDateTime": "2017-03-15T07:49:25.246Z"
          },
          "@type": "GeographicAddressContactMedium",
          "city": "chennai",
          "country": "INDIA",
          "postCode": "608001",
          "stateOrProvince": "tamil nadu",
          "street1": "samcon street",
          "street2": "adyar,chennai"
        }
      ],
      "externalReference": [
        {
          "externalIdentifierType": "Instagram",
          "id": "Instagram"
        }
      ],
      "partyCharacteristic": [
        {
          "name": "notes",
          "value": "Testing for update the notes",
          "valueType": "string",
          "@type": "StringCharacteristics"
        },
        {
          "name": "customer",
          "value": "true",
          "valueType": "boolean",
           "@type": "StringCharacteristics"
        },
        {
          "name": "registrationCode",
          "value": "001",
          "valueType": "string",
           "@type": "StringCharacteristics"
        },
        {
         "name": "vendorType",
         "value": ["Hardware"],
         "valueType": "array",
          "@type": "StringArrayCharacteristic"
         },
         {
          "name": "industry",
          "value": "technology_services",
          "valueType": "choice",
            "@type": "StringCharacteristics"
        },
        {
          "name": "taxId",
          "value": "CTNUM1000123",
          "valueType": "string",
           "@type": "StringCharacteristics"
        },
        {
          "name": "numEmployees",
          "value": "EMP1000",
          "valueType": "integer",
           "@type": "StringCharacteristics"
        },
        {
          "name": "rankTier",
          "value": "rankTier",
          "valueType": "string",
           "@type": "StringCharacteristics"
        },
        {
          "name": "publiclyTraded",
          "value": "false",
          "valueType": "boolean",
           "@type": "StringCharacteristics"
        },
        {
          "name": "stockSymbol",
          "value": "Market",
          "valueType": "string",
           "@type": "StringCharacteristics"
        },
        {
          "name": "stockPrice",
          "value": "1000",
          "valueType": "string",
           "@type": "StringCharacteristics"
        },
        {
          "name": "vendor",
          "value": "false",
          "valueType": "boolean",
           "@type": "StringCharacteristics"
        },
        {
          "name": "manufacturer",
          "value": "false",
          "valueType": "boolean",
           "@type": "StringCharacteristics"
        },
        {
          "name": "marketCap",
          "value": "0",
          "valueType": "currency",
           "@type": "StringCharacteristics"
        },
        {
          "name": "profits",
          "value": "0",
          "valueType": "currency",
           "@type": "StringCharacteristics"
        },
        {
          "name": "revenuePerYear",
          "value": "0",
          "valueType": "currency",
           "@type": "StringCharacteristics"
        }
      ],
      "relatedParty": [
        {
          "role": "primaryContact",
          "partyOrPartyRole": {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "John Doe",
            "@type": "Individual"
          }
        },
        {
          "role": "other",
          "partyOrPartyRole": {
            "id": "776a22ea11f43110f877366201dea6b7",
            "name": "Mary Star",
            "@type": "Individual"
          }
        }
      ],
      "organizationChildRelationship": [
        {
          "relationshipType": "partneraccount",
          "organization": {
            "id": "0fef075b2fe06a10b79db3bf42faf31a",
            "name": "mhd",
            "@type": "Organization"
          }
        }
      ],
      "organizationParentRelationship": 
        {
          "relationshipType": "Account",
          "organization": {
            "id": "9e2fd2ee11b43110f877366201dea674",
            "name": "Global Holdings Ltd.",
            "@type": "Organization"
          }
        },
      "status": "active",
      "@type": "Organization",
      "partyOrPartyRole": {
        "@type":"Party",
        "name":"Customer",
        "role": "Account" 
      }
    }

    업체 관리 - POST /api/sn_tmf_api/v1/party/individual

    소비자 [csm_consumer] 또는 연락처 [customer_contact] 테이블에 새 개별 당사자 관리 기록을 생성합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_tmf_api/v1/party/individual

    기본 URL: /api/sn_tmf_api/v1/party/individual

    지원되는 요청 매개변수

    표 43. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    표 44. 쿼리 매개변수
    이름 설명
    안 함
    표 45. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    contactMedium 당사자에게 연락하기 위한 수단 목록입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 개인의 도시입니다.

    데이터 유형: 문자열

    contactMedium.country 개인의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAddress 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 파티 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다. 사용 중인 연락 채널의 종류를 지정하는 비즈니스 수준 속성을 나타냅니다.
    가능한 값:
    • 이메일
    • businessPhone
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 개인의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 개인의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시/도에 있는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    familyName 개인의 성입니다.

    데이터 유형: 문자열

    성별 개인의 성별입니다.

    데이터 유형: 문자열

    givenName 개인의 이름입니다.

    데이터 유형: 문자열

    href 사용자 또는 소비자 또는 접촉 창구 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열

    middleName 개인의 중간 이름입니다.

    데이터 유형: 문자열

    이름 사용자 또는 접촉 창구 개인의 사용자 이름입니다.

    데이터 유형: 문자열

    국적 개인의 국적입니다.

    데이터 유형: 문자열

    파티특성 당사자와 연결된 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [
     {
      "@type": "String",
      "name": " String",
      "value": "String",
      "valueType": "String"
     }
    ]
    partyCharacteristics.@type 서브클래싱 시 이 매개변수는 서브클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 문자열특성
    • StringArrayCharacteristic
    • 정수 특성
    • 부울 특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 사용자, 소비자, 고객 접촉 창구가 있습니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id이 소비자[csm_consumer] 테이블 partyOrPartyRole.role 에 속하는 경우 소비자로 설정됩니다. 마찬가지로 sys_id가 연락처 [customer_contact] 테이블 partyOrPartyRole.role 에 속하는 경우 연락처 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "role":"String"
    }
    partyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    partyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 소비자
    • 연락처

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 및 당사자 역할 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [
      {
        "role": "String",
        "partyOrPartyRole": {Object}
      }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다.
    사용자에게 사용할 수 있는 값:
    • 조직
    • 개별

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id
    업체 관리 또는 업체 역할 관리 시스템에서 연결된 엔터티의 ID입니다.
    • 사용자에게 사용할 수 있는 값:
      • 회사
      • 부서
    • 고객에게 사용할 수 있는 값: 계정
    • 소비자에 사용할 수 있는 값: 사용자

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 현재 엔터티의 컨텍스트에서 관련 당사자가 수행하는 비즈니스 역할입니다.
    가능한 값:
    • 회사(관련 당사자가 사용자인 경우)
    • 부서(관련 당사자가 사용자인 경우)
    • 계정(관련 당사자가 고객인 경우)
    • 사용자(관련 당사자가 소비자인 경우)

    데이터 유형: 문자열

    상태 개인의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • 활성: 개인이 활성 상태입니다.
    • 비활성: 개인이 활성 상태가 아닙니다.

    데이터 유형: 부울

    직위 개인의 접두사 또는 직위입니다. 예: Dr., Mr., Ms.).

    데이터 유형: 문자열

    헤더

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

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

    기본값: application/json

    표 47. 응답 헤더
    머리글 설명
    안 함

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 48. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

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

    이름 설명
    contactMedium 당사자에게 연락하기 위한 수단 목록입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 개인의 도시입니다.

    데이터 유형: 문자열

    contactMedium.country 개인의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAddress 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 파티 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다. 사용 중인 연락 채널의 종류를 지정하는 비즈니스 수준 속성을 나타냅니다.
    가능한 값:
    • 이메일
    • businessPhone
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 개인의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 개인의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    familyName 개인의 성입니다.

    데이터 유형: 문자열

    성별 개인의 성별입니다.

    데이터 유형: 문자열

    givenName 개인의 이름입니다.

    데이터 유형: 문자열

    href 사용자 또는 소비자 또는 접촉 창구 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열

    ID 검색할 사용자, 소비자 또는 접촉 창구 기록의 Sys_id입니다.

    테이블: 소비자[csm_consumer] 또는 연락처[customer_contact]

    데이터 유형: 문자열

    middleName 개인의 중간 이름입니다.

    데이터 유형: 문자열

    이름 사용자 또는 접촉 창구 개인의 사용자 이름입니다.

    데이터 유형: 문자열

    국적 개인의 국적입니다.

    데이터 유형: 문자열

    파티특성 당사자와 연결된 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [
     {
      "@type": "String",
      "name": " String",
      "value": "String",
      "valueType": "String"
     }
    ]
    partyCharacteristics.@type 서브클래싱할 때 서브클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 문자열특성
    • StringArrayCharacteristic
    • 정수 특성
    • 부울 특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 사용자, 소비자, 고객 접촉 창구가 있습니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id이 소비자[csm_consumer] 테이블 partyOrPartyRole.role 에 속하는 경우 소비자로 설정됩니다. 마찬가지로 sys_id가 연락처 [customer_contact] 테이블 partyOrPartyRole.role 에 속하는 경우 연락처 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "role":"String"
    }
    partyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    partyOrPartyRole.role 당사자 역할의 유형입니다.
    가능한 값:
    • 소비자
    • 연락처

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [
     {
      "role": "String",
      "partyOrPartyRole": {Object}
     }
    ]
    relatedParty.partyOrPartyRole 관련 당사자와 기록 컨텍스트에서 수행하는 역할에 대한 정보를 나타냅니다.

    예를 들어 역할이 회사인 경우 partyOrPartyRole.id 회사 [core_company] 기록 partyOrPartyRole.name 의 sys_id 포함하고 회사 이름을 포함합니다. 이 구조를 사용하면 당사자 참조와 해당 역할이 모두 명시적으로 정의되고 쉽게 식별할 수 있습니다.

    데이터 유형: 객체

    "partyOrPartyRole":
    {
      "@type": "String",
      "id": "String",
      "name": "String"
    }
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다.
    사용자에게 사용할 수 있는 값:
    • 조직
    • 개별

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    • 사용자에게 사용할 수 있는 값:
      • 회사
      • 부서
    • 고객에게 사용할 수 있는 값: 계정
    • 소비자에 사용할 수 있는 값: 사용자

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 현재 엔터티의 컨텍스트에서 관련 당사자가 수행하는 비즈니스 역할입니다.
    가능한 값:
    • 회사(관련 당사자가 사용자인 경우)
    • 부서(관련 당사자가 사용자인 경우)
    • 계정(관련 당사자가 고객인 경우)
    • 사용자(관련 당사자가 소비자인 경우)

    데이터 유형: 문자열

    상태 개인의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • 활성: 개인이 활성 상태입니다.
    • 비활성: 개인이 비활성 상태입니다.

    데이터 유형: 부울

    직위 개인의 접두사 또는 직위입니다. 예: Dr., Mr., Ms.).

    데이터 유형: 문자열

    cURL 요청

    이렇게 하면 당사자 관리 개별 기록에 대해 지정된 필드가 반환됩니다.

    curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/individual" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user 'user':'password'
    --data "{
        \"id\": \"98765\",
        \"name\": \"Jane Smith\",
        \"givenName\": \"Jane\",
        \"middleName\": \"B.\",
        \"familyName\": \"Smith\",
        \"gender\": \"female\",
        \"nationality\": \"American\",
        \"title\": \"Ms\",
        \"contactMedium\": [
          {
            \"preferred\": true,
            \"mediumType\": \"email\",
            \"emailAddress\": \"jane.smith@example.com\",
            \"@type\": \"EmailContactMedium\"
          },
          {
            \"preferred\": false,
            \"mediumType\": \"mobilePhone\",
            \"phoneNumber\": \"+1-416-555-1234\",
            \"@type\": \"PhoneContactMedium\"
          },
          {
            \"preferred\": false,
            \"mediumType\": \"businessPhone\",
            \"phoneNumber\": \"+1-416-555-5678\",
            \"@type\": \"BusinessPhoneContactMedium\"
          },
          {
            \"preferred\": false,
            \"mediumType\": \"fax\",
            \"fax\": \"987654321\",
            \"@type\": \"FaxContactMedium\"
          },
          {
            \"preferred\": false,
            \"mediumType\": \"homePhone\",
            \"phoneNumber\": \"+1-416-555-4321\",
            \"@type\": \"HomePhoneContactMedium\"
          },
          {
            \"preferred\": false,
            \"mediumType\": \"postalAddress\",
            \"@type\": \"GeographicAddressContactMedium\",
            \"locationId\": \"12345678901234567\",
            \"city\": \"Toronto\",
            \"country\": \"Canada\",
            \"postCode\": \"M5H 2N2\",
            \"stateOrProvince\": \"Ontario\",
            \"street1\": \"123 Queen St W\",
            \"street2\": \"Suite 1500\"
          }
        ],
        \"externalReference\": [
          {
            \"externalIdentifierType\": \"linkedin\",
            \"id\": \"http://linkedin.com/in/janesmith\"
          }
        ],
        \"partyCharacteristic\": [
          {
            \"name\": \"notes\",
            \"value\": \"General consumer information.\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
          },
          {
            \"name\": \"userName\",
            \"value\": \"janesmith\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
          },
          {
            \"name\": \"vip\",
            \"value\": false,
            \"valueType\": \"boolean\",
            \"@type\": \"string\"
          },
          {
            \"name\": \"source\",
            \"value\": \"CRM System\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
          },
          {
            \"name\": \"dateFormat\",
            \"value\": \"yyyy-mm-dd\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
          },
          {
            \"name\": \"timeformat\",
            \"value\": \"HH:mm:ss (24 hour)\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
          },
          {
            \"name\": \"notification\",
            \"value\": \"Disabled\",
            \"valueType\": \"string\",
            \"@type\": \"string\"
          }
        ],
        \"relatedParty\": [
          {
            \"role\": \"User\",
            \"partyOrPartyRole\": {
              \"id\": \"c456def03710200044e0bfc8bcbe5d99\",
              \"name\": \"Global Corp\",
              \"@type\": \"Individual\"
            }
          }
        ],
        \"status\": \"active\",
        \"@type\": \"Individual\",
        \"partyOrPartyRole\": {
          \"role\": \"Consumer\",
          \"@type\": \"Party\"
        }
      }" \
    

    응답 본문.

    {
      "id": "83e588a17b6062105e0d5494548cb65d",
    "href": "api/sn_tmf_api/party/individual/83e588a17b6062105e0d5494548cb65d",
      "name": "Jane Smith",
      "givenName": "Jane",
      "middleName": "B.",
      "familyName": "Smith",
      "gender": "female",
      "nationality": "American",
      "title": "Ms",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "emailAddress": "jane.smith@example.com",
          "@type": "EmailContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "mobilePhone",
          "phoneNumber": "+1-416-555-1234",
          "@type": "PhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "businessPhone",
          "phoneNumber": "+1-416-555-5678",
          "@type": "BusinessPhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "fax",
          "fax": "987654321",
          "@type": "FaxContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "homePhone",
          "phoneNumber": "+1-416-555-4321",
          "@type": "HomePhoneContactMedium"
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "@type": "GeographicAddressContactMedium",
          "locationId": "03e588a17be062105e0d5494548cb68c",
          "city": "Toronto",
          "country": "Canada",
          "postCode": "M5H 2N2",
          "stateOrProvince": "Ontario",
          "street1": "123 Queen St W",
          "street2": "Suite 1500"
        }
      ],
      "externalReference": [
        {
          "externalIdentifierType": "linkedin",
          "id": "http://linkedin.com/in/janesmith"
        }
      ],
      "partyCharacteristic": [
        {
          "name": "notes",
          "value": "General consumer information.",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "userName",
          "value": "janesmith",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "vip",
          "value": false,
          "valueType": "boolean",
          "@type": "string"
        },
        {
          "name": "source",
          "value": "CRM System",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "dateFormat",
          "value": "yyyy-mm-dd",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "timeformat",
          "value": "HH:mm:ss (24 hour)",
          "valueType": "string",
          "@type": "string"
        },
        {
          "name": "notification",
          "value": "Disabled",
          "valueType": "string",
          "@type": "string"
        }
      ],
      "relatedParty": [
        {
          "role": "User",
          "partyOrPartyRole": {
            "id": "c456def03710200044e0bfc8bcbe5d99",
            "name": "Global Corp",
            "@type": "Individual"
          }
        }
      ],
      "status": "active",
      "@type": "Individual",
      "partyOrPartyRole": {
        "role": "Consumer",
        "@type": "Party"
      },
       "warning": [
        "relatedParty[0] is incorrect. User does not exist"
      ]
    }

    업체 관리 - POST /api/sn_tmf_api/v1/party/organization

    계정 [customer_account] 테이블에 새 업체 조직 기록을 작성합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_tmf_api/v1/party/organization

    기본 URL: /api/sn_tmf_api/v1/party/organization

    지원되는 요청 매개변수

    표 49. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열

    표 50. 쿼리 매개변수
    이름 설명
    안 함
    표 51. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    @type 이 값은 항상 조직입니다.

    데이터 유형: 문자열

    contactMedium 당사자에게 연락하기 위한 수단 목록입니다. 연락 매체는 개인 또는 조직과 같은 당사자와 소통하거나 연락하는 방식을 나타냅니다. 예를 들어, 해당 당사자와 연결된 연락 채널 또는 방법입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 접촉 매체의 유형입니다. 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 조직의 시입니다.

    데이터 유형: 문자열

    contactMedium.country 조직의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAdress 조직 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다.
    가능한 값:
    • businessPhone
    • 이메일
    • 팩스 전화
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 조직 접촉 창구의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 조직의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    externalReference 외부 시스템에 있는 업체의 식별자 목록입니다.

    데이터 유형: 객체 배열

    "externalReference": [ 
     { 
      "externalIdentifierType": "String", 
      "name": "String" 
     }
    ]
    externalReference.externalIdentifierType 외부 시스템 내의 엔터티 유형입니다.

    데이터 유형: 문자열

    externalReference.name 사람이 판독할 수 있는 외부 시스템 또는 참조 이름입니다.

    데이터 유형: 문자열

    href 계정 기록에 대한 상대 링크(URI)입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    ID 외부 엔터티 계정 기록의 Sys_id입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    법적 이름 조직의 법적 이름입니다.

    데이터 유형: 문자열

    이름 조직의 이름입니다.

    데이터 유형: 문자열

    파티특성 당사자가 취할 수 있는 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [ 
     { 
      "@type": "String" 
      "name": "String",   
      "value": "String", 
      "valueType": "String"
     } 
    ]
    partyCharacteristics.@type 서브클래싱 시, @type 하위 클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 부울 특성
    • 정수 특성
    • StringArrayCharacteristic
    • 문자열특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 회사 또는 계정입니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id가 계정 [customer_account] 테이블 partyOrPartyRole.role 에 속하는 경우 계정으로 설정됩니다. 마찬가지로 sys_id가 회사 [core_company] 테이블 partyOrPartyRole.role 에 속하는 경우 회사로 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole": {
      "@type": "String",
      "name":"String",
      "role":"String",
    }
    PartyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    PartyOrPartyRole.name 계정 또는 회사의 유형을 정의합니다.

    데이터 유형: 문자열

    PartyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 계정
    • 회사

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [ 
     { 
      "partyOrPartyRole": {Object},
      "role": "String"
     }
    ]
    relatedParty.partyOrPartyRole 이 당사자와 관련된 역할입니다.

    데이터 유형: 객체 배열

    "partyOrPartyRole": [ 
     { 
      "@type": "String", 
      "id": "String",
      "name": "String",
     }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다. 값은 항상 조직입니다.

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 연결된 특정 엔터티의 맥락에서 관련 당사자 또는 당사자 역할이 수행하는 역할입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    상태 조직의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • active: 조직이 활성 상태입니다.
    • 비활성: 조직이 비활성 상태입니다.

    데이터 유형: 부울

    거래 이름 조직이 거래하는 이름입니다.

    데이터 유형: 문자열

    헤더

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

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

    기본값: application/json

    표 53. 응답 헤더
    머리글 설명
    안 함

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.

    표 54. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

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

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

    이름 설명
    @type 이 값은 항상 조직입니다.

    데이터 유형: 문자열

    contactMedium 당사자에게 연락하기 위한 수단 목록입니다. 연락 매체는 개인 또는 조직과 같은 당사자와 소통하거나 연락하는 방식을 나타냅니다. 예를 들어, 해당 당사자와 연결된 연락 채널 또는 방법입니다.

    데이터 유형: 객체 배열

    "contactMedium": [
     {
      "@type": "String",
      "city": "String",
      "country": "String",
      "emailAddress": "String",
      "locationId": "String",
      "mediumType": "String",
      "phoneNumber": "String",
      "postCode": "String",
      "preferred": "Boolean",
      "stateOrProvince": "String",
      "street1": "String",
      "street2": "String"
     }
    ]
    contactMedium.@type 접촉 매체의 유형입니다. 연락 당사자의 유형입니다. 객체의 특정 스키마 또는 하위 클래스 유형을 나타냅니다.
    가능한 값:
    • BusinessPhoneContactMedium: 직장 전화번호
    • EmailContactMedium: 이메일 주소
    • FaxPhoneContactMedium: 팩스 번호
    • GeographicAddressContactMedium: 실제 주소(거리, 도시, 주, 우편 번호)
    • HomePhoneContactMedium: 집 전화 번호
    • MobilePhoneContactMedium: 휴대폰 번호

    데이터 유형: 문자열

    contactMedium.city 조직의 시입니다.

    데이터 유형: 문자열

    contactMedium.country 조직의 국가입니다.

    데이터 유형: 문자열

    contactMedium.emailAdress 조직 연락처의 이메일 주소입니다.

    데이터 유형: 문자열

    contactMedium.locationId 위치의 Sys_id입니다.

    테이블: 위치 [cmn_location]

    데이터 유형: 문자열

    contactMedium.mediumType 접촉 매체의 유형입니다.
    가능한 값:
    • businessPhone
    • 이메일
    • 팩스 전화
    • 홈전화
    • mobilePhone
    • 우편 주소

    데이터 유형: 문자열

    contactMedium.phoneNumber 조직 접촉 창구의 전화 번호입니다.

    데이터 유형: 문자열

    contactMedium.postCode 조직의 우편 번호입니다.

    데이터 유형: 문자열

    contactMedium.preferred 이 값은 항상 false입니다.

    데이터 유형: 부울

    contactMedium.stateOrProvince 위치가 시나 도에서 왔는지 여부를 나타냅니다.
    가능한 값:
    • 상태
    • 지방

    데이터 유형: 문자열

    contactMedium.street1 거리를 설명합니다.

    데이터 유형: 문자열

    contactMedium.street2 보완적인 거리 설명입니다.

    데이터 유형: 문자열

    externalReference 외부 시스템에 있는 업체의 식별자 목록입니다.

    데이터 유형: 객체 배열

    "externalReference": [ 
     { 
      "externalIdentifierType": "String", 
      "name": "String" 
     }
    ]
    externalReference.externalIdentifierType 외부 시스템 내의 엔터티 유형입니다.

    데이터 유형: 문자열

    externalReference.name 사람이 판독할 수 있는 외부 시스템 또는 참조 이름입니다.

    데이터 유형: 문자열

    href 계정 기록에 대한 상대 링크(URI)입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    ID 외부 엔터티 계정 기록의 Sys_id입니다.

    테이블: 계정 [customer_account]

    데이터 유형: 문자열

    법적 이름 조직의 법적 이름입니다.

    데이터 유형: 문자열

    이름 조직의 이름입니다.

    데이터 유형: 문자열

    파티특성 당사자가 취할 수 있는 특성 목록입니다.

    데이터 유형: 객체 배열

    "partyCharacteristics": [ 
     { 
      "@type": "String" 
      "name": "String",   
      "value": "String", 
      "valueType": "String"
     } 
    ]
    partyCharacteristics.@type 서브클래싱 시, @type 하위 클래스 확장 가능한 이름을 정의합니다.
    가능한 값:
    • 부울 특성
    • 정수 특성
    • StringArrayCharacteristic
    • 문자열특성

    데이터 유형: 문자열

    partyCharacteristics.name 당사자 특성의 이름입니다.

    데이터 유형: 문자열

    파티특성.값 당사자 특성의 값입니다.

    데이터 유형: 문자열

    partyCharacteristics.valueType 특성 값의 데이터 유형입니다.

    데이터 유형: 문자열

    partyOrPartyRole 이 당사자와 관련된 역할은 테이블에서 당사자가 생성된 위치에 정의됩니다. 예를 들어 회사 또는 계정입니다.

    partyOrPartyRole 작업에서 검색되는 기록 유형을 나타냅니다. 제공된 sys_id가 계정 [customer_account] 테이블 partyOrPartyRole.role 에 속하는 경우 계정으로 설정됩니다. 마찬가지로 sys_id가 회사 [core_company] 테이블 partyOrPartyRole.role 에 속하는 경우 회사로 설정됩니다.

    데이터 유형: 객체

    "partyOrPartyRole": {
      "@type": "String",
      "name":"String",
      "role":"String",
    }
    PartyOrPartyRole.@type 이 값은 항상 당사자입니다.

    데이터 유형: 문자열

    PartyOrPartyRole.name 계정 또는 회사의 유형을 정의합니다.

    데이터 유형: 문자열

    PartyOrPartyRole.role 역할의 유형입니다.
    가능한 값:
    • 계정
    • 회사

    데이터 유형: 문자열

    관련당사자 이 당사자와 관련된 당사자 또는 당사자 역할의 목록입니다.

    데이터 유형: 객체 배열

    "relatedParty": [ 
     { 
      "partyOrPartyRole": {Object},
      "role": "String"
     }
    ]
    relatedParty.partyOrPartyRole 이 당사자와 관련된 역할입니다.

    데이터 유형: 객체 배열

    "partyOrPartyRole": [ 
     { 
      "@type": "String", 
      "id": "String",
      "name": "String",
     }
    ]
    relatedParty.partyOrPartyRole.@type 관련 당사자의 유형입니다. 값은 항상 조직입니다.

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.id 관련 당사자의 Sys_id입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    relatedParty.partyOrPartyRole.name 관련 당사자의 이름입니다.

    데이터 유형: 문자열

    relatedParty.role 연결된 특정 엔터티의 맥락에서 관련 당사자 또는 당사자 역할이 수행하는 역할입니다.
    가능한 값:
    • 연락처
    • 기타

    데이터 유형: 문자열

    상태 조직의 상태를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • active: 조직이 활성 상태입니다.
    • 비활성: 조직이 비활성 상태입니다.

    데이터 유형: 부울

    거래 이름 조직이 거래하는 이름입니다.

    데이터 유형: 문자열

    cURL 요청

    이는 당사자 관리 조직 기록에 대해 지정된 필드를 반환합니다.

    curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/organization" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user 'user':'password'
    --data "{
      \"name\": \"SERVICENOW 144\",
      \"legalName\": \"Acme Corp Ltd.\",
      \"tradingName\": \"Acme Inc.\",
      \"contactMedium\": [
        {
          \"preferred\": true,
          \"mediumType\": \"email\",
          \"emailAddress\": \"athammhd@email.com\",
          \"@type\": \"EmailContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"phone\",
          \"phoneNumber\": \"+1-202-555-0198\",
          \"@type\": \"PhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"businessPhone\",
          \"phoneNumber\": \"+1-202-555-0198\",
          \"@type\": \"BusinessPhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"homePhone\",
          \"phoneNumber\": \"+1-202-555-0198\",
          \"@type\": \"HomePhoneContactMedium\"
        },
        {
          \"preferred\": false,
          \"mediumType\": \"postalAddress\",
          \"validFor\": {
            \"startDateTime\": \"2017-03-15T07:49:25.246Z\"
          },
          \"@type\": \"GeographicAddressContactMedium\",
          \"city\": \"chennai\",
          \"country\": \"INDIA\",
          \"postCode\": \"608001\",
          \"stateOrProvince\": \"tamil nadu\",
          \"street1\": \"samcon street\",
          \"street2\": \"adyar,chennai\"
        }
      ],
      \"externalReference\": [
        {
          \"externalIdentifierType\": \"Instagram\",
          \"id\": \"Instagram\"
        }
      ],
      \"partyCharacteristic\": [
        {
          \"name\": \"notes\",
          \"value\": \"Testing for update the notes\",
          \"valueType\": \"string\",
          \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"customer\",
          \"value\": \"true\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"registrationCode\",
          \"value\": \"001\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
         \"name\": \"vendorType\",
         \"value\": [\"Hardware\"],
         \"valueType\": \"array\",
          \"@type\": \"StringArrayCharacteristic\"
         },
         {
          \"name\": \"industry\",
          \"value\": \"technology_services\",
          \"valueType\": \"choice\",
            \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"taxId\",
          \"value\": \"CTNUM1000123\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"numEmployees\",
          \"value\": \"EMP1000\",
          \"valueType\": \"integer\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"rankTier\",
          \"value\": \"rankTier\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"publiclyTraded\",
          \"value\": \"false\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"stockSymbol\",
          \"value\": \"Market\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"stockPrice\",
          \"value\": \"1000\",
          \"valueType\": \"string\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"vendor\",
          \"value\": \"false\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"manufacturer\",
          \"value\": \"false\",
          \"valueType\": \"boolean\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"marketCap\",
          \"value\": \"0\",
          \"valueType\": \"currency\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"profits\",
          \"value\": \"0\",
          \"valueType\": \"currency\",
           \"@type\": \"StringCharacteristics\"
        },
        {
          \"name\": \"revenuePerYear\",
          \"value\": \"0\",
          \"valueType\": \"currency\",
           \"@type\": \"StringCharacteristics\"
        }
      ],
      \"relatedParty\": [
        {
          \"role\": \"primaryContact\",
          \"partyOrPartyRole\": {
            \"id\": \"eaf68911c35420105252716b7d40ddde\",
            \"name\": \"John Doe\",
            \"@type\": \"Individual\"
          }
        },
        {
          \"role\": \"other\",
          \"partyOrPartyRole\": {
            \"id\": \"776a22ea11f43110f877366201dea6b7\",
            \"name\": \"Mary Star\",
            \"@type\": \"Individual\"
          }
        }
      ],
      \"organizationChildRelationship\": [
        {
          \"relationshipType\": \"partneraccount\",
          \"organization\": {
            \"id\": \"0fef075b2fe06a10b79db3bf42faf31a\",
            \"name\": \"mhd\",
            \"@type\": \"Organization\"
          }
        }
      ],
      \"organizationParentRelationship\": 
        {
          \"relationshipType\": \"Account\",
          \"organization\": {
            \"id\": \"9e2fd2ee11b43110f877366201dea674\",
            \"name\": \"Global Holdings Ltd.\",
            \"@type\": \"Organization\"
          }
        },
      \"status\": \"active\",
      \"@type\": \"Organization\",
      \"partyOrPartyRole\": {
        \"@type\":\"Party\",
        \"name\":\"Customer\",
        \"role\": \"Account\" 
      }
    }" \

    응답 본문.

    {
       "name": "SERVICENOW 144",
       "legalName": "Acme Corp Ltd.",
       "tradingName": "Acme Inc.",
       "contactMedium": [
         {
           "preferred": true,
           "mediumType": "email",
           "emailAddress": "athammhd@email.com",
           "@type": "EmailContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "phone",
           "phoneNumber": "+1-202-555-0198",
           "@type": "PhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "businessPhone",
           "phoneNumber": "+1-202-555-0198",
           "@type": "BusinessPhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "homePhone",
           "phoneNumber": "+1-202-555-0198",
           "@type": "HomePhoneContactMedium"
         },
         {
           "preferred": false,
           "mediumType": "postalAddress",
           "validFor": {
             "startDateTime": "2017-03-15T07:49:25.246Z"
           },
           "@type": "GeographicAddressContactMedium",
           "city": "chennai",
           "country": "INDIA",
           "postCode": "608001",
           "stateOrProvince": "tamil nadu",
           "street1": "samcon street",
           "street2": "adyar,chennai"
         }
       ],
       "externalReference": [
         {
           "externalIdentifierType": "Instagram",
           "id": "Instagram"
         }
       ],
       "partyCharacteristic": [
         {
           "name": "notes",
           "value": "Testing for update the notes",
           "valueType": "string",
           "@type": "StringCharacteristics"
         },
         {
           "name": "customer",
           "value": "true",
           "valueType": "boolean",
            "@type": "StringCharacteristics"
         },
         {
           "name": "registrationCode",
           "value": "001",
           "valueType": "string",
            "@type": "StringCharacteristics"
         },
         {
          "name": "vendorType",
          "value": ["Hardware"],
          "valueType": "array",
           "@type": "StringArrayCharacteristic"
          },
          {
           "name": "industry",
           "value": "technology_services",
           "valueType": "choice",
             "@type": "StringCharacteristics"
         },
         {
           "name": "taxId",
           "value": "CTNUM1000123",
           "valueType": "string",
            "@type": "StringCharacteristics"
         },
         {
           "name": "numEmployees",
           "value": "EMP1000",
           "valueType": "integer",
            "@type": "StringCharacteristics"
         },
         {
           "name": "rankTier",
           "value": "rankTier",
           "valueType": "string",
            "@type": "StringCharacteristics"
         },
         {
           "name": "publiclyTraded",
           "value": "false",
           "valueType": "boolean",
            "@type": "StringCharacteristics"
         },
         {
           "name": "stockSymbol",
           "value": "Market",
           "valueType": "string",
            "@type": "StringCharacteristics"
         },
         {
           "name": "stockPrice",
           "value": "1000",
           "valueType": "string",
            "@type": "StringCharacteristics"
         },
         {
           "name": "vendor",
           "value": "false",
           "valueType": "boolean",
            "@type": "StringCharacteristics"
         },
         {
           "name": "manufacturer",
           "value": "false",
           "valueType": "boolean",
            "@type": "StringCharacteristics"
         },
         {
           "name": "marketCap",
           "value": "0",
           "valueType": "currency",
            "@type": "StringCharacteristics"
         },
         {
           "name": "profits",
           "value": "0",
           "valueType": "currency",
            "@type": "StringCharacteristics"
         },
         {
           "name": "revenuePerYear",
           "value": "0",
           "valueType": "currency",
            "@type": "StringCharacteristics"
         }
       ],
       "relatedParty": [
         {
           "role": "primaryContact",
           "partyOrPartyRole": {
             "id": "eaf68911c35420105252716b7d40ddde",
             "name": "John Doe",
             "@type": "Individual"
           }
         },
         {
           "role": "other",
           "partyOrPartyRole": {
             "id": "776a22ea11f43110f877366201dea6b7",
             "name": "Mary Star",
             "@type": "Individual"
           }
         }
       ],
       "organizationChildRelationship": [
         {
           "relationshipType": "partneraccount",
           "organization": {
             "id": "0fef075b2fe06a10b79db3bf42faf31a",
             "name": "mhd",
             "@type": "Organization"
           }
         }
       ],
       "organizationParentRelationship": 
         {
           "relationshipType": "Account",
           "organization": {
             "id": "9e2fd2ee11b43110f877366201dea674",
             "name": "Global Holdings Ltd.",
             "@type": "Organization"
           }
         },
       "status": "active",
       "@type": "Organization",
       "partyOrPartyRole": {
         "@type":"Party",
         "name":"Customer",
         "role": "Account" 
       }
     }