기술 서비스 적격성 평가 개방형 API

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기130분

    • Technical Service Qualification Open API는 이행을 위해 주문을 제출하기 전에 자원 및 서비스의 가용성을 확인하는 엔드포인트를 제공합니다.

    이 API는 TMF645 서비스 적격성 평가 API REST 사양의 구현입니다 ServiceNow . 서비스 적격성 요청에 대한 자세한 내용은 을 참조하십시오 Service qualification requests.

    Technical Service Qualification Open API는 sn_ord_qual_mgmt 네임스페이스 내에서 제공되며 다음 플러그인이 필요합니다.
    • 제품 카탈로그 관리 Core [com.sn_prd_pm]
    • 제품 카탈로그 고급 [com.sn_prd_pm_adv]
    • 주문 적격성 관리 [com.sn_ord_qual_mgmt]
    • 통신, 미디어 및 기술 기업용 Order Management [com.sn_tmt_core]
    • 통신 코어 [com.sn_tmt_core]

    이 API를 사용하려면 sn_ind_tmt_orm.order_integrator 역할이 필요합니다.

    기술 서비스 적격성 평가 Open API - GET sn_ord_qual_mgmt/적격성 평가/checkServiceQualification/{id}

    지정된 고객 주문 ID와 연결된 기술 적격성 평가 요청을 검색합니다.

    이 엔드포인트는 다음 테이블에서 주문 정보를 검색합니다.
    • 고객 주문 [sn_ind_tmt_orm_order]
    • 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]

    URL 형식

    버전이 지정된 URL: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    id 검색할 적격성 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    표 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 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

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

    이름 설명
    id 적격성 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    href 적격성 평가 주문 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열
    설명 고객 주문의 short_description 필드에서 가져오는 적격성 평가 요청에 대한 설명입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    externalId 고객 주문 external_id 필드의 외부 ID입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    적격성 결과 고객 주문 결과 필드의 자격 상태입니다. 가능한 값:
    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    상태 고객 주문 상태 필드의 고객 주문 상태입니다.

    데이터 유형: 문자열
    @type TMF Open API 표준의 일부입니다. 자격에 대한 주석입니다. 이 값은 항상 CheckServiceQualification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    checkServiceQualificationDate 고객 주문의 order_date 필드에서 생성된 적격성 평가 요청의 날짜 및 시간입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    effectiveQualificationDate (유효적격성 평가) 고객 주문의 order_date 필드에서 가져온 유효 자격 날짜입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    예상 적격성 평가 날짜 예상 적격성 평가 날짜를 저장합니다. 고객 주문의 expected_end_date 필드에 유지됩니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    관련파티 적격성 평가 요청을 위한 연락처 목록입니다. 각 접점은 배열의 개체입니다.

    데이터 형식: 객체 배열

    "relatedParty": [
  {
    "id": "String",
    "name": "String",
    "@referredType": "String",
    "@type": "String"
  }
]
    relatedParty.id 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account] 테이블, 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.

    데이터 유형: 문자열
    relatedParty.name 계정, 고객 또는 소비자의 이름입니다.

    데이터 유형: 문자열
    relatedParty.@type TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    relatedParty.@referredType 관련 당사자의 유형입니다.
    가능한 값:
    • 소비자
    • 고객
    • 고객 연락처

    데이터 유형: 문자열
    serviceQualificationItem 위치, 서비스 정보 및 서비스 특성에 대한 정보가 포함된 서비스 적격성 평가 항목의 목록입니다. 고객 주문에 대한 주문 라인 항목으로 저장됩니다.

    데이터 형식: 객체 배열

    "serviceQualificationItem": [
  {
  "id": "String",
  "action": "String",
  "expectedServiceAvailabilityDate": "Number",
  "service": {Object},
  "@type": "String"
  }
],
    serviceQualificationItem.id 자격 항목의 ID입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있는 고객 주문 라인 항목의 external_id 필드에 저장됩니다.

    데이터 유형: 문자열
    serviceQualificationItem.qualificationResult 적격성 항목의 결과입니다. 고객 주문 라인 항목의 "결과" 필드에 저장됩니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    가능한 값:

    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    serviceQualificationItem.state 고객 주문 라인 항목의 "상태" 필드에서 파생된 자격 항목의 상태입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 문자열
    serviceQualificationItem.quantity 고객 주문 라인 항목의 "수량" 필드에서 파생된 자격 항목의 수량입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 숫자
    serviceQualificationItem.@type TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 주석입니다. 이 값은 항상 ServiceQualificationItem입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service 위치(장소), 서비스 사양 및 서비스 특성에 대한 세부 정보를 포함하는 서비스 정보입니다.

    데이터 유형: 객체

    "service": {
  "@type": "String",
  "place": [Array],
  "serviceCharacteristic": [Array],
  "serviceSpecification": {Object}
}
    serviceQualificationItem.service.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 Service입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place 서비스 적격성 항목에 대한 위치 정보입니다.

    데이터 형식: 개체 배열

    주:
    이 배열에는 하나의 위치만 포함될 수 있습니다.
    "place": [
  {
  "id": "String",
  "name": "String",
  "@referredType": "String"
  }
]

    serviceQualificationItem.service.place.id

    		 위치 [cmn_location] 테이블의 위치 Sys_id입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.name 위치 이름입니다. 위치 [cmn_location] 테이블의 항목에 대해 검증되지 않았습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 GeographicSite입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification 적격성 평가 항목에 대한 서비스 사양 상세 정보입니다.

    데이터 형식: 개체 배열

    "serviceSpecification": {
  "id": "String",
  "internalVersion": "Number",
  "internalId": "String",
  "name": "String"
  "@type": "ServiceSpecification"
  "version": "String",
}
    serviceQualificationItem.service.serviceSpecification.id 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.name 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.version 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.internalVersion 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem.service.serviceSpecification.internalId 서비스 사양의 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic 서비스 특성 목록입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String"
  "valueType": "String",
  }
]
    serviceQualificationItem.service.serviceCharacteristic.valueType 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.name 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.value 특성의 값입니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal 적격성 평가 주문에 대한 대체 서비스 제안. 대체 제안은 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블에 저장됩니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal.id 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블의 대체 제안 항목 Sys_id입니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블에 있는 대체 제안 항목의 available_date 필드 값입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateServiceProposal.alternateService 대체 제안으로 표시되는 서비스 정보입니다.

    데이터 형식: 개체
    serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification 대체 제안의 서비스 사양은 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블의 사양에 유지됩니다.

    데이터 유형: 객체
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.id 대체 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.name 대체 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.version 대체 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.internalVersion 대체 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.internalId 대체 서비스 사양의 초기 버전입니다.

    데이터 유형: 문자열
    ServiceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic 대체 서비스 제안에 대한 서비스 특성의 배열입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String",
  "valueType": "String"
  }
]
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.valueType 대체 서비스 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.name 대체 서비스 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.value 대체 서비스 특성의 값입니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason 서비스를 사용할 수 없는 이유를 설명하는 서비스 자격 사용할 수 없는 사유 목록입니다. 이 값은 도메인 주문 [sn_ind_tmt_orm_domain_order] 테이블의 unavailability_reason 필드에 유지됩니다.

    데이터 유형: 배열
    serviceQualificationItem.eligibilityUnavailabilityReason.code 서비스 자격을 사용할 수 없는 이유 코드입니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason.label 서비스 자격을 사용할 수 없는 이유 레이블입니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    다음 예에서는 적격성 평가 고객 주문의 지정된 Sys_id와 연결된 전체 특정 적격성 평가 주문을 검색합니다.

    curl -location --request GET "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/4b5aa0a538b31110f877c8d44c4b8947" \ 
