서비스 카탈로그 오픈 API

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

    • Service Catalog Open API는 서비스 사양을 작성하고 검색하기 위한 엔드포인트를 제공합니다.

    이 API를 사용하여 외부 시스템과 .Now Platform Service Catalog Open API는 TM Forum Service Catalog API REST 사양의 구현입니다ServiceNow®. 이 구현은 TMF633 서비스 카탈로그 API REST 사양 버전 4, 2020년 10월을 기반으로 합니다.

    이 API는 에서 사용할 수 ServiceNow Store있는 Product Catalog Advanced 애플리케이션에 포함되어 있습니다.

    이 API는 sn_prd_pm_adv 네임스페이스 내에서 제공됩니다.

    호출하는 사용자에게는 sn_prd_pm_adv.catalog_integrator 역할이 있어야 합니다.

    이 API는 다음 테이블의 데이터를 만들고 업데이트합니다.
    • 특성 [sn_prd_pm_characteristic]
    • 특성 옵션 [sn_prd_pm_characteristic_option]
    • 서비스 사양 [sn_prd_pm_service_specification]
    • 사양 관계 [sn_prd_pm_specification_relationship]

    서비스 카탈로그 오픈 - GET /servicespecification

    모든 서비스 사양의 목록을 검색합니다.

    URL 형식

    기본 URL: /api/sn_prd_pm_adv/catalogmanagement/servicespecification

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    없음
    표 2. 쿼리 매개변수
    이름 설명
    필드 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다.

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

    기본값: 20

    최대: 100

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

    기본값: 0

    데이터 유형: 숫자
    상태 상태별로 서비스 사양을 필터링합니다. 이 매개변수의 값과 일치하는 상태를 가진 사양만 응답에 반환됩니다.

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

    헤더

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

    표 4. 요청 헤더
    헤더 설명
    없음
    표 5. 응답 헤더
    헤더 설명
    콘텐츠 범위 페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다.

    예를 들어 offset=2 및 limit=3인 경우 헤더의 Content-Range 값은 항목 3-5입니다.
    컨텐츠-형식 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.
    링크 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
    • 첫 번째
    • 마지막
    • 다음
    • 이전
    X-Total-Count 페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

    상태 코드

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

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

    응답 본문 매개변수(JSON)

    이름 설명
    설명 사양에 대한 설명입니다.

    데이터 유형: 문자열
    externalId 서비스 사양의 External_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    id 서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    internalId 서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    internalVersion 서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    마지막 업데이트 사양이 마지막으로 업데이트된 날짜입니다.

    데이터 유형: 문자열
    이름 사양의 이름입니다.

    데이터 유형: 문자열
    resourceSpecification 이 서비스 사양의 자원 사양입니다.

    데이터 유형: 배열

    "resourceSpecification": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id 자원 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    resourceSpecification.internalId 자원 사양의 Initial_version입니다.

    데이터 유형: 문자열
    resourceSpecification.internalVersion 자원 사양의 External_version입니다.

    데이터 유형: 문자열
    resourceSpecification.name 자원 사양의 이름입니다.

    데이터 유형: 문자열
    resourceSpecification.version 자원 사양의 버전입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship 이 사양과 다른 서비스 사양의 관계입니다.

    데이터 유형: 배열

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id 관련 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.internalId 관련 사양의 Initial_version입니다.
    serviceSpecificationRelationship.internalVersion 관련 사양의 버전입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.relationshipType 관계의 유형입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.validFor 관계가 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    serviceSpecificationRelationship.validFor.endDateTime 관계의 종료 날짜입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.validFor.startDateTime 관계의 시작 날짜입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.version 관련 사양의 External_version입니다.

    데이터 유형: 문자열
    spec특성 사양 특성.

    데이터 유형: 배열

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    specCharacteristic.characteristicValueSpecification 특성의 가능한 값을 포함하는 배열입니다.

    데이터 유형: 배열

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    specCharacteristic.characteristicValueSpecification.value 특성의 값입니다.

    데이터 유형: 문자열
    specCharacteristic.description 특성에 대한 설명입니다.

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

    데이터 유형: 문자열
    specCharacteristic.validFor 특성이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    specCharacteristic.validFor.endDateTime 특성의 종료 날짜입니다.

    데이터 유형: 문자열
    specCharacteristic.validFor.startDateTime 특성의 시작 날짜입니다.

    데이터 유형: 문자열
    specCharacteristic.valueType 특성의 값 유형(예: 선택 또는 이메일)입니다.

    데이터 유형: 문자열
    validFor 사양이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    validFor.endDateTime 사양의 종료 날짜입니다.

    데이터 유형: 문자열
    validFor.startDateTime 사양의 시작 날짜입니다.

    데이터 유형: 문자열
    버전 서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    @type 사양의 유형입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예에서는 모든 서비스 사양을 검색합니다.

    curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \
