Service Catalog Open API
Service Catalog Open API는 서비스 사양을 생성하고 검색할 수 있는 엔드포인트를 제공합니다.
이 API를 사용하여 외부 시스템과 ServiceNow AI Platform. Service Catalog Open API는 TM Forum Service Catalog API REST 사양의 구현입니다ServiceNow®. 이 구현은 TMF633 Service Catalog API REST 사양 버전 4(2020년 10월)를 기반으로 합니다.
이 API는 에서 사용할 수 ServiceNow Store있는 제품 카탈로그 고급 애플리케이션에 포함되어 있습니다.
sn_tmf-api 네임스페이스 내에 제공됩니다.- 서비스 범주 작성(POST) - 서비스 카탈로그 오픈 - POST /api/sn_tmf_api/catalogmanagement/serviceCategory
- 서비스 사양 작성(POST) - 서비스 카탈로그 열기 - POST /servicespecification
- 서비스 범주 삭제(삭제) - 서비스 카탈로그 오픈 - 삭제 /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
- 서비스 범주 가져오기(GET) - 서비스 카탈로그 오픈 - GET /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
- 서비스 사양 가져오기(GET) - 서비스 카탈로그 오픈 - GET /servicespecification/{specificationId}
- 서비스 사양 나열(GET) - 서비스 카탈로그 오픈 - GET /servicespecification
- 서비스 범주 업데이트(PATCH) - 서비스 카탈로그 오픈 - POST /api/sn_tmf_api/catalogmanagement/serviceCategory
호출 사용자에게 sn_prd_pm_adv.catalog_integrator 역할이 있어야 합니다.
- 특성 [sn_prd_pm_characteristic]
- 특성 옵션 [sn_prd_pm_characteristic_option]
- 서비스 사양 [sn_prd_pm_service_specification]
- 사양 관계 [sn_prd_pm_specification_relationship]
서비스 카탈로그 오픈 - 삭제 /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
사양 범주 [sn_prd_pm_specification_category] 테이블에서 지정된 서비스 범주 기록을 삭제합니다.
URL 형식
기본 URL: /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 삭제할 서비스 범주의 Sys_id입니다. 테이블: 서비스 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수용 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 머리글 | 설명 |
|---|---|
| 안 함 |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 204 | 컨텐츠가 없습니다. |
| 400 | 잘못된 요청. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 없음 |
cURL 요청
다음 예에서는 ID가 a1b23456c7de8a90f0123456gh789ij인 서비스 범주를 삭제합니다. 메시징과 함께 상태 코드를 반환합니다.
curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
--request DELETE \
--header "Accept:application/json" \
--user 'user:password'
서비스 카탈로그 오픈 - GET /api/sn_tmf_api/catalogmanagement/serviceCategory
서비스 범주 [sn_prd_pm_specification_category] 테이블에서 모든 서비스 범주 기록의 목록을 조회합니다.
URL 형식
기본 URL: /api/sn_tmf_api/catalogmanagement/serviceCategory
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드:
데이터 유형: 문자열 기본값: 모든 필드 반환 |
| ID | 특정 sys_id별로 서비스 범주를 필터링합니다. 테이블: 서비스 범주 [service_category] 데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 20 최대: 100 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 음수 값을 사용하지 마십시오. 데이터 유형: 숫자 기본값: 0 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수락:application/json |
| 머리글 | 설명 |
|---|---|
| 컨텐츠-범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위입니다. 예를 들어 offset=2 및 limit=3인 경우 Content-Range 헤더의 값은 항목 3-5입니다. |
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 링크 |
쿼리 결과를 탐색하는 다음 링크가 포함되어 있습니다.
|
| X-합계-카운트 | 페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 기록 수를 지정합니다. |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답에서 전체 자원이 반환되었습니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 외부 식별자 | 범주 관리와 관련된 외부 시스템의 식별 정보입니다. 데이터 유형: 객체 배열 |
| externalIdentifier.id | 서비스 범주의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블: 서비스 범주 [sn_prd_pm_specification_category], 필드 external_id |
| externalIdentifier.owner | 지정된 외부 ID를 소유하는 시스템입니다. 데이터 유형: 문자열 |
| href | 서비스 범주에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| ID | 서비스 범주의 Sys_id입니다. 테이블: 서비스 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| is루트 | 범주가 범주의 루트인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 모델 범주 | 서비스 범주와 연결된 모델 범주 목록입니다. 데이터 유형: 객체 배열 |
| modelCategory.id | 모델 범주의 Sys_id입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| modelCategory.name | 모델 범주의 이름입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| 이름 | 서비스 범주의 이름입니다. 데이터 유형: 문자열 |
| 서비스 후보 | 이 범주와 관련된 서비스 후보 참조 목록입니다. 데이터 유형: 객체 배열 |
| serviceCandidate.@referredType | 값은 항상 ServiceCategory입니다.데이터 유형: 문자열 |
| serviceCandidate.href | 서비스 사양에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| serviceCandidate.id | 서비스 사양의 Sys_id입니다. 테이블: 서비스 사양 [sn_prd_pm_service_specification] 데이터 유형: 문자열 |
| serviceCandidate.version | 서비스 후보의 버전입니다. 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 GET 작업을 호출하여 서비스 범주 [sn_prd_pm_specification_category] 테이블에 있는 모든 서비스 범주 기록의 목록을 반환합니다.
curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
--request GET \
--header "Accept:application/json" \
--user 'user:password'
``
응답 본문.
{
"id": "a1b23456c7de8a90f0123456gh789ij",
"href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a2a68216d9ce2a90f87718429ae503dd",
"name": "Cloud Services",
"serviceCandidate": [
{
"id": "14fbd5ead902ea90f87718429ae503f7",
"href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/14fbd5ead902ea90f87718429ae503f7",
"version": "1",
"name": "servicenow",
"@referredType": "ServiceCategory"
}
],
"modelCategory": [
{
"id": "a1d5bc14c3031000b959fd251eba8f5f",
"name": "Business Service"
}
],
"externalIdentifier": [
{
"id": "1234234312",
"owner": "TMF200000123233"
}
],
"isRoot": "true"
}
서비스 카탈로그 오픈 - GET /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
사양 범주 [sn_prd_pm_specification_category] 테이블에서 특정 서비스 범주 기록을 조회합니다.
URL 형식
기본 URL: /api/sn_tmf_api/catalogmanagement/serviceCategory
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 검색할 서비스 범주의 Sys_id입니다. 테이블: 사양 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드:
데이터 유형: 문자열 기본값: 모든 필드 반환 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 20 최대: 100 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 음수 값을 사용하지 마십시오. 데이터 유형: 숫자 기본값: 0 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수락:application/json |
| 머리글 | 설명 |
|---|---|
| 컨텐츠-범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위입니다. 예를 들어 offset=2 및 limit=3인 경우 Content-Range 헤더의 값은 항목 3-5입니다. |
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 링크 |
쿼리 결과를 탐색하는 다음 링크가 포함되어 있습니다.
|
| X-합계-카운트 | 페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 기록 수를 지정합니다. |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답에서 전체 자원이 반환되었습니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 외부 식별자 | 범주 관리와 관련된 외부 시스템의 식별 정보입니다. 데이터 유형: 객체 배열 |
| externalIdentifier.id | 서비스 범주의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블: 사양 범주 [sn_prd_pm_specification_category], 필드: external_id |
| externalIdentifier.owner | 이 ID를 소유하는 시스템입니다. 데이터 유형: 문자열 |
| href | 서비스 범주에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| ID | 서비스 범주의 Sys_id입니다. 테이블: 사양 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| is루트 | 범주가 범주의 루트인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형:부울 |
| 모델 범주 | 서비스 범주와 연결된 모델 범주 목록입니다. 데이터 유형: 객체 배열 |
| modelCategory.id | 모델 범주의 Sys_id입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| modelCategory.name | 모델 범주의 이름입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| 이름 | 서비스 범주의 이름입니다. 데이터 유형: 문자열 |
| 서비스 후보 | 이 범주와 연결된 서비스 후보 목록입니다. 데이터 유형: 객체 배열 |
| serviceCandidate.@referredType | 서비스 후보의 참조된 유형입니다. 값은 항상 ServiceCategory입니다.데이터 유형: 문자열 |
| serviceCandidate.href | 서비스 사양에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| serviceCandidate.id | 서비스 사양의 Sys_id입니다. 테이블: 서비스 사양 [sn_prd_pm_service_specification] 데이터 유형: 문자열 |
| serviceCandidate.version | 서비스 후보의 버전입니다. 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 GET 작업을 호출하여 지정된 ID a2a68216d9ce2a90f87718429ae503dd에 따라 특정 서비스 범주 레코드를 반환합니다.
curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
--request GET \
--header "Accept:application/json" \
--user 'user:password'
응답 본문.
{
"id": "a2a68216d9ce2a90f87718429ae503dd",
"href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a1b23456c7de8a90f0123456gh789ij",
"name": "Cloud Services",
"serviceCandidate": [
{
"id": "a1b23456c7de8a90f0123456gh789ij",
"href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/a1b23456c7de8a90f0123456gh789ij",
"version": "1",
"name": "servicenow",
서비스 카탈로그 오픈 - GET /servicespecification
모든 서비스 사양의 목록을 조회합니다.
URL 형식
기본 URL: /api/sn_prd_pm_adv/catalogmanagement/servicespecification
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 20 최대: 100 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 데이터 유형: 숫자 기본값: 0 |
| 상태 | 상태별로 서비스 사양을 필터링합니다. 이 매개변수의 값과 일치하는 상태가 있는 사양만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 안 함 |
| 머리글 | 설명 |
|---|---|
| 컨텐츠-범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위입니다. 예를 들어, |
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색하는 다음 링크가 포함되어 있습니다.
|
| X-합계-카운트 | 페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 기록 수를 지정합니다. |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답에서 전체 자원이 반환되었습니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| @type | 사양의 유형입니다. 데이터 유형: 문자열 |
| 설명 | 사양에 대한 설명입니다. 데이터 유형: 문자열 |
| externalId | 서비스 사양의 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_id 필드에 있습니다. |
| externalSystem | TMF633이 추가된 서비스 사양의 외부 시스템입니다. 예를 들어 외부 시스템이 ABC이면 값을 externalSystem 데이터 유형: 문자열 |
| externalSystem | 서비스 카탈로그와 상호작용하는 외부 공급업체 또는 네이티브가 아닌 플랫폼입니다. 값은 항상 TMF633으로 추가됩니다. 예를 들어 외부 시스템이 ABC 인 경우 외부 소스의 값은 ABC-TMF633이어야 합니다. 데이터 유형: 문자열 |
| ID | 서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 또는 external_id 필드에 있습니다. |
| internalId | 서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드 |
| 내부 버전 | 서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드 |
| 마지막 업데이트 | 사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 |
| 이름 | 사양의 이름입니다. 데이터 유형: 문자열 |
| 자원 사양 | 이 서비스 사양에 대한 자원 사양입니다. 데이터 유형: 객체 배열 |
| resourceSpecification.id | 자원 사양의 initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| resourceSpecification.internalId | 자원 사양의 initial_version입니다. 데이터 유형: 문자열 |
| resourceSpecification.internalVersion | 자원 사양의 external_version입니다. 데이터 유형: 문자열 |
| resourceSpecification.name | 자원 사양의 이름입니다. 데이터 유형: 문자열 |
| resourceSpecification.version | 자원 사양의 버전입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship | 이 사양과 다른 서비스 사양의 관계입니다. 데이터 유형: 객체 배열 |
| serviceSpecificationRelationship.id | 관련 사양의 initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.internalId | 관련 사양의 initial_version입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.internalVersion | 관련 사양의 버전입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.validFor | 관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| serviceSpecificationRelationship.validFor.endDateTime | 관계의 종료 날짜입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.validFor.startDateTime | 관계의 시작 날짜입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.version | 관련 사양의 external_version입니다. 데이터 유형: 문자열 |
| specCharacteristic | 사양 특성입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값 목록입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성의 값 유형(예: 선택 또는 이메일)입니다. 단순하거나 복잡한 특성일 수 있습니다. 가능한 값:
데이터 유형: 문자열 |
| 유효한대상 | 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 사양의 종료 날짜입니다. 데이터 유형: 문자열 |
| validFor.startDateTime | 사양의 시작 날짜입니다. 데이터 유형: 문자열 |
| 버전 | 서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드 |
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",
"externalSystem": "Salesforce - TMF633",
"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": ""
}
}
]
}
]
"externalSource": "ABC-TMF633"
},
{
"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": ""
}
}
]
"externalSource": "ABC-TMF633"
},
{
"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}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 사양 ID | 검색할 서비스 사양의 Sys_id입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열 |
| 상태 | 상태별로 서비스 사양을 필터링합니다. 이 매개변수의 값과 일치하는 상태가 있는 사양만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 없음 |
| 머리글 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. |
| 400 |
잘못된 요청입니다. 다음과 같은 이유 중 하나일 수 있습니다.
|
| 404 | 기록 없음 ID와 관련된 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| @type | 사양의 유형입니다. 데이터 유형: 문자열 |
| 설명 | 사양에 대한 설명입니다. 데이터 유형: 문자열 |
| externalId | 서비스 사양의 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_id 필드에 있습니다. |
| externalSystem | TMF633이 추가된 서비스 사양의 외부 시스템입니다. 예를 들어 외부 시스템이 ABC이면 값을 externalSystem 데이터 유형: 문자열 |
| externalSystem | 서비스 카탈로그와 상호작용하는 외부 공급업체 또는 네이티브가 아닌 플랫폼입니다. 값은 항상 TMF633으로 추가됩니다. 예를 들어 외부 시스템이 ABC 인 경우 외부 소스의 값은 ABC-TMF633이어야 합니다. 데이터 유형: 문자열 |
| ID | 서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 또는 external_id 필드에 있습니다. |
| internalId | 서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드 |
| 내부 버전 | 서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드 |
| 마지막 업데이트 | 사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 |
| 이름 | 사양의 이름입니다. 데이터 유형: 문자열 |
| 자원 사양 | 이 서비스 사양에 대한 자원 사양입니다. 데이터 유형: 객체 배열 |
| resourceSpecification.id | 자원 사양의 initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| resourceSpecification.internalId | 자원 사양의 initial_version입니다. 데이터 유형: 문자열 |
| resourceSpecification.internalVersion | 자원 사양의 external_version입니다. 데이터 유형: 문자열 |
| resourceSpecification.name | 자원 사양의 이름입니다. 데이터 유형: 문자열 |
| resourceSpecification.version | 자원 사양의 버전입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship | 이 사양과 다른 서비스 사양의 관계입니다. 데이터 유형: 객체 배열 |
| serviceSpecificationRelationship.id | 관련 사양의 initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.internalId | 관련 사양의 initial_version입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.internalVersion | 관련 사양의 버전입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.validFor | 관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| serviceSpecificationRelationship.validFor.endDateTime | 관계의 종료 날짜입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.validFor.startDateTime | 관계의 시작 날짜입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.version | 관련 사양의 external_version입니다. 데이터 유형: 문자열 |
| specCharacteristic | 사양 특성입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값 목록입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성의 값 유형(예: 선택 또는 이메일)입니다. 단순하거나 복잡한 특성일 수 있습니다. 가능한 값:
데이터 유형: 문자열 |
| 유효한대상 | 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 사양의 종료 날짜입니다. 데이터 유형: 문자열 |
| validFor.startDateTime | 사양의 시작 날짜입니다. 데이터 유형: 문자열 |
| 버전 | 서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드 |
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",
"externalSystem": "Salesforce - TMF633",
"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": []
}
],
"externalSource": "ABC-TMF633"
}
서비스 범주 오픈 - PATCH /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
사양 범주 [sn_prd_pm_specification_category] 테이블에서 지정된 기록을 업데이트합니다.
URL 형식
기본 URL: /api/sn_tmf_api/catalogmanagement/serviceCategory/ {id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 서비스 범주 테이블의 Sys_id입니다. 테이블: 사양 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 외부 식별자 | 범주 관리와 관련된 외부 시스템의 식별 정보입니다. 데이터 유형: 객체 배열 |
| externalIdentifier.id | 서비스 범주의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 테이블: 사양 범주 [sn_prd_pm_specification_category], 필드: external_id 데이터 유형: 문자열 |
| externalIdentifier.owner | 이 ID를 소유하는 시스템입니다. 데이터 유형: 문자열 |
| href | 서비스 범주에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| ID | 서비스 범주의 Sys_id입니다. 테이블: 사양 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| is루트 | 범주가 범주의 루트인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 모델 범주 | 서비스 범주와 연결된 모델 범주 목록입니다. 데이터 유형: 객체 배열 |
| modelCategory.id | 모델 범주의 Sys_id입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| modelCategory.name | 모델 범주의 이름입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| 이름 | 서비스 범주의 이름입니다. 데이터 유형: 문자열 |
| 서비스 후보 | 이 범주와 연결된 서비스 후보 목록입니다. 데이터 유형: 객체 배열 |
| serviceCandidate.@referredType | 값은 항상 ServiceCategory입니다.데이터 유형: 문자열 |
| serviceCandidate.href | 서비스 사양에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| serviceCandidate.id | 서비스 사양의 Sys_id입니다. 테이블: 서비스 사양 [sn_prd_pm_service_specification] 데이터 유형: 문자열 |
| serviceCandidate.version | 서비스 후보의 버전입니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 머리글 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수용 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 콘텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 머리글 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나 이상으로 인해 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
|
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 외부 식별자 | 범주 관리와 관련된 외부 시스템의 식별 정보입니다. 데이터 유형: 객체 배열 |
| externalIdentifier.id | 서비스 범주의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블: 사양 범주 [sn_prd_pm_specification_category], 필드: external_id |
| externalIdentifier.owner | 이 ID를 소유하는 시스템입니다. 데이터 유형: 문자열 |
| href | 서비스 범주에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| ID | 서비스 범주의 Sys_id입니다. 테이블: 사양 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| is루트 | 범주가 범주의 루트인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형:부울 |
| 모델 범주 | 서비스 범주와 연결된 모델 범주 목록입니다. 데이터 유형: 객체 배열 |
| modelCategory.id | 모델 범주의 Sys_id입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| modelCategory.name | 모델 범주의 이름입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| 이름 | 서비스 범주의 이름입니다. 데이터 유형: 문자열 |
| 서비스 후보 | 이 범주와 연결된 서비스 후보 목록입니다. 데이터 유형: 객체 배열 |
| serviceCandidate.@referredType | 값은 항상 ServiceCategory입니다.데이터 유형: 문자열 |
| serviceCandidate.href | 서비스 사양에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| serviceCandidate.id | 서비스 사양의 Sys_id입니다. 테이블: 서비스 사양 [sn_prd_pm_service_specification] 데이터 유형: 문자열 |
| serviceCandidate.version | 서비스 후보의 버전입니다. 데이터 유형: 문자열 |
cURL 요청
다음 예에서는 서비스 범주의 이름, 버전, 서비스 후보, 모델 범주 및 외부 식별자 정보를 업데이트합니다.
curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data '{
"name": "Cloud Services",
"version": "1.0",
"serviceCandidate": [
{
"id": "a1b23456c7de8a90f0123456gh789ij",
"href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
"version": "3.2",
"name": "Cloud Services",
"@referredType": "ServiceCategory"
}
],
"modelCategory": [
{
"id": "b2d5bc14c3031000b959fd251eba8f96",
"name": "model"
}
],
"externalIdentifier": {
"id": "1234234312",
"owner": "TMF200000123233"
},
"isRoot": true
}' \
--user 'user:password
응답 본문.
{
"name": "Cloud Services",
"version": "1.0",
"serviceCandidate": [
{
"id": "a1b23456c7de8a90f0123456gh789ij",
"href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
"version": "3.2",
"name": "Cloud Services",
"@referredType": "ServiceCategory"
}
],
"modelCategory": [
{
"id": "b2d5bc14c3031000b959fd251eba8f96",
"name": "model"
}
],
"externalIdentifier": {
"id": "1234234312",
"owner": "TMF200000123233"
},
"isRoot": true,
"id": "8138241b1caaaa10f87703c075c809fe",
"href": "api/sn_tmf_api/catalogmanagement/serviceCategory/8138241b1caaaa10f87703c075c809fe"
}
서비스 카탈로그 오픈 - POST /api/sn_tmf_api/catalogmanagement/serviceCategory
사양 범주 [sn_prd_pm_specification_category] 테이블에 새 서비스 범주 기록을 생성합니다.
URL 형식
기본 URL: /api/sn_tmf_api/catalogmanagement/serviceCategory
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 외부 식별자 | 범주 관리와 관련된 외부 시스템의 식별 정보입니다. 데이터 유형: 객체 배열 |
| externalIdentifier.id | 서비스 범주의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 테이블: 사양 범주 [sn_prd_pm_specification_category], 필드: external_id 데이터 유형: 문자열 |
| externalIdentifier.owner | 이 ID를 소유하는 시스템입니다. 데이터 유형: 문자열 |
| href | 서비스 범주에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| ID | 서비스 범주의 Sys_id입니다. 테이블: 사양 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| is루트 | 범주가 범주의 루트인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 모델 범주 | 서비스 범주와 연결된 모델 범주 목록입니다. 데이터 유형: 객체 배열 |
| modelCategory.id | 모델 범주의 Sys_id입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| modelCategory.name | 모델 범주의 이름입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| 이름 | 서비스 범주의 이름입니다. 데이터 유형: 문자열 |
| 서비스 후보 | 이 범주와 연결된 서비스 후보 목록입니다. 데이터 유형: 객체 배열 |
| serviceCandidate.@referredType | 값은 항상 ServiceCategory입니다.데이터 유형: 문자열 |
| serviceCandidate.href | 서비스 사양에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| serviceCandidate.id | 서비스 사양의 Sys_id입니다. 테이블: 서비스 사양 [sn_prd_pm_service_specification] 데이터 유형: 문자열 |
| serviceCandidate.version | 서비스 후보의 버전입니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수용 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 콘텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 머리글 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나 이상으로 인해 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
|
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 외부 식별자 | 범주 관리와 관련된 외부 시스템의 식별 정보입니다. 데이터 유형: 객체 배열 |
| externalIdentifier.id | 서비스 범주의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블: 사양 범주 [sn_prd_pm_specification_category], 필드: external_id |
| externalIdentifier.owner | 이 ID를 소유하는 시스템입니다. 데이터 유형: 문자열 |
| href | 서비스 범주에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| ID | 서비스 범주의 Sys_id입니다. 테이블: 사양 범주 [sn_prd_pm_specification_category] 데이터 유형: 문자열 |
| is루트 | 범주가 범주의 루트인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형:부울 |
| 모델 범주 | 서비스 범주와 연결된 모델 범주 목록입니다. 데이터 유형: 객체 배열 |
| modelCategory.id | 모델 범주의 Sys_id입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| modelCategory.name | 모델 범주의 이름입니다. 테이블: 모델 범주 [cmdb_model_category] 데이터 유형: 문자열 |
| 이름 | 서비스 범주의 이름입니다. 데이터 유형: 문자열 |
| 서비스 후보 | 이 범주와 연결된 서비스 후보 목록입니다. 데이터 유형: 객체 배열 |
| serviceCandidate.@referredType | 값은 항상 ServiceCategory입니다.데이터 유형: 문자열 |
| serviceCandidate.href | 서비스 사양에 액세스하는 하이퍼링크입니다. 데이터 유형: 문자열 |
| serviceCandidate.id | 서비스 사양의 Sys_id입니다. 테이블: 서비스 사양 [sn_prd_pm_service_specification] 데이터 유형: 문자열 |
| serviceCandidate.version | 서비스 후보의 버전입니다. 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 POST를 호출하여 요청 본문에 제공된 상세 정보에 따라 새 서비스 범주 기록을 만듭니다.
curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'user:password' \
--data '{
"name": "Cloud Services",
"version": "1.0",
"serviceCandidate": [
{
"id": "a1b23456c7de8a90f0123456gh789ij",
"href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
"version": "3.2",
"name": "Cloud Services",
"@referredType": "ServiceCategory"
}
],
"modelCategory": [
{
"id": "b2d5bc14c3031000b959fd251eba8f96",
"name": "model"
}
],
"externalIdentifier": {
"id": "1234234312",
"owner": "TMF200000123233"
},
"isRoot": true
}'
응답 본문.
{
"name": "Cloud Services",
"version": "1.0",
"serviceCandidate": [
{
"id": "a1b23456c7de8a90f0123456gh789ij",
"href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
"version": "3.2",
"name": "Cloud Services",
"@referredType": "ServiceCategory"
}
],
"modelCategory": [
{
"id": "b2d5bc14c3031000b959fd251eba8f96",
"name": "model"
}
],
"externalIdentifier": {
"id": "1234234312",
"owner": "TMF200000123233"
},
"isRoot": true,
"id": "8138241b1caaaa10f87703c075c809fe",
"href": "api/sn_tmf_api/service_catalog_api/serviceCategory/8138241b1caaaa10f87703c075c809fe"
}
서비스 카탈로그 열기 - POST /servicespecification
서비스 사양을 작성합니다.
URL 형식
기본 URL: /api/sn_prd_pm_adv/catalogmanagement/servicespecification
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 설명 | 필수 사양에 대한 설명입니다. 데이터 유형: 문자열 |
| externalId | 서비스 사양의 외부 ID입니다. 와 둘 id 다 externalId 제공되는 경우 동일한 사양을 참조해야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] |
| externalSystem | 서비스 카탈로그와 상호작용하는 외부 공급업체 또는 네이티브가 아닌 플랫폼입니다. 값은 항상 TMF633으로 추가됩니다.예를 들어 외부 시스템이 데이터 유형: 문자열 |
| ID | 서비스 사양의 initial_version 또는 external_id입니다. 제공되지 않은 경우 id 이 엔드포인트는 version=1의 새 사양을 생성합니다. 제공된 경우 id 이 엔드포인트는 지정된 사양의 새 버전을 생성합니다. 와 둘 id 다 externalId 제공되는 경우 동일한 사양을 참조해야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 내부 버전 | 서비스 사양의 버전입니다. 데이터 유형: 문자열 기본값: 빈 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] |
| 마지막 업데이트 | 사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 이름 | 필수 사양의 이름입니다. 데이터 유형: 문자열 |
| 자원 사양 | 필수 이 서비스 사양에 대한 자원 사양입니다. 데이터 유형: 객체 배열 |
| resourceSpecification.id | 필수 자원 사양의 initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| resourceSpecification.internalVersion | 자원 사양의 external_version입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| resourceSpecification.name | 자원 사양의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| resourceSpecification.version | 자원 사양의 버전입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| serviceSpecificationRelationship | 다른 서비스 사양에 대한 사양의 관계에 대한 상세 정보입니다. 데이터 유형: 객체 배열 |
| serviceSpecificationRelationship.id | 매개변수를 사용하는 경우 필수입니다 serviceSpecificationRelationship . 관련 사양의 Initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.internalVersion | 관련 사양의 버전입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| serviceSpecificationRelationship.relationshipType | 매개변수를 사용하는 경우 필수입니다 serviceSpecificationRelationship . 관계의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| serviceSpecificationRelationship.validFor | 관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| serviceSpecificationRelationship.validFor.endDateTime | 관계의 종료 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| serviceSpecificationRelationship.validFor.startDateTime | 관계의 시작 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| serviceSpecificationRelationship.version | 관련 사양의 external_version입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| specCharacteristic | 사양 특성입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification | 필수 특성의 가능한 값입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 필수 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| specCharacteristic.name | 필수 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| specCharacteristic.valueType | 특성의 값 유형(예: 선택 또는 이메일)입니다. 단순하거나 복잡한 특성일 수 있습니다. 가능한 값:
데이터 유형: 문자열 |
| 유효한대상 | 필수 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 사양의 종료 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| validFor.startDateTime | 사양의 시작 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 버전 | 서비스 사양의 외부 버전입니다. 버전은 지정된 버전 체인에 대해 고유해야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드 |
| @type | 필수 사양의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 콘텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 머리글 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 201 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음과 같은 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| @type | 사양의 유형입니다. 데이터 유형: 문자열 |
| 설명 | 사양에 대한 설명입니다. 데이터 유형: 문자열 |
| externalId | 서비스 사양의 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_id 필드에 있습니다. |
| externalSystem | TMF633이 추가된 서비스 사양의 외부 시스템입니다. 예를 들어 외부 시스템이 ABC이면 값을 externalSystem 데이터 유형: 문자열 |
| externalSystem | 서비스 카탈로그와 상호작용하는 외부 공급업체 또는 네이티브가 아닌 플랫폼입니다. 값은 항상 TMF633으로 추가됩니다. 예를 들어 외부 시스템이 ABC 인 경우 외부 소스의 값은 ABC-TMF633이어야 합니다. 데이터 유형: 문자열 |
| ID | 서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 또는 external_id 필드에 있습니다. |
| internalId | 서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드 |
| 내부 버전 | 서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드 |
| 마지막 업데이트 | 사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 |
| 이름 | 사양의 이름입니다. 데이터 유형: 문자열 |
| 자원 사양 | 이 서비스 사양에 대한 자원 사양입니다. 데이터 유형: 객체 배열 |
| resourceSpecification.id | 자원 사양의 initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| resourceSpecification.internalId | 자원 사양의 initial_version입니다. 데이터 유형: 문자열 |
| resourceSpecification.internalVersion | 자원 사양의 external_version입니다. 데이터 유형: 문자열 |
| resourceSpecification.name | 자원 사양의 이름입니다. 데이터 유형: 문자열 |
| resourceSpecification.version | 자원 사양의 버전입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship | 이 사양과 다른 서비스 사양의 관계입니다. 데이터 유형: 객체 배열 |
| serviceSpecificationRelationship.id | 관련 사양의 initial_version 또는 external_id입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.internalId | 관련 사양의 initial_version입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.internalVersion | 관련 사양의 버전입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.validFor | 관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| serviceSpecificationRelationship.validFor.endDateTime | 관계의 종료 날짜입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.validFor.startDateTime | 관계의 시작 날짜입니다. 데이터 유형: 문자열 |
| serviceSpecificationRelationship.version | 관련 사양의 external_version입니다. 데이터 유형: 문자열 |
| specCharacteristic | 사양 특성입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값 목록입니다. 데이터 유형: 객체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성의 값 유형(예: 선택 또는 이메일)입니다. 단순하거나 복잡한 특성일 수 있습니다. 가능한 값:
데이터 유형: 문자열 |
| 유효한대상 | 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 사양의 종료 날짜입니다. 데이터 유형: 문자열 |
| validFor.startDateTime | 사양의 시작 날짜입니다. 데이터 유형: 문자열 |
| 버전 | 서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드 |
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\",
\"externalSource\": \"ABC-TMF633\",
\"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",
"externalSource": "ABC-TMF633",
"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"
}