--user "username":"password"

    응답:

    [
  {
    "id": "001b359545371150f877e0588eca21ca",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/001b359545371150f877e0588eca21ca",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": "Sally Thomas",
        "@type": "RelatedParty",
        "@referredType": "CustomerContact"
      },
      {
        "id": "ffc68911c35420105252716b7d40dd55",
        "name": "Funco Intl",
        "@type": "RelatedParty",
        "@referredType": "Customer"
      },
      {
        "id": "59f16de1c3b67110ff00ed23a140dd9e",
        "name": "Funco External",
        "@type": "RelatedParty",
        "@referredType": "Consumer"
      }
    ],
    "serviceSpecification": {
      "id": "91478553b7969910ff00f203ae11a97d",
      "name": "Broadband Service",
      "version": "",
      "internalVersion": "1",
      "internalId": "91478553b7969910ff00f203ae11a97d",
      "@type": "ServiceSpecification"
    },
    "place": {
      "id": "5671dd2ec3a53010188473ce3640dd81",
      "name": "3000 Main Street, Santa Clara, CA",
      "@referredType": "GeographicSite"
    },
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
  },
  {
    "id": "0236b75145fb1150f877e0588eca2145",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0236b75145fb1150f877e0588eca2145",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-15T08:57:50.000Z",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": "Sally Thomas",
        "@type": "RelatedParty",
        "@referredType": "CustomerContact"
      },
      {
        "id": "ffc68911c35420105252716b7d40dd55",
        "name": "Funco Intl",
        "@type": "RelatedParty",
        "@referredType": "Customer"
      },
      {
        "id": "59f16de1c3b67110ff00ed23a140dd9e",
        "name": "Funco External",
        "@type": "RelatedParty",
        "@referredType": "Consumer"
      }
    ],
    "serviceQualificationItem": [
      {
        "id": "110",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Fiber Speed",
              "valueType": "choice",
              "value": "1Gbps"
            }
          ],
          "serviceSpecification": {
            "id": "4d2b5799457b1150f877e0588eca2116",
            "name": "CFS3",
            "version": "",
            "internalVersion": "1",
            "internalId": "4d2b5799457b1150f877e0588eca2116",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "130",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Wireless Speed",
              "valueType": "choice",
              "value": "100 Mbps"
            }
          ],
          "serviceSpecification": {
            "id": "28733d1d45f31150f877e0588eca2163",
            "name": "CFS2",
            "version": "",
            "internalVersion": "1",
            "internalId": "28733d1d45f31150f877e0588eca2163",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "100",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Speed",
              "valueType": "choice",
              "value": ""
            }
          ],
          "serviceSpecification": {
            "id": "b3933d9d45f31150f877e0588eca21fc",
            "name": "Access Service",
            "version": "",
            "internalVersion": "1",
            "internalId": "b3933d9d45f31150f877e0588eca21fc",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "120",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "DSL Speed",
              "valueType": "choice",
              "value": "500 Mbps"
            }
          ],
          "serviceSpecification": {
            "id": "1d43f91d45f31150f877e0588eca21cd",
            "name": "CFS1",
            "version": "",
            "internalVersion": "1",
            "internalId": "1d43f91d45f31150f877e0588eca21cd",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      }
    ],
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
  }
]

    기술 서비스 적격성 평가 Open API - GET sn_ord_qual_mgmt/적격성 평가/checkServiceQualification

    모든 기술 적격성 평가 요청 목록을 조회합니다.

    이 엔드포인트는 다음 테이블에서 주문 정보를 검색합니다.
    • 고객 주문 [sn_ind_tmt_orm_order]
    • 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]

    이 엔드포인트는 기본적으로 20개의 레코드를 반환하지만 최대 100개의 레코드를 리턴할 수 있습니다. 쿼리 필터를 사용하여 상태, 필드 이름, 설명 및 한정 결과에 따라 결과를 좁힐 수 있습니다.

    URL 형식

    버전이 지정된 URL: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 8. 쿼리 매개변수
    매개변수 설명
    설명 고객 주문의 'short_description' 필드를 기준으로 적격성 평가 주문을 필터링합니다. 짧은 설명이 이 매개변수의 값과 일치하는주문만 응답에 반환됩니다.

    데이터 유형: 문자열
    필드 응답에서반환할 필드 이름 목록입니다. 잘못된 필드는 무시됩니다. 요청에 이 매개변수가 제공되지 않은 경우 모든 필드가 반환됩니다.

    데이터 유형: 문자열, 쉼표로 구분
    제한 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 offset 매개 변수를 사용하여 기록 검색을 페이지 매김합니다.

    기본값: 20

    최대: 100

    데이터 유형: 숫자
    적격성 결과 결과에 따라 적격성 평가 순서를 필터링합니다. 이 매개변수의 값과 일치하는 결과가 있는 주문만 응답에 반환됩니다.

    데이터 유형: 문자열
    상태 상태별로 적격성 평가 순서를 필터링합니다. 이 매개변수의 값과 일치하는 상태를 가진 주문만 응답에 반환됩니다.

    데이터 유형: 문자열
    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

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

    기본값: application/json
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

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

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

    이름 설명
    id 적격성 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    href 적격성 평가 주문 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열
    설명 고객 주문의 short_description 필드에서 가져오는 적격성 평가 요청에 대한 설명입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    externalId 고객 주문 external_id 필드의 외부 ID입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    적격성 결과 고객 주문 결과 필드의 자격 상태입니다. 가능한 값:
    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    상태 고객 주문 상태 필드의 고객 주문 상태입니다.

    데이터 유형: 문자열
    @type TMF Open API 표준의 일부입니다. 자격에 대한 주석입니다. 이 값은 항상 CheckServiceQualification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    checkServiceQualificationDate 고객 주문의 order_date 필드에서 생성된 적격성 평가 요청의 날짜 및 시간입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    effectiveQualificationDate (유효적격성 평가) 고객 주문의 order_date 필드에서 가져온 유효 자격 날짜입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    예상 적격성 평가 날짜 예상 적격성 평가 날짜를 저장합니다. 고객 주문의 expected_end_date 필드에 유지됩니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    관련파티 적격성 평가 요청을 위한 연락처 목록입니다. 각 접점은 배열의 개체입니다.

    데이터 형식: 객체 배열

    "relatedParty": [
  {
    "id": "String",
    "name": "String",
    "@referredType": "String",
    "@type": "String"
  }
]
    relatedParty.id 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account] 테이블, 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.

    데이터 유형: 문자열
    relatedParty.name 계정, 고객 또는 소비자의 이름입니다.

    데이터 유형: 문자열
    relatedParty.@type TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    relatedParty.@referredType 관련 당사자의 유형입니다.
    가능한 값:
    • 소비자
    • 고객
    • 고객 연락처

    데이터 유형: 문자열
    serviceQualificationItem 위치, 서비스 정보 및 서비스 특성에 대한 정보가 포함된 서비스 적격성 평가 항목의 목록입니다. 고객 주문에 대한 주문 라인 항목으로 저장됩니다.

    데이터 형식: 객체 배열

    "serviceQualificationItem": [
  {
  "id": "String",
  "action": "String",
  "expectedServiceAvailabilityDate": "Number",
  "service": {Object},
  "@type": "String"
  }
],
    serviceQualificationItem.id 자격 항목의 ID입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있는 고객 주문 라인 항목의 external_id 필드에 저장됩니다.

    데이터 유형: 문자열
    serviceQualificationItem.qualificationResult 적격성 항목의 결과입니다. 고객 주문 라인 항목의 "결과" 필드에 저장됩니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    가능한 값:

    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    serviceQualificationItem.state 고객 주문 라인 항목의 "상태" 필드에서 파생된 자격 항목의 상태입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 문자열
    serviceQualificationItem.quantity 고객 주문 라인 항목의 "수량" 필드에서 파생된 자격 항목의 수량입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 숫자
    serviceQualificationItem.@type TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 주석입니다. 이 값은 항상 ServiceQualificationItem입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service 위치(장소), 서비스 사양 및 서비스 특성에 대한 세부 정보를 포함하는 서비스 정보입니다.

    데이터 유형: 객체

    "service": {
  "@type": "String",
  "place": [Array],
  "serviceCharacteristic": [Array],
  "serviceSpecification": {Object}
}
    serviceQualificationItem.service.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 Service입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place 서비스 적격성 항목에 대한 위치 정보입니다.

    데이터 형식: 개체 배열

    주:
    이 배열에는 하나의 위치만 포함될 수 있습니다.
    "place": [
  {
  "id": "String",
  "name": "String",
  "@referredType": "String"
  }
]

    serviceQualificationItem.service.place.id

    		 위치 [cmn_location] 테이블의 위치 Sys_id입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.name 위치 이름입니다. 위치 [cmn_location] 테이블의 항목에 대해 검증되지 않았습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 GeographicSite입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification 적격성 평가 항목에 대한 서비스 사양 상세 정보입니다.

    데이터 형식: 개체 배열

    "serviceSpecification": {
  "id": "String",
  "internalVersion": "Number",
  "internalId": "String",
  "name": "String"
  "@type": "ServiceSpecification"
  "version": "String",
}
    serviceQualificationItem.service.serviceSpecification.id 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.name 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.version 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.internalVersion 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem.service.serviceSpecification.internalId 서비스 사양의 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic 서비스 특성 목록입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String"
  "valueType": "String",
  }
]
    serviceQualificationItem.service.serviceCharacteristic.valueType 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.name 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.value 특성의 값입니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal 적격성 평가 주문에 대한 대체 서비스 제안. 대체 제안은 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블에 저장됩니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal.id 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블의 대체 제안 항목 Sys_id입니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블에 있는 대체 제안 항목의 available_date 필드 값입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateServiceProposal.alternateService 대체 제안으로 표시되는 서비스 정보입니다.

    데이터 형식: 개체
    serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification 대체 제안의 서비스 사양은 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블의 사양에 유지됩니다.

    데이터 유형: 객체
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.id 대체 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.name 대체 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.version 대체 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.internalVersion 대체 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.internalId 대체 서비스 사양의 초기 버전입니다.

    데이터 유형: 문자열
    ServiceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic 대체 서비스 제안에 대한 서비스 특성의 배열입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String",
  "valueType": "String"
  }
]
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.valueType 대체 서비스 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.name 대체 서비스 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.value 대체 서비스 특성의 값입니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason 서비스를 사용할 수 없는 이유를 설명하는 서비스 자격 사용할 수 없는 사유 목록입니다. 이 값은 도메인 주문 [sn_ind_tmt_orm_domain_order] 테이블의 unavailability_reason 필드에 유지됩니다.

    데이터 유형: 배열
    serviceQualificationItem.eligibilityUnavailabilityReason.code 서비스 자격을 사용할 수 없는 이유 코드입니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason.label 서비스 자격을 사용할 수 없는 이유 레이블입니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    다음 GET 호출은 인스턴스에 대한 모든 적격성 평가 주문을 검색합니다.

    curl -location --request GET "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification" \ 