--user 'username':'password'

    응답 본문입니다.

    [
   {
      "id": "16d79ec3532520103b6bddeeff7b12a6",
      "name": "SD WAN Optimization Service",
      "description": "SD WAN Optimization Service",
      "lastUpdate": "2022-01-23 22:48:55",
      "validFor": {
         "startDateTime": "2022-01-12",
         "endDateTime": "2027-02-11"
      },
      "serviceSpecificationRelationship": [
         {
            "id": "a1f5fe981bb420106ba59acf034bcb4f",
            "name": "Deduplication and Compression",
            "version": "1",
            "type": "rfs",
            "validFor": {
               "startDateTime": "2021-02-11",
               "endDateTime": "2027-02-11"
            }
         }
      ],
      "resourceSpecification": [],
      "serviceSpecCharacteristic": [
         {
            "name": "SSL Optimization",
            "description": "SSL Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:47:57"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "False",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "True",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "CIFS Optimization",
            "description": "CIFS Optimization Protocol",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:49:09"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "SMB1",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "SMB2",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         }
      ]
   },
   {
      "id": "31c5caff07266010a7955b7e0ad3006b",
      "name": "Firewall Administration",
      "description": "Firewall Administration",
      "lastUpdate": "2022-01-23 11:46:48",
      "validFor": {
         "startDateTime": "2021-11-22",
         "endDateTime": ""
      },
      "serviceSpecificationRelationship": [],
      "resourceSpecification": [
         {
            "id": "3546463307666010a7955b7e0ad3005d",
            "name": "Cisco Firewall Management system",
            "version": "1"
         }
      ],
      "serviceSpecCharacteristic": [
         {
            "name": "Firewall Administration CPE Model",
            "description": "Firewall Administration CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:55:37"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "2100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "4100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "7300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "9300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Firewall Administration CPE Type",
            "description": "Firewall Administration CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:53:45"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Configuration and Policy backup",
            "description": "Configuration and Policy backup",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:46:02"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Weekly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Monthly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Daily",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Remote CLI troubleshoot support",
            "description": "Remote CLI troubleshoot support",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:45:38"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Standard support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Basic support",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Firewall Administration CPE ID",
            "description": "Firewall Administration CPE ID",
            "valueType": "single_line_text",
            "validFor": {
               "startDatetime": "2022-02-20 00:57:50"
            },
            "productSpecCharacteristicValue": []
         }
      ]
   }
]

    서비스 카탈로그 오픈 - GET /servicespecification/{specificationId}

    서비스 사양을 조회합니다.

    URL 형식

    기본 URL: /api/sn_prd_pm_adv/catalogmanagement/servicespecification/{specificationId}

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    사양 ID 검색할 서비스 사양의 Sys_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    표 8. 쿼리 매개변수
    이름 설명
    필드 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다.

    데이터 유형: 문자열
    상태 상태별로 서비스 사양을 필터링합니다. 이 매개변수의 값과 일치하는 상태를 가진 사양만 응답에 반환됩니다.

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

    헤더

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

    표 10. 요청 헤더
    헤더 설명
    없음
    표 11. 응답 헤더
    헤더 설명
    컨텐츠-형식 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

    상태 코드

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

    표 12. 상태 코드
    상태 코드 설명
    200 요청이 성공적으로 처리되었습니다.
    400
    잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
    • 잘못된 경로 매개변수
    • 잘못된 URI
    404 기록 없음 ID와 관련된 기록을 테이블에서 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    설명 사양에 대한 설명입니다.

    데이터 유형: 문자열
    externalId 서비스 사양의 External_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    id 서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    internalId 서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    internalVersion 서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    마지막 업데이트 사양이 마지막으로 업데이트된 날짜입니다.

    데이터 유형: 문자열
    이름 사양의 이름입니다.

    데이터 유형: 문자열
    resourceSpecification 이 서비스 사양의 자원 사양입니다.

    데이터 유형: 배열

    "resourceSpecification": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id 자원 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    resourceSpecification.internalId 자원 사양의 Initial_version입니다.

    데이터 유형: 문자열
    resourceSpecification.internalVersion 자원 사양의 External_version입니다.

    데이터 유형: 문자열
    resourceSpecification.name 자원 사양의 이름입니다.

    데이터 유형: 문자열
    resourceSpecification.version 자원 사양의 버전입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship 이 사양과 다른 서비스 사양의 관계입니다.

    데이터 유형: 배열

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id 관련 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.internalId 관련 사양의 Initial_version입니다.
    serviceSpecificationRelationship.internalVersion 관련 사양의 버전입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.relationshipType 관계의 유형입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.validFor 관계가 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    serviceSpecificationRelationship.validFor.endDateTime 관계의 종료 날짜입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.validFor.startDateTime 관계의 시작 날짜입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.version 관련 사양의 External_version입니다.

    데이터 유형: 문자열
    spec특성 사양 특성.

    데이터 유형: 배열

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    specCharacteristic.characteristicValueSpecification 특성의 가능한 값을 포함하는 배열입니다.

    데이터 유형: 배열

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    specCharacteristic.characteristicValueSpecification.value 특성의 값입니다.

    데이터 유형: 문자열
    specCharacteristic.description 특성에 대한 설명입니다.

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

    데이터 유형: 문자열
    specCharacteristic.validFor 특성이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    specCharacteristic.validFor.endDateTime 특성의 종료 날짜입니다.

    데이터 유형: 문자열
    specCharacteristic.validFor.startDateTime 특성의 시작 날짜입니다.

    데이터 유형: 문자열
    specCharacteristic.valueType 특성의 값 유형(예: 선택 또는 이메일)입니다.

    데이터 유형: 문자열
    validFor 사양이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    validFor.endDateTime 사양의 종료 날짜입니다.

    데이터 유형: 문자열
    validFor.startDateTime 사양의 시작 날짜입니다.

    데이터 유형: 문자열
    버전 서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    @type 사양의 유형입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예에서는 방화벽 서비스에 대한 서비스 사양을 검색합니다.

    curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification/31c5caff07266010a7955b7e0ad3006b" \
--user 'username':'password'

    응답 본문입니다.

    {
   "id": "31c5caff07266010a7955b7e0ad3006b",
   "name": "Firewall Administration",
   "description": "Firewall Administration",
   "lastUpdate": "2022-01-23 11:46:48",
   "validFor": {
      "startDateTime": "2021-11-22",
      "endDateTime": ""
   },
   "serviceSpecificationRelationship": [],
   "resourceSpecification": [
      {
         "id": "3546463307666010a7955b7e0ad3005d",
         "name": "Cisco Firewall Management system",
         "version": "1"
      }
   ],
   "serviceSpecCharacteristic": [
      {
         "name": "Firewall Administration CPE Model",
         "description": "Firewall Administration CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:55:37"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "2100 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "4100 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "7300 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "9300 series",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Firewall Administration CPE Type",
         "description": "Firewall Administration CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:53:45"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Configuration and Policy backup",
         "description": "Configuration and Policy backup",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:46:02"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Weekly",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Monthly",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Daily",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Remote CLI troubleshoot support",
         "description": "Remote CLI troubleshoot support",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:45:38"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Standard support",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium support",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Basic support",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Firewall Administration CPE ID",
         "description": "Firewall Administration CPE ID",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2022-02-20 00:57:50"
         },
         "productSpecCharacteristicValue": []
      }
   ]
}

    서비스 카탈로그 오픈 - POST /servicespecification

    서비스 사양을 작성합니다.

    URL 형식

    기본 URL: /api/sn_prd_pm_adv/catalogmanagement/servicespecification

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    없음
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(JSON)
    이름 설명
    설명 필수 사양에 대한 설명입니다.

    데이터 유형: 문자열
    externalId 서비스 사양의 External_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    둘 다 externalId AND id 가 제공되는 경우 동일한 사양을 참조해야 합니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    id 서비스 사양의 Initial_version 또는 external_id입니다. 제공되지 않은 경우 id 이 엔드포인트는 version=1인 새 사양을 생성합니다. 제공된 경우 id 이 엔드포인트는 지정된 사양의 새 버전을 만듭니다.

    둘 다 externalId AND id 가 제공되는 경우 동일한 사양을 참조해야 합니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    internalVersion 서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    마지막 업데이트 사양이 마지막으로 업데이트된 날짜입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    이름 필수 사양의 이름입니다.

    데이터 유형: 문자열
    resourceSpecification 필수 이 서비스 사양의 자원 사양입니다.

    데이터 유형: 배열

    "resourceSpecification": [
   {
      "id": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id 필수 자원 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    resourceSpecification.internalVersion 자원 사양의 External_version입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    resourceSpecification.name 자원 사양의 이름입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    resourceSpecification.version 자원 사양의 버전입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    serviceSpecificationRelationship 이 사양과 다른 서비스 사양의 관계입니다.

    데이터 유형: 배열

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id 매개변수를 사용하는 경우 필수입니다 serviceSpecificationRelationship . 관련 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.internalVersion 관련 사양의 버전입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    serviceSpecificationRelationship.relationshipType 매개변수를 사용하는 경우 필수입니다 serviceSpecificationRelationship . 관계의 유형입니다.
    유효한 값은 다음과 같습니다.
    • composed_of
    • 번들

    데이터 유형: 문자열
    serviceSpecificationRelationship.validFor 관계가 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    serviceSpecificationRelationship.validFor.endDateTime 관계의 종료 날짜입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    serviceSpecificationRelationship.validFor.startDateTime 관계의 시작 날짜입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    serviceSpecificationRelationship.version 관련 사양의 External_version입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    spec특성 사양 특성.

    데이터 유형: 배열

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    specCharacteristic.characteristicValueSpecification 필수 특성의 가능한 값을 포함하는 배열입니다.

    데이터 유형: 배열

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    specCharacteristic.characteristicValueSpecification.value 필수 특성의 값입니다.

    데이터 유형: 문자열
    specCharacteristic.description 특성에 대한 설명입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    specCharacteristic.name 필수 특성의 이름입니다.

    데이터 유형: 문자열
    specCharacteristic.validFor 특성이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    specCharacteristic.validFor.endDateTime 특성의 종료 날짜입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    specCharacteristic.validFor.startDateTime 특성의 시작 날짜입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    specCharacteristic.valueType 필수 특성의 값 유형(예: 선택 또는 이메일)입니다.

    데이터 유형: 문자열
    validFor 필수 사양이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    validFor.endDateTime 사양의 종료 날짜입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    validFor.startDateTime 사양의 시작 날짜입니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    버전 서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    버전은 지정된 버전 체인에 대해 고유해야 합니다.

    데이터 유형: 문자열

    기본값: 빈 문자열
    @type 필수 사양의 유형입니다.
    유효한 값은 다음과 같습니다.
    • CustomerFacingServiceSpecification
    • ResourceFacingServiceSpecification

    데이터 유형: 문자열

    헤더

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

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    컨텐츠-형식 요청 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 17. 응답 헤더
    헤더 설명
    컨텐츠-형식 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

    상태 코드

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

    표 18. 상태 코드
    상태 코드 설명
    201 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
    • 페이로드가 비어 있습니다.
    • 잘못된 페이로드입니다. 필수 필드 누락: <필드 이름>

    응답 본문 매개변수(JSON)

    이름 설명
    설명 사양에 대한 설명입니다.

    데이터 유형: 문자열
    externalId 서비스 사양의 External_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    id 서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    internalId 서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    internalVersion 서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    마지막 업데이트 사양이 마지막으로 업데이트된 날짜입니다.

    데이터 유형: 문자열
    이름 사양의 이름입니다.

    데이터 유형: 문자열
    resourceSpecification 이 서비스 사양의 자원 사양입니다.

    데이터 유형: 배열

    "resourceSpecification": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id 자원 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    resourceSpecification.internalId 자원 사양의 Initial_version입니다.

    데이터 유형: 문자열
    resourceSpecification.internalVersion 자원 사양의 External_version입니다.

    데이터 유형: 문자열
    resourceSpecification.name 자원 사양의 이름입니다.

    데이터 유형: 문자열
    resourceSpecification.version 자원 사양의 버전입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship 이 사양과 다른 서비스 사양의 관계입니다.

    데이터 유형: 배열

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id 관련 사양의 Initial_version 또는 external_id입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.internalId 관련 사양의 Initial_version입니다.
    serviceSpecificationRelationship.internalVersion 관련 사양의 버전입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.relationshipType 관계의 유형입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.validFor 관계가 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    serviceSpecificationRelationship.validFor.endDateTime 관계의 종료 날짜입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.validFor.startDateTime 관계의 시작 날짜입니다.

    데이터 유형: 문자열
    serviceSpecificationRelationship.version 관련 사양의 External_version입니다.

    데이터 유형: 문자열
    spec특성 사양 특성.

    데이터 유형: 배열

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    specCharacteristic.characteristicValueSpecification 특성의 가능한 값을 포함하는 배열입니다.

    데이터 유형: 배열

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    specCharacteristic.characteristicValueSpecification.value 특성의 값입니다.

    데이터 유형: 문자열
    specCharacteristic.description 특성에 대한 설명입니다.

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

    데이터 유형: 문자열
    specCharacteristic.validFor 특성이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    specCharacteristic.validFor.endDateTime 특성의 종료 날짜입니다.

    데이터 유형: 문자열
    specCharacteristic.validFor.startDateTime 특성의 시작 날짜입니다.

    데이터 유형: 문자열
    specCharacteristic.valueType 특성의 값 유형(예: 선택 또는 이메일)입니다.

    데이터 유형: 문자열
    validFor 사양이 유효한 날짜 범위입니다.

    데이터 유형: 객체

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    validFor.endDateTime 사양의 종료 날짜입니다.

    데이터 유형: 문자열
    validFor.startDateTime 사양의 시작 날짜입니다.

    데이터 유형: 문자열
    버전 서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다.

    데이터 유형: 문자열
    @type 사양의 유형입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예에서는 방화벽 서비스에 대한 서비스 사양을 만듭니다.

    curl "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "7655",
   "name": "Firewall Service",
   "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.",
   "validFor": {
      "startDateTime": "2017-08-23T00:00",
      "endDateTime": "2021-03-25T00:00"
   },
   "lastUpdate": "2020-08-15T00:00",
   "resourceSpecification": [
      {
         "id": "af66e551c32f10105252716b7d40dd52",
         "name": "Firewall"
      }
   ],
   "specCharacteristic": [
      {
         "name": "Edge",
         "description": "This characteristic describes the operating system run by the service",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-08-12T00:00",
            "endDateTime": "2021-03-07T00:00"
         },
         "characteristicValueSpecification": [
            {
               "value": "Android KitKat"
            }
         ],
      }
   ],
   "serviceSpecRelationship": [
      {
         "relationshipType": "composed_of",
         "id": "65033023ebdb30107ee5302698522849",
         "validFor": {
            "startDateTime": "2017-08-25T00:00",
            "endDateTime": "2021-03-25T00:00"
         }
      }
   ],
   "@type": "ResourceFacingServiceSpecification"
}" \
--user 'username':'password'

    응답 본문입니다.

    {
   "id": "21a7ee64c32310105253716b8d40dd60",
   "name": "Firewall Service",
   "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.",
   "validFor": {
      "startDateTime": "2017-08-23T00:00",
      "endDateTime": "2021-03-25T00:00"
   },
   "lastUpdate": "2020-08-15T00:00",
   "resourceSpecification": [
      {
         "id": "af66e551c32f10105252716b7d40dd52",
         "name": "Firewall"
      }
   ],
   "specCharacteristic": [
      {
         "name": "Edge",
         "description": "This characteristic describes the operating system run by the service",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-08-12T00:00",
            "endDateTime": "2021-03-07T00:00"
         },
         "characteristicValueSpecification": [
            {
               "value": "Android KitKat"
            }
         ],
      }
   ],
   "serviceSpecRelationship": [
      {
         "relationshipType": "composed_of",
         "id": "65033023ebdb30107ee5302698522849",
         "validFor": {
            "startDateTime": "2017-08-25T00:00",
            "endDateTime": "2021-03-25T00:00"
         }
      }
   ],
   "@type": "ResourceFacingServiceSpecification"
}