--user "username":"password"

    응답:

    [{
        "id": "001b359545371150f877e0588eca21ca",
        "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/001b359545371150f877e0588eca21ca",
        "description": "check service qualification illustration",
        "externalId": "CSQ1",
        "qualificationResult": "none",
        "state": "new",
        "@type": "CheckServiceQualification",
        "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
        "relatedParty": [{
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            },
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            },
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
        ],
        "serviceSpecification": {
            "id": "91478553b7969910ff00f203ae11a97d",
            "name": "Broadband Service",
            "version": "",
            "internalVersion": "1",
            "internalId": "91478553b7969910ff00f203ae11a97d",
            "@type": "ServiceSpecification"
        },
        "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
        }
    }
}],
"expectedQualificationDate": "2022-10-11T15:20:39.000Z"
}, {
    "id": "0236b75145fb1150f877e0588eca2145",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0236b75145fb1150f877e0588eca2145",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-15T08:57:50.000Z",
    "relatedParty": [{
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        }
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
    ],
    "serviceQualificationItem": [{
            "id": "110",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Fiber Speed",
                    "valueType": "choice",
                    "value": "1Gbps"
                }],
                "serviceSpecification": {
                    "id": "4d2b5799457b1150f877e0588eca2116",
                    "name": "CFS3",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "4d2b5799457b1150f877e0588eca2116",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "130",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Wireless Speed",
                    "valueType": "choice",
                    "value": "100 Mbps"
                }],
                "serviceSpecification": {
                    "id": "28733d1d45f31150f877e0588eca2163",
                    "name": "CFS2",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "28733d1d45f31150f877e0588eca2163",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Speed",
                    "valueType": "choice",
                    "value": ""
                }],
                "serviceSpecification": {
                    "id": "b3933d9d45f31150f877e0588eca21fc",
                    "name": "Access Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "b3933d9d45f31150f877e0588eca21fc",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "120",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "DSL Speed",
                    "valueType": "choice",
                    "value": "500 Mbps"
                }],
                "serviceSpecification": {
                    "id": "1d43f91d45f31150f877e0588eca21cd",
                    "name": "CFS1",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "1d43f91d45f31150f877e0588eca21cd",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
}
]

    기술 서비스 적격성 평가 Open API - POST sn_ord_qual_mgmt/적격성 평가/checkServiceQualification

    적격성 평가 항목 목록이 포함된 기술 서비스 적격성 평가 요청 엔터티를 생성합니다.

    서비스 적격성 평가 요청은 적격성 충족 유형이 있는 고객 주문으로 유지됩니다. 각 적격성 평가 항목은 주문 [sn_ind_tmt_orm_order_line_item] 테이블에 고객 라인 주문으로 유지됩니다.

    이 엔드포인트 사용

    다음 세 가지 특정 사용 사례에 이 API 메서드를 사용할 수 있습니다.
    1. 지정된 주소에서 서비스를 적격성 평가하도록 요청합니다.
    2. 기존 및 활성 액세스 서비스의 동일한 위치에서 새 서비스를 적격성 평가하도록 요청합니다.
    3. 기존 서비스를 업그레이드 또는 다운그레이드하도록 요청합니다.

    각 사용 사례에는 동일한 요청 구조가 필요하지만 서로 다른 요청 매개변수를 사용합니다. 각 사용 사례와 수락된 매개변수에 대한 세부 정보가 제공됩니다.

    • 지정된 주소에서 서비스를 한정하려면 배열(serviceQualificationItem.service.place) 을 사용하여 place 특정 위치 및 서비스 사양을 제공합니다. 요청에서 추가 서비스 특성을 선택적으로 정의할 수 있습니다.
    • 기존 및 활성 서비스의 동일한 위치에서 새 서비스를 한정하려면 배열 대신 개체(serviceQualificationItem.service.referenceServiceInventory)를 referenceServiceInventoryplace 사용합니다. 이 객체를 사용하면 위치 상세 정보를 제공할 필요 없이 요청을 생성하고 서비스 사양을 정의할 수 있습니다. 요청에서 추가 서비스 특성을 선택적으로 정의할 수 있습니다.
    • 기존 서비스를 업그레이드하거나 다운그레이드하려면 배열 또는 객체 대신 place 객체(serviceQualificationItem.service.ServiceInventory)를 referenceServiceInventory 사용합니다serviceInventory. 이 사용 사례에서는 위치 정보 및 사양 상세 정보를 기존 서비스에서 가져옵니다. 요청에서 변경하려는 서비스 특성을 정의합니다.

      예를 들어 기존 활성 서비스의 다운로드 속도를 100Mb/s에서 600Mb/s로 업그레이드할 수 있는지 확인하려고 합니다. 이 경우 매개변수를 serviceInventory 사용하여 '속도' 특성을 '낮음'에서 '높음'으로 변경하여 요청을 정의할 수 있습니다. API는 기존 서비스에서 나머지 특성을 가져옵니다.

    특정 사용 사례에 따라 API 요청을 구성하는 방법을 이해하려면 이 페이지의 예제 섹션에 제공된 예제 호출을 참조하세요.

    URL 형식

    버전이 지정된 URL: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    없음
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(XML 또는 JSON)
    매개변수 설명
    @type 옵션입니다. TMF Open API 표준의 일부입니다. 자격에 대한 주석입니다. 이 값은 항상 CheckServiceQualification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    checkServiceQualificationDate 옵션입니다. 적격성 평가 요청이 생성된 날짜 및 시간입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블의 order_date 필드에 있습니다. 지정하지 않으면 order_date 현재 날짜 및 시간으로 설정됩니다.

    데이터 유형: 문자열

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기
    설명 옵션입니다. 적격성 평가 요청에 대한 설명입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블의 'short_description' 필드에 있습니다.

    데이터 유형: 문자열

    최대 문자 길이: 100
    effectiveQualificationDate (유효적격성 평가) 옵션입니다. 자격이 발효되는 날짜입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블의 고객 주문에 대한 "actual_end_date" 필드에 유지됩니다.

    데이터 유형: 문자열

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기
    예상 적격성 평가 날짜 옵션입니다. 예상 적격성 평가 날짜입니다. 고객 주문의 expected_end_date' 필드에 유지됩니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기
    externalId 옵션입니다. 고객 주문에 할당된 외부 ID입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블의 고객 주문에 대한 external_id 필드에 유지됩니다.

    데이터 유형: 문자열
    관련파티 적격성 평가 요청을 위한 연락처 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정, 고객 접촉 창구 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다.

    데이터 형식: 객체 배열

    "relatedParty": [
  {
  "@referredType": "String",
  "@type": "String",
  "id": "String",
  "name": "String"
  }
]
    relatedParty.@referredType 관련 당사자의 유형입니다.
    가능한 값:
    • 소비자
    • 고객
    • customerContact

    데이터 유형: 문자열
    relatedParty.@type 옵션입니다. TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    relatedParty.id 관련 당사자의 sys_id 또는 external_id(해당하는 경우) 계정 [customer_account] 테이블, 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.

    데이터 유형: 문자열
    relatedParty.name 계정, 고객 또는 소비자의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem 위치, 서비스 정보 및 특성이 있는 서비스 적격성 평가 항목의 목록입니다. 고객 주문에 대한 주문 라인 항목으로 저장됩니다. 목록에 하나 이상의 서비스 적격성 평가 항목을 포함해야 합니다.

    데이터 형식: 개체 배열

    "serviceQualificationItem": [{
  "@type": "String",
  "id": "String",
  "qualificationResult": "String",
  "quantity": "Number",
  "service": {Object},
  "state": "String"
]
    serviceQualificationItem.@type 옵션입니다. TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 주석입니다. 이 값은 항상 ServiceQualificationItem입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.qualificationItemRelationship 옵션입니다. 동일한 요청에 있는 다른 서비스 적격성 평가 항목과의 관계 목록입니다. 이 정보는 상위 주문 라인 항목이 있는 주문 라인 항목을 생성하는 데 도움이 됩니다.

    데이터 형식: 개체 배열

    "qualificationItemRelationship": [
  {
  "id": "String"
  "relationshipType": "String"
   }
]

    serviceQualificationItem.qualificationItemRelationship.id

    		 필수 관계에서 대상 자격 항목의 ID입니다.

    데이터 유형: 문자열
    serviceQualificationItem.qualificationItemRelationship.relationshipType 필수 라인 항목 관계의 유형입니다.

    유효한 값은 다음과 같습니다.

    • HasChild: 자식 항목을 나타냅니다.
    • HasParent:는 부모 항목을 나타냅니다.

    데이터 유형: 문자열
    serviceQualificationItem.quantity 옵션입니다. 적격성 평가 항목의 수량입니다. 고객 주문 라인 항목의 "수량" 필드에 유지됩니다.

    데이터 유형: 숫자

    지정되지 않은 경우 기본값: 1
    serviceQualificationItem.service 필수 장소, 서비스 사양 및 서비스 특성과 같은 변수를 포함할 수 있는 서비스 정보입니다.

    데이터 형식: 개체

    "service": {
  "@type": "String",
  "place": [Array],
  "serviceCharacteristic": [Array],
  "serviceSpecification": {Object}
}
    serviceQualificationItem.service.@type 옵션입니다. TMF Open API 표준의 일부입니다. 적격성 평가 항목의 서비스 정보에 대한 주석입니다. 이 값은 항상 Service입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place 옵션입니다. 서비스 적격성 평가 항목에 대해 요청된 위치 정보입니다. 위치 [cmn_location] 테이블에 있습니다.
    주:
    배열이 지원되더라도 하나의 위치만 포함해야 합니다.

    데이터 형식: 개체 배열

    "place": [
  {
  "@type": "String"
  "id": "String",
  "name": "String"
  }
]
    serviceQualificationItem.service.place.@type 옵션입니다. TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 GeographicSite입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.id 필수 위치 [cmn_location] 테이블의 위치 Sys_id입니다. 이 위치 ID는 위치 [cmn_location] 테이블에서 유효한 항목이어야 합니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.name 옵션입니다. 위치 이름입니다. 이 값은 위치 [cmn_location] 테이블의 항목에 대해서는 확인되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.referenceServiceInventory 필수 필요한 위치에 대한 활성 서비스를 참조하는 유효한 서비스 인벤토리 엔터티입니다. 적격성 평가 주문에 대한 위치 정보는 이 서비스 인벤토리의 위치에서 가져옵니다.
    중요사항:
    referenceServiceInventory 개체를 사용하여 기존 및 활성 Access 서비스의 동일한 위치에서 새 서비스를 한정합니다. 이렇게 하려면 요청에서 배열과 serviceInventory 개체를 생략 place 해야 하며, 그렇지 않으면 API가 오류를 반환합니다.

    데이터 유형: 객체

    "referenceServiceInventory": {
"id": "String"
}
    serviceQualificationItem.service.referenceServiceInventory.id 요청에서 사용하는 serviceQualificationItem.service.referenceServiceInventory 경우 필수입니다. 필요한 위치에 대한 활성 서비스를 참조하는 유효한 서비스 인벤토리 엔터티의 sys_id입니다. 이 정보는 주문 작업 메모에만 언급됩니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic 옵션입니다. 서비스 특성의 배열입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String",
  "valueType": "String",
  }
]
    serviceQualificationItem.service.serviceCharacteristic.name 필수 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.value 옵션입니다. 특성의 값입니다. TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 주석입니다. 이 값은 항상 ServiceQualificationItem입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.valueType 옵션입니다. 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceInventory 옵션입니다. 업그레이드 또는 다운그레이드가 필요한 활성 서비스를 참조하는 유효한 서비스 인벤토리 엔터티입니다.
    중요사항:
    serviceInventory 서비스 업그레이드 또는 다운그레이드에 객체를 사용합니다. 이렇게 하려면 요청에서 장소 array 와 referenceServiceInventory 객체를 생략해야 하며, 그렇지 않으면 API가 오류를 반환합니다.

    데이터 유형: 객체

    "serviceInventory": {
  "id": "String"
}
    serviceQualificationItem.service.serviceSpecification 필수 적격성 평가 항목에 대한 서비스 사양입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있는 고객 주문 라인 항목의 service_specification 필드에 저장됩니다. 적격성 평가 항목의 서비스 사양은 자원에 직면할 수 없습니다.

    데이터 형식: 개체

    "serviceSpecification": {
  “@type”: ”String”,
  "id": "String",
  "name": "String"
}
    serviceQualificationItem.service.serviceSpecification.@type 옵션입니다. TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.id 필수 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.internalVersion 옵션입니다. 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem.service.serviceSpecification.name 필수 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.version 옵션입니다. 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열

    헤더

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

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

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 18. 상태 코드
    상태 코드 설명
    201 요청이 성공적으로 처리되었습니다.
    주:
    특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 기존 배송 주문과 유사하게 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다
    400 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
    • 페이로드가 비어 있습니다.
    • 잘못된 페이로드: 필수 필드 누락: <필드 이름>
    • 잘못된 페이로드: 요청 본문 누락 - 요청 본문에 페이로드가 전달되지 않았습니다.
    • 잘못된 페이로드: relatedParty가 누락되었습니다.
    • 잘못된 페이로드: serviceQualificationItem이 누락되었습니다.
    • 잘못된 페이로드: serviceQualificationItem ID가 누락되었습니다.
    • 잘못된 페이로드: serviceQualificationItem 서비스가 누락되었습니다.
    • 잘못된 페이로드: 위치 정보가 누락되었습니다. place, serviceInventory 또는 referenceServiceInventory를 제공하십시오.
    • 잘못된 페이로드: 사양 정보가 없습니다. serviceSpecification 또는 serviceInventory를 제공하십시오.
    • 잘못된 페이로드: 서비스 사양이 없습니다.
    • 잘못된 페이로드: 고객 계정이 없습니다.
    • 잘못된 페이로드: 소비자가 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    표 19. 응답 본문에 반환된 요소
    요소 설명
    id 적격성 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    href 적격성 평가 주문 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열
    설명 고객 주문의 short_description 필드에서 가져오는 적격성 평가 요청에 대한 설명입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    externalId 고객 주문 external_id 필드의 외부 ID입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    적격성 결과 고객 주문 결과 필드의 자격 상태입니다. 가능한 값:
    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    상태 고객 주문 상태 필드의 고객 주문 상태입니다.

    데이터 유형: 문자열
    @type TMF Open API 표준의 일부입니다. 자격에 대한 주석입니다. 이 값은 항상 CheckServiceQualification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    checkServiceQualificationDate 고객 주문의 order_date 필드에서 생성된 적격성 평가 요청의 날짜 및 시간입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    effectiveQualificationDate (유효적격성 평가) 고객 주문의 order_date 필드에서 가져온 유효 자격 날짜입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    예상 적격성 평가 날짜 예상 적격성 평가 날짜를 저장합니다. 고객 주문의 expected_end_date 필드에 유지됩니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    관련파티 적격성 평가 요청을 위한 연락처 목록입니다. 각 접점은 배열의 개체입니다.

    데이터 형식: 객체 배열

    "relatedParty": [
  {
    "id": "String",
    "name": "String",
    "@referredType": "String",
    "@type": "String"
  }
]
    relatedParty.id 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account] 테이블, 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.

    데이터 유형: 문자열
    relatedParty.name 계정, 고객 또는 소비자의 이름입니다.

    데이터 유형: 문자열
    relatedParty.@type TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    relatedParty.@referredType 관련 당사자의 유형입니다.
    가능한 값:
    • 소비자
    • 고객
    • 고객 연락처

    데이터 유형: 문자열
    serviceQualificationItem 위치, 서비스 정보 및 서비스 특성에 대한 정보가 포함된 서비스 적격성 평가 항목의 목록입니다. 고객 주문에 대한 주문 라인 항목으로 저장됩니다.

    데이터 형식: 객체 배열

    "serviceQualificationItem": [
  {
  "id": "String",
  "action": "String",
  "expectedServiceAvailabilityDate": "Number",
  "service": {Object},
  "@type": "String"
  }
],
    serviceQualificationItem.id 자격 항목의 ID입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있는 고객 주문 라인 항목의 external_id 필드에 저장됩니다.

    데이터 유형: 문자열
    serviceQualificationItem.qualificationResult 적격성 항목의 결과입니다. 고객 주문 라인 항목의 "결과" 필드에 저장됩니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    가능한 값:

    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    serviceQualificationItem.state 고객 주문 라인 항목의 "상태" 필드에서 파생된 자격 항목의 상태입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 문자열
    serviceQualificationItem.quantity 고객 주문 라인 항목의 "수량" 필드에서 파생된 자격 항목의 수량입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 숫자
    serviceQualificationItem.@type TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 주석입니다. 이 값은 항상 ServiceQualificationItem입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service 위치(장소), 서비스 사양 및 서비스 특성에 대한 세부 정보를 포함하는 서비스 정보입니다.

    데이터 유형: 객체

    "service": {
  "@type": "String",
  "place": [Array],
  "serviceCharacteristic": [Array],
  "serviceSpecification": {Object}
}
    serviceQualificationItem.service.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 Service입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place 서비스 적격성 항목에 대한 위치 정보입니다.

    데이터 형식: 개체 배열

    주:
    이 배열에는 하나의 위치만 포함될 수 있습니다.
    "place": [
  {
  "id": "String",
  "name": "String",
  "@referredType": "String"
  }
]

    serviceQualificationItem.service.place.id

    		 위치 [cmn_location] 테이블의 위치 Sys_id입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.name 위치 이름입니다. 위치 [cmn_location] 테이블의 항목에 대해 검증되지 않았습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 GeographicSite입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification 적격성 평가 항목에 대한 서비스 사양 상세 정보입니다.

    데이터 형식: 개체 배열

    "serviceSpecification": {
  "id": "String",
  "internalVersion": "Number",
  "internalId": "String",
  "name": "String"
  "@type": "ServiceSpecification"
  "version": "String",
}
    serviceQualificationItem.service.serviceSpecification.id 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.name 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.version 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.internalVersion 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem.service.serviceSpecification.internalId 서비스 사양의 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic 서비스 특성 목록입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String"
  "valueType": "String",
  }
]
    serviceQualificationItem.service.serviceCharacteristic.valueType 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.name 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.value 특성의 값입니다.

    데이터 유형: 문자열

    사용 사례 1

    다음 예제에서는 단일 한정 항목을 포함하는 간단한 요청을 보여 줍니다.

    curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@type": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "@type": "ServiceSpecification"
        }
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

    응답:

    {
  "id": "0b45c47938bf1110f877c8d44c4b895d",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0b45c47938bf1110f877c8d44c4b895d",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "none",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "91478553b7969910ff00f203ae11a97d",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

    사용 사례 2

    다음 예제에서는 ID를 사용하여 간단한 서비스 자격을 요청하여 기존 서비스로 고객의 위치를 가져오는 방법을 보여 줍니다.

    주:
    참조 서비스 ID = is 위치 = 20220인 제품 인벤토리입니다. Bow Willow, Houston,TX
    curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "referenceServiceInventory": {
          "id": "f1b2d99e777301108e191e599a5a99d2"
        },
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "@type": "ServiceSpecification"
        }
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

    응답입니다. 여기서 place 는 요청에서 채워집니다 referenceServiceInventory .

    {
    "id": "1683497138b35110f877c8d44c4b890a",
   "href":"/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/1683497138b35110f877c8d44c4b890a",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "serviceQualificationItem": [
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [
                    {
                        "name": "Speed",
                        "valueType": "choice",
                        "value": "High"
                    }
                ],
                "serviceSpecification": {
                    "id": "91478553b7969910ff00f203ae11a97d",
                    "name": "Broadband Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "91478553b7969910ff00f203ae11a97d",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "25aba4010a0a0bb3008f329002f12211",
                    "name": "20220 Bow Willow, Houston,TX",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
    "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

    사용 사례 3

    다음 예제에서는 사용자의 광대역 서비스를 더 빠른 속도로 업그레이드하는 방법을 보여 줍니다. id = is a service inventory with service specification = "Broadband Service", Location = 20220 Bow Willow, Houston, TX, Characteristics=[{Speed:Medium}]인 제품 인벤토리입니다.

    {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "serviceInventory": {
          "id": "f1b2d99e777301108e191e599a5a99d2"
        },
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ]
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}
    응답으로, 여기서 place 및 specification 요청에서 채워집니다 serviceInventory .
    주:
    특성은 먼저 요청 페이로드에서 가져온 다음 나머지 특성(있는 경우)은 serviceInventory에서 가져옵니다.
    {
    "id": " db8485b138b35110f877c8d44c4b892b",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/ db8485b138b35110f877c8d44c4b892b",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "serviceQualificationItem": [
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [
                    {
                        "name": "Speed",
                        "valueType": "choice",
                        "value": "High"
                    }
                ],
                "serviceSpecification": {
                    "id": "91478553b7969910ff00f203ae11a97d",
                    "name": "Broadband Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "91478553b7969910ff00f203ae11a97d",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "25aba4010a0a0bb3008f329002f12211",
                    "name": "20220 Bow Willow, Houston,TX",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
    "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

    사용 사례 4

    상위 및 하위 라인 항목의 계층 구조와 관계 유형을 설명합니다. 수량 속성을 통해 여러 광고 항목을 만드는 방법을 보여줍니다.

    curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "quantity": 2,
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasChild",
          "id": "110"
        },
        {
          "relationshipType": "HasChild",
          "id": "120"
        },
        {
          "relationshipType": "HasChild",
          "id": "130"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "string",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "b3933d9d45f31150f877e0588eca21fc",
          "name": "Access Service"
        }
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "110",
      "action": "add",
      "expectedServiceAvailabilityDate": "2022-12-10T19:20:39.239Z",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Fiber Speed",
            "value": "1Gbps"
          }
        ],
        "serviceSpecification": {
          "name": "CFS3",
          "internalVersion": "1",
          "id": "4d2b5799457b1150f877e0588eca2116"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "120",
      "action": "add",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "expectedServiceAvailabilityDate": "2022-11-12T19:20:39.239Z",
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "DSL Speed",
            "value": "500 Mbps"
          }
        ],
        "serviceSpecification": {
          "name": "CF1",
          "internalVersion": "1",
          "id": "1d43f91d45f31150f877e0588eca21cd"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "130",
      "action": "add",
      "expectedServiceAvailabilityDate": "2020-04-11T19:20:39.239Z",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Wireless Speed",
            "value": "100 Mbps"
          }
        ],
        "serviceSpecification": {
          "name": "CFS2",
          "internalVersion": "1",
          "id": "28733d1d45f31150f877e0588eca2163"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

    응답:

    {
  "id": "7bf9cd7538b35110f877c8d44c4b89e4",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/7bf9cd7538b35110f877c8d44c4b89e4",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "none",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "120",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "DSL Speed",
            "valueType": "choice",
            "value": "500 Mbps"
          }
        ],
        "serviceSpecification": {
          "id": "1d43f91d45f31150f877e0588eca21cd",
          "name": "CFS1",
          "version": "",
          "internalVersion": "1",
          "internalId": "1d43f91d45f31150f877e0588eca21cd",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "110",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Fiber Speed",
            "valueType": "choice",
            "value": "1Gbps"
          }
        ],
        "serviceSpecification": {
          "id": "4d2b5799457b1150f877e0588eca2116",
          "name": "CFS3",
          "version": "",
          "internalVersion": "1",
          "internalId": "4d2b5799457b1150f877e0588eca2116",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "130",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Wireless Speed",
            "valueType": "choice",
            "value": "100 Mbps"
          }
        ],
        "serviceSpecification": {
          "id": "28733d1d45f31150f877e0588eca2163",
          "name": "CFS2",
          "version": "",
          "internalVersion": "1",
          "internalId": "28733d1d45f31150f877e0588eca2163",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "100",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "2",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "b3933d9d45f31150f877e0588eca21fc",
          "name": "Access Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "b3933d9d45f31150f877e0588eca21fc",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

    기술 서비스 적격성 평가 Open API - POST sn_ord_qual_mgmt/적격성 평가/checkServiceQualification/processResult

    기술 서비스 적격성 평가 Open API로 전송된 기술 서비스 적격성 평가 결과를 처리합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 21. 쿼리 매개변수
    이름 설명
    없음
    표 22. 요청 본문 매개변수(XML 또는 JSON)
    매개변수 설명
    serviceQualificationItem 필수 요청된 상위 주문 라인 항목에 대한 서비스 주문 테이블 [sn_ind_tmt_orm_service_order]의 도메인 주문을 각각 나타내는 서비스 적격성 평가 항목 목록입니다. 각 서비스 적격성 평가 항목으로 표현되는 모든 도메인 주문은 동일한 상위 주문 라인 항목에 속해야 합니다.

    데이터 형식: 객체 배열

    "serviceQualificationItem": [
{
  "@type": "String",
  "alternateServiceProposal": [Array],
  "id": "String",
  "qualificationResult": "String"
}
]
    serviceQualificationItem.@type 옵션입니다. TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 주석입니다. 이 값은 항상 ServiceQualificationItem입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal 옵션입니다. 적격성 평가 항목에 대해 제공된 대체 제안입니다. 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블에 저장됩니다.

    데이터 형식: 개체 배열

    "alternateServiceProposal": [
  {
  "@type": "String",
  "alternateService": {Object},
  "alternateServiceAvailabilityDate": "Number",
  "id": "String",
  "serviceCharacteristic": [Array]
  }
]
    serviceQualificationItem.alternateProposal.@type 옵션입니다. TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 서비스 정보에 대한 주석입니다. 이 값은 항상 Service입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService 필수 서비스 사양 및 특성을 포함하는 대체 제안에 대한 서비스 정보입니다.

    데이터 유형: 객체

    "alternateService": {
  "@type": "String",
  "serviceSpecification": {Object},
  "serviceCharacteristic": [Array]
}
    serviceQualificationItem.alternateProposal.alternateService.alternateService.serviceCharacteristic.valueType 대체 서비스 제안에 따른 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic 대체 서비스 제안에 대한 서비스 특성 배열로, 대체 제안 테이블 [sn_ord_qual_mgmt_alternate_proposal]의 "order_characteristics" 필드에 문자열로 저장됩니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "valueType": "String",
  "name": "String",
  "value": "String"
  }
]
    serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name 필수 대체 서비스 제안에 속하는 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value 대체 서비스 제안에 속하는 특성의 값입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService .serviceSpecification 필수 대체 제안의 서비스 사양입니다. 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블의 대체 제안 항목의 사양 필드에 저장됩니다.

    데이터 형식: 개체

    "serviceSpecification": {
  “@type”: ”String”
  "id": "String",
  "name": "String"
}
    serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id 필수 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion 서비스 사양의 내부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.alternateServiceAvailabilityDate 옵션입니다. 대체 서비스 사용 가능한 날짜입니다. 도메인 주문 정보가 현재 서비스 적격성 평가 항목이 나타내는 도메인 주문에 속하는 대체 제안 테이블 [sn_ord_qual_mgmt_alternate_proposal]의 'available_date' 필드에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    serviceQualificationItem.alternateProposal.id 옵션입니다. 대체 제안에 대한 사용자 정의 ID입니다. 이 데이터는 유지되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason 옵션입니다. 서비스 자격이 적합하지 않은 이유입니다. 전체 이유 목록은 도메인 주문 [sn_ind_tmt_orm_domain_order] 테이블의 'unavailability_reason' 필드에 문자열로 레이블 필드와 함께 유지됩니다.

    데이터 형식: 개체

    "eligibilityUnavailabilityReason": [
  {
  "code": "String",
  "label": "String"
  }
]
    serviceQualificationItem.eligibilityUnavailabilityReason.code 옵션입니다. 자격을 사용할 수 없는 이유에 대한 코드입니다. 이 정보는 유지되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason.label 필수 자격을 사용할 수 없는 이유에 대한 레이블입니다. 부적격 사유가 여러 개 있는 경우 레이블은 ',"로 구분되어 도메인 주문[sn_ind_tmt_orm_domain_order] 테이블의 'unavailability_reason' 필드에 저장됩니다.

    데이터 유형: 문자열
    serviceQualificationItem.id

    필수 적격성 평가 항목으로 나타내는 도메인 주문의 Sys_id입니다. 도메인 주문 [sn_ind_tmt_orm_service_order]의 Sys_id 필드에 저장됩니다.

    데이터 유형: 문자열
    serviceQualificationItem.qualificationResult 필수 도메인 주문 테이블 [sn_ind_tmt_orm_service_order]의 결과 필드에 유지되는 각 서비스 적격성 평가 항목의 적격성 평가 결과입니다.

    데이터 유형: 문자열

    헤더

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

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

    기본값: application/json
    표 24. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 25. 상태 코드
    상태 코드 설명
    201 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
    • 잘못된 페이로드: 자격 결과는 [alternate, pending, qualified, unqualified] 중 하나여야 합니다.
    • 잘못된 페이로드: 자격 항목 ID가 없습니다.
    • 모든 자격 항목은 동일한 상위 주문 라인 항목에 속해야 합니다.
    • 잘못된 페이로드: serviceQualificationItem qualificationResult가 누락되었습니다.
    • 잘못된 페이로드: 소비자가 없습니다.

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

    이름 설명
    id 적격성 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    href 적격성 평가 주문 기록에 대한 상대 링크입니다.

    데이터 유형: 문자열
    설명 고객 주문의 short_description 필드에서 가져오는 적격성 평가 요청에 대한 설명입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    externalId 고객 주문 external_id 필드의 외부 ID입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    데이터 유형: 문자열
    적격성 결과 고객 주문 결과 필드의 자격 상태입니다. 가능한 값:
    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    상태 고객 주문 상태 필드의 고객 주문 상태입니다.

    데이터 유형: 문자열
    @type TMF Open API 표준의 일부입니다. 자격에 대한 주석입니다. 이 값은 항상 CheckServiceQualification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    checkServiceQualificationDate 고객 주문의 order_date 필드에서 생성된 적격성 평가 요청의 날짜 및 시간입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    effectiveQualificationDate (유효적격성 평가) 고객 주문의 order_date 필드에서 가져온 유효 자격 날짜입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    예상 적격성 평가 날짜 예상 적격성 평가 날짜를 저장합니다. 고객 주문의 expected_end_date 필드에 유지됩니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다.

    형식: YYYY-MM-DDTHH:MM:SS. 증권 시세 표시기

    데이터 유형: 문자열
    관련파티 적격성 평가 요청을 위한 연락처 목록입니다. 각 접점은 배열의 개체입니다.

    데이터 형식: 객체 배열

    "relatedParty": [
  {
    "id": "String",
    "name": "String",
    "@referredType": "String",
    "@type": "String"
  }
]
    relatedParty.id 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account] 테이블, 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.

    데이터 유형: 문자열
    relatedParty.name 계정, 고객 또는 소비자의 이름입니다.

    데이터 유형: 문자열
    relatedParty.@type TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    relatedParty.@referredType 관련 당사자의 유형입니다.
    가능한 값:
    • 소비자
    • 고객
    • 고객 연락처

    데이터 유형: 문자열
    serviceQualificationItem 위치, 서비스 정보 및 서비스 특성에 대한 정보가 포함된 서비스 적격성 평가 항목의 목록입니다. 고객 주문에 대한 주문 라인 항목으로 저장됩니다.

    데이터 형식: 객체 배열

    "serviceQualificationItem": [
  {
  "id": "String",
  "action": "String",
  "expectedServiceAvailabilityDate": "Number",
  "service": {Object},
  "@type": "String"
  }
],
    serviceQualificationItem.id 자격 항목의 ID입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있는 고객 주문 라인 항목의 external_id 필드에 저장됩니다.

    데이터 유형: 문자열
    serviceQualificationItem.qualificationResult 적격성 항목의 결과입니다. 고객 주문 라인 항목의 "결과" 필드에 저장됩니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    가능한 값:

    • 대체
    • 없음
    • 보류 중
    • 자격 만족
    • 정규화 되지 않은

    데이터 유형: 문자열
    serviceQualificationItem.state 고객 주문 라인 항목의 "상태" 필드에서 파생된 자격 항목의 상태입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 문자열
    serviceQualificationItem.quantity 고객 주문 라인 항목의 "수량" 필드에서 파생된 자격 항목의 수량입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블에 있습니다.

    데이터 유형: 숫자
    serviceQualificationItem.@type TMF Open API 표준의 일부입니다. 적격성 평가 항목에 대한 주석입니다. 이 값은 항상 ServiceQualificationItem입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service 위치(장소), 서비스 사양 및 서비스 특성에 대한 세부 정보를 포함하는 서비스 정보입니다.

    데이터 유형: 객체

    "service": {
  "@type": "String",
  "place": [Array],
  "serviceCharacteristic": [Array],
  "serviceSpecification": {Object}
}
    serviceQualificationItem.service.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 Service입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place 서비스 적격성 항목에 대한 위치 정보입니다.

    데이터 형식: 개체 배열

    주:
    이 배열에는 하나의 위치만 포함될 수 있습니다.
    "place": [
  {
  "id": "String",
  "name": "String",
  "@referredType": "String"
  }
]

    serviceQualificationItem.service.place.id

    		 위치 [cmn_location] 테이블의 위치 Sys_id입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.name 위치 이름입니다. 위치 [cmn_location] 테이블의 항목에 대해 검증되지 않았습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.place.@type TMF Open API 표준의 일부입니다. 서비스에 대한 주석입니다. 이 값은 항상 GeographicSite입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification 적격성 평가 항목에 대한 서비스 사양 상세 정보입니다.

    데이터 형식: 개체 배열

    "serviceSpecification": {
  "id": "String",
  "internalVersion": "Number",
  "internalId": "String",
  "name": "String"
  "@type": "ServiceSpecification"
  "version": "String",
}
    serviceQualificationItem.service.serviceSpecification.id 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.name 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.version 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.internalVersion 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem.service.serviceSpecification.internalId 서비스 사양의 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic 서비스 특성 목록입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String"
  "valueType": "String",
  }
]
    serviceQualificationItem.service.serviceCharacteristic.valueType 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.name 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem.service.serviceCharacteristic.value 특성의 값입니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal 적격성 평가 주문에 대한 대체 서비스 제안. 대체 제안은 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블에 저장됩니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal.id 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블의 대체 제안 항목 Sys_id입니다.

    데이터 유형: 문자열
    ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블에 있는 대체 제안 항목의 available_date 필드 값입니다.

    데이터 유형: 문자열
    serviceQualificationItem.alternateServiceProposal.alternateService 대체 제안으로 표시되는 서비스 정보입니다.

    데이터 형식: 개체
    serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification 대체 제안의 서비스 사양은 대체 제안 [sn_ord_qual_mgmt_alternate_proposal] 테이블의 사양에 유지됩니다.

    데이터 유형: 객체
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.id 대체 서비스 사양의 외부 ID 또는 초기 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.name 대체 서비스 사양의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.version 대체 서비스 사양의 외부 버전입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.internalVersion 대체 서비스 사양의 내부 버전입니다.

    데이터 유형: 숫자
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.internalId 대체 서비스 사양의 초기 버전입니다.

    데이터 유형: 문자열
    ServiceQualificationItem입니다. alternateServiceProposal.alternateService.serviceSpecification.@type TMF Open API 표준의 일부입니다. 서비스 사양에 대한 주석입니다. 이 값은 항상 ServiceSpecification입니다. 이 정보는 저장되지 않습니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic 대체 서비스 제안에 대한 서비스 특성의 배열입니다.

    데이터 형식: 개체 배열

    "serviceCharacteristic": [
  {
  "name": "String",
  "value": "String",
  "valueType": "String"
  }
]
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.valueType 대체 서비스 특성의 값 유형입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.name 대체 서비스 특성의 이름입니다.

    데이터 유형: 문자열
    serviceQualificationItem입니다. alternateServiceProposal.alternateService.serviceCharacteristic.value 대체 서비스 특성의 값입니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason 서비스를 사용할 수 없는 이유를 설명하는 서비스 자격 사용할 수 없는 사유 목록입니다. 이 값은 도메인 주문 [sn_ind_tmt_orm_domain_order] 테이블의 unavailability_reason 필드에 유지됩니다.

    데이터 유형: 배열
    serviceQualificationItem.eligibilityUnavailabilityReason.code 서비스 자격을 사용할 수 없는 이유 코드입니다.

    데이터 유형: 문자열
    serviceQualificationItem.eligibilityUnavailabilityReason.label 서비스 자격을 사용할 수 없는 이유 레이블입니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    다음 예제에서는 엔드포인트가 API 요청에서 전송된 적격성 주문을 처리하는 방법을 보여줍니다.

    curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "serviceQualificationItem": [
    {
      "eligibilityUnavailabilityReason": [
        {
          "code": "26-001",
          "label": "not enough bandwith at this place"
        }
      ],
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "295580b938bf1110f877c8d44c4b8912"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "action": "add",
      "id": "295580b938bf1110f877c8d44c4b8915"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "2d5580b938bf1110f877c8d44c4b8902"
    }
  ],
  "@type": "CheckServiceQualification",
  "description": "check service qualification illustration"
}

    응답 본문:

    {
  "id": "0b45c47938bf1110f877c8d44c4b895d",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0b45c47938bf1110f877c8d44c4b895d",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "alternate",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "qualificationResult": "alternate",
      "state": "in_progress",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "91478553b7969910ff00f203ae11a97d",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      },
      "alternateServiceProposal": [
        {
          "id": "350e66a2e5331110f87741b459ef19b0",
          "alternateServiceAvailabilityDate": "2022-12-15 19:20:39",
          "alternateService": {
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ],
            "serviceSpecification": {
              "id": "23e7ed67c32310105252716b7d40dd80",
              "name": "Mobile Service",
              "version": "",
              "internalVersion": "1",
              "internalId": "23e7ed67c32310105252716b7d40dd80",
              "@type": "ServiceSpecification"
            },
            "@type": "Service"
          },
          "@type": "AlternateServiceProposal"
        }
      ],
      "eligibilityUnavailabilityReason": [
        {
          "label": "not enough bandwith at this place",
          "@type": "string"
        }
      ]
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}