서비스 테스트 관리 개방형 API
Service Test Management Open API는 서비스 테스트 정의 및 서비스 테스트를 작성하고 검색하기 위한 엔드포인트를 제공합니다.
이 API를 사용하여 외부 시스템과 .Now Platform Service Test Management Open API는 TM Forum Service Problem Management API REST 스펙의 구현입니다ServiceNow. 이 구현은 https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/ 를 기반으로 합니다.
이 REST API는 통신 환경 내에서 서비스 테스트를 관리하고 실행하도록 설계되었습니다. 이를 통해 사용자는 서비스 테스트를 정의, 트리거 및 모니터링하여 서비스가 품질 및 성능 표준을 충족하도록 보장할 수 있습니다. API는 테스트 정의 생성 및 업데이트, 테스트 실행, 테스트 결과 검색, 테스트 일정 관리 등의 테스트 관리 기능을 제공합니다.
서비스 테스트 관리 Open API에는 고객 서비스 문제 관리(com.sn_sprb_mgmt) 플러그인과 sn_sprb_mgmt.test_integrator 역할이 필요합니다. 이 API는 sn_sprb_mgmt 네임스페이스에 속합니다. 서비스 문제 관리에 대한 자세한 내용은 다음을 참조하십시오. 이 응용 프로그램에 대한 자세한 내용은 을 참조하십시오 Customer Service Problem Management .
- 테스트 실행 [sn_st_mgmt_test]
- 서비스 테스트 정의 [sn_st_mgmt_test_definition]
- 테스트 정의 특성 [sn_st_mgmt_test_definition_characteristic]
- 테스트 특성 [sn_st_mgmt_test_characteristic]
- 사양과 테스트 정의의 관계 [sn_st_mgmt_test_definition_m2m]
- 테스트 정의 관계 [sn_st_mgmt_test_definition_rel]
- 테스트 측정 [sn_st_mgmt_test_measure]
- 측정 결과 [sn_st_mgmt_measure_consequence]
- 테스트 측정 정의 [sn_st_mgmt_test_measure_definition]
- 적용된 결과 [sn_st_mgmt_applied_consequence]
- 임계치 규칙 [sn_st_mgmt_threshold_rule]
- 임계치 규칙 위반 [sn_st_mgmt_threshold_rule_violation]
서비스 테스트 관리 개방형 API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest
모든 서비스 테스트의 목록을 조회합니다.
URL 형식
기본 URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 유효한 필드:
데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 최대값: 100 기본값: 20 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 매개변수를 사용하여 결과를 작고 관리 가능한 청크로 페이지 매김합니다. 첫 번째 레코드는 0에서 인덱싱됩니다. 데이터 유형: 숫자 기본값: 0 |
| state | 테스트의 현재 상태를 기준으로 테스트 정의를 필터링합니다. 지정된 상태의 테스트 정의만 응답에 반환됩니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 |
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
|
| X-Total-Count | 페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 이름 | 설명 |
|---|---|
| 특성 | 관련 서비스 테스트의 특징을 설명하는 목록입니다. 테스트 정의 특성에 대한 자세한 내용은 데이터 형식: 개체 배열 |
| characteristic.id | 특성의 Sys_id 또는 external_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 해당 레코드에 대한 external_id 있으면 응답은 external_id 반환 없으면 sys_id 반환합니다. 데이터 유형: 문자열 |
| characteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| 특성.값 | 서비스 테스트와 관련된 특성 옵션입니다. 특성은 고객 인스턴스에 따라 다릅니다. 데이터 유형: 문자열 |
| characteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| 설명 | 서비스 테스트에 대한 설명입니다. 데이터 유형: 문자열 |
| 종료 날짜 시간 | 서비스 테스트의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| href | 서비스 테스트에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 모드 | 서비스 테스트가 실행 중인 모드입니다. 유효한 값은 다음과 같습니다.
기본값: ONDEMAND |
| 이름 | 필수 서비스 테스트의 이름입니다. 데이터 유형: 문자열 |
| 관련서비스 | 필수 서비스 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| relatedService.id | 제품 인벤토리의 Sys_id 또는 external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedService.name | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| startDateTime | 서비스 테스트의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| 상태 | 서비스 테스트의 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 테스트 측정 | 제품, 서비스 또는 자원 테스트의 특정 측면(예: 패킷 손실 또는 연결 상태)을 측정합니다. 데이터 형식: 객체 배열 |
| 테스트 측정.정확도 | 관련 메트릭에 대해 캡처된 테스트 측정 정확도를 나타내는 부동 소수점 값입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.captureDateTime | 메트릭이 캡처된 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasure.id | 테스트 측정값의 Sys_id 또는 external_id입니다. 테스트 측정 테이블 [sn_st_mgmt_test_measure] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| testMeasure.Measure.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.메트릭 이름 | 테스트 측정 메트릭의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation | 규칙이 위반될 경우의 결과와 함께 임계치 규칙 정의의 규칙을 정의하기 위한 객체입니다. 데이터 형식: 개체 배열 |
| testMeasure.ruleViolation.tolerancePeriod.amount | 결과를 적용하기 전의 기간 수입니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.appliedConsequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 개체 배열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | 임계치 규칙이 위반될 때 수행할 작업입니다. 예를 들어, 경고를 보내거나 보고서를 생성합니다. 적용된 작업은 인스턴스마다 다를 수 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.description | 적용된 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.id | 적용된 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.name | 적용된 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.repeatAction | 두 번째 위반이 발생할 때 결과를 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComporatorExact | 값이 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComporatorLower | 값이 임계치 아래로 떨어지는지 확인하기 위한 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComporatorUpper | 값이 임계치 이상인지 확인하기 위한 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.id | 임계치 규칙 위반의 Sys_id 또는 external_id입니다. 임계치 규칙 위반 테이블 [sn_st_mgmt_threshold_rule_violation] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.tolerancePeriod | 즉각적인 결과나 작업을 트리거하지 않고 교차 발생을 활성화하는 지정된 시간 간격입니다. 날짜 유형: 개체 |
| testMeasure.ruleViolation.tolerancePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasure.unitOfMeasure | 테스트 측정의 적합성 대상 값에 대한 측정 단위를 지정합니다. 데이터 유형: 문자열 |
| testMeasure.value (테스트 측정.값) | 테스트 측정값입니다. 데이터 유형: 객체 |
| testMeasure.value.id | 테스트 측정값의 ID입니다. 데이터 유형: 문자열 |
| testMeasure.value.name | 테스트 측정값의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.value.value | 테스트 측정값입니다. 데이터 유형: 문자열 |
| testMeasure.value.valueType | 숫자, 텍스트 등과 같은 테스트 측정 값의 유형입니다. 데이터 유형: 문자열 |
| 테스트 사양 | 필수 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| testSpecification.href | 서비스 테스트 정의에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| testSpecification.id | 서비스 테스트 정의의 sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| validFor | 서비스 테스트가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 서비스 테스트의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 서비스 테스트의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 인스턴스의 두 서비스 테스트에 대한 정보를 검색합니다.
curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest” \
--user 'username’: ‘password'
응답 본문입니다.
[
{
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/09d1f42e3be28210d140068aa4e45ae2",
"id": "09d1f42e3be28210d140068aa4e45ae2",
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
"id": "7d3854864316c6500e51203d5fb8f2d8"
},
"characteristic": [],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
},
{
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/18682a2a3b2682107222bf9985e45a55",
"id": "18682a2a3b2682107222bf9985e45a55",
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001012",
"startDateTime": "2024-06-05 17:45:07",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
"id": "7d3854864316c6500e51203d5fb8f2d8"
},
"characteristic": [
{
"id": "5c682a2a3b2682107222bf9985e45a5a",
"name": "url",
"valueType": "single_line_text",
"value": "http://abc.com"
}
],
"testMeasure": [
{
"id": "7c686a2a3b2682107222bf9985e45a4d",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "38686a2a3b2682107222bf9985e45a4e",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "34686a2a3b2682107222bf9985e45a50",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
]
서비스 테스트 관리 개방형 API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
서비스 테스트의 지정된 ID를 기반으로 서비스 테스트 엔터티를 검색합니다.
URL 형식
기본 URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| id | 필수 검색할 서비스 테스트의 Sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 유효한 필드:
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 특성 | 관련 서비스 테스트의 특징을 설명하는 목록입니다. 데이터 형식: 개체 배열 |
| characteristic.id | 특성의 Sys_id 또는 external_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 해당 레코드에 대한 external_id 있으면 응답은 external_id 반환 없으면 sys_id 반환합니다. 데이터 유형: 문자열 |
| characteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| 특성.값 | 서비스 테스트와 관련된 특성 옵션입니다. 특성은 고객 인스턴스에 따라 다릅니다. 데이터 유형: 문자열 |
| characteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| 설명 | 서비스 테스트에 대한 설명입니다. 데이터 유형: 문자열 |
| 종료 날짜 시간 | 서비스 테스트의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| href | 서비스 테스트에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 모드 | 서비스 테스트가 실행되는 모드입니다. 유효한 값은 다음과 같습니다.
기본값: ONDEMAND |
| 이름 | 서비스 테스트의 이름입니다. 데이터 유형: 문자열 |
| 관련서비스 | 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| relatedService.id | 제품 인벤토리의 sys_id 또는 external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedService.name | 제품 인벤토리 항목의 이름입니다. 데이터 유형: 문자열 |
| startDateTime | 서비스 테스트의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| 상태 | 서비스 테스트의 상태입니다. 유효한 값은 다음과 같습니다.
|
| 테스트 측정 | 제품, 서비스 또는 자원 테스트의 특정 측면(예: 패킷 손실 또는 연결 상태)을 측정합니다. 데이터 형식: 개체 배열 |
| 테스트 측정.정확도 | 관련 메트릭에 대해 캡처된 테스트 측정 정확도를 나타내는 부동 소수점 값입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.captureDateTime | 메트릭이 캡처된 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasure.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.id | 테스트 측정값의 Sys_id 또는 external_id입니다. 테스트 측정 테이블 [sn_st_mgmt_test_measure] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.메트릭 이름 | 테스트 측정값의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation | 규칙이 위반될 경우의 결과와 함께 임계치 규칙 정의의 규칙을 정의하기 위한 객체입니다. 데이터 형식: 객체 배열 |
| testMeasure.ruleViolation.appliedConsequence | 임계치 규칙이 위반될 때 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 객체 배열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | 임계치 규칙이 위반될 때 수행할 작업입니다. 예를 들어, 경고를 보내거나 보고서를 생성합니다. 적용된 작업은 인스턴스마다 다를 수 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction | 적용된 작업을 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.appliedConsequence.description | 적용된 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.id | 적용된 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.name | 적용된 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComparatorExact | 값이 의 값 conformanceTargetExact과 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComparatorUpper | 값이 임계치를 초과하는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.description | 임계치 규칙 위반에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.id | 임계치 규칙 위반의 Sys_id 또는 external_id입니다. 임계치 규칙 위반 테이블 [sn_st_mgmt_threshold_rule_violation] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.name | 임계치 규칙 위반의 이름입니다. 날짜 유형: 문자열 |
| testMeasure.ruleViolation.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.tolerancePeriod | 결과가 시작되기 전에 허용된 교차가 발생할 수 있는 기간 또는 시간 간격입니다. 날짜 유형: 개체 |
| testMeasure.ruleViolation.tolerancePeriod.amount | 숫자로 나타내는 기간의 양입니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.tolerancePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasure.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasure.value (테스트 측정.값) | 테스트의 메트릭 값입니다. 데이터 유형: 객체 |
| testMeasure.value.id | 테스트의 메트릭 값 ID입니다. 데이터 유형: 문자열 |
| testMeasure.value.name | 테스트의 메트릭 값 이름입니다. 데이터 유형: 문자열 |
| testMeasure.value.value | 테스트의 메트릭 값입니다. 데이터 유형: 문자열 |
| testMeasure.value.valueType | 숫자, 텍스트 등과 같은 테스트 측정 값의 유형입니다. 데이터 유형: 문자열 |
| 테스트 사양 | 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| testSpecification.href | 서비스 테스트 정의에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| testSpecification.id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| validFor | 서비스 테스트가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 서비스 테스트의 종료 날짜 및 타임스탬프입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 서비스 테스트의 시작 날짜 및 타임스탬프입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 지정된 ID 44b7a8ea3b6a42107222bf9985e45a45와 연결된 서비스 테스트 엔터티에 대한 세부 정보를 검색합니다.
curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45 \
--user 'username’: ‘password'
응답 본문입니다.
{
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45",
"id": "44b7a8ea3b6a42107222bf9985e45a45",
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001001",
"startDateTime": "2024-06-05 08:22:52",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
"id": "7d3854864316c6500e51203d5fb8f2d8"
},
"characteristic": [
{
"id": "5c682a2a3b2682107222bf9985e45a5a",
"name": "url",
"valueType": "single_line_text",
"value": "test"
}
],
"testMeasure": [
{
"id": "62ade42a3ba28210d140068aa4e45a71",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Downstream Speed",
"unitOfMeasure": "",
"value": "16",
"ruleViolation": [
{
"id": "b9bee4ae3ba28210d140068aa4e45a3a",
"description": "This speed is less than the target upper",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetUpper": "75",
"conformanceComparatorUpper": "less than",
"appliedConsequence": [
{
"id": "489074aa3be28210d140068aa4e45a42",
"appliedAction": "generateReport",
"description": "",
"name": "generateReport",
"repeatAction": "0"
},
{
"id": "785f2ce23be28210d140068aa4e45a75",
"appliedAction": "sendWarning",
"description": "",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
서비스 테스트 관리 Open API - GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
모든 서비스 테스트 정의의 목록을 조회합니다.
URL 형식
기본 URL: GET /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블에 있습니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 최대값: 100 기본값: 20 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 매개변수를 사용하여 결과를 작고 관리 가능한 청크로 페이지 매김합니다. 첫 번째 레코드는 0에서 인덱싱됩니다. 데이터 유형: 숫자 기본값: 0 |
| state | 테스트의 현재 상태를 기준으로 테스트 정의를 필터링합니다. 지정된 상태의 테스트 정의만 응답에 반환됩니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 offset=2 및 limit=3인 경우 Content-Range 헤더의 값은 항목 3-5입니다. |
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
|
| X-Total-Count | 페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 설명 | 서비스 테스트 정의에 대한 설명입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 필수 서비스 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| relatedServiceSpecification | 필수 테스트 정의의 서비스 사양입니다. 데이터 형식: 객체 배열 |
| relatedServiceSpecification.id | 서비스 사양의 Sys_id 또는 external_id입니다. 사양 [sn_prd_pm_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedServiceSpecification.name | 서비스 사양의 이름입니다. 데이터 유형: 문자열 |
| **serviceTestSpecRelationship** | 관련 서비스 테스트 정의입니다. 데이터 형식: 개체 배열 |
| serviceTestSpecRelationship.id | 관련 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 테스트 정의 [sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.name | 관련 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.relationshipType | 관계의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| spec특성 | 테스트 정의의 특성입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| testMeasureDefinition (테스트 측정 정의) | 이 서비스 테스트 정의에 대한 테스트 측정 정의입니다. 자세한 내용은 Define test measure definitions for a service test 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.captureFrequency | 메트릭을 캡처하는 빈도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.capturePeriod | 메트릭 캡처 기간 또는 기간입니다. 데이터 유형: 객체 |
| testMeasureDefinition.capturePeriod.amount | 캡처 기간 수입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.capturePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasureDefinition.id | 테스트 측정 정의의 Sys_id 또는 external_id입니다. 테스트 측정 정의 테이블 [sn_st_mgmt_test_measure_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricName | 테스트 측정값의 사용자 정의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.name | 테스트 측정 정의의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule | 테스트 측정 정의에서 임계치가 초과되거나 초과되지 않을 때 결과를 적용하기 전에 달성할 조건을 정의하는 규칙입니다. 자세한 내용은 Define threshold rules for a test measure definition 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | 값이 에 대해 설정된 testMeasureDefinition.thresholdRule.conformanceTargetExact값과 동일한지 여부를 나타내는 플래그입니다. true testMeasureDefinition.thresholdRule.conformanceTargetExact 로 설정하면 필수입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 값이 임계치를 초과하는지 여부를 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.consequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 자세한 내용은 Define measure consequences for the threshold rules 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.consequence.description | 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.id | 측정 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.name | 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | 임계치 위반에 대해 수행할 사용자 정의 작업입니다. 작업은 인스턴스마다 다릅니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | 적용된 결과를 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | 결과가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | 결과의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | 결과의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.id | 임계치 규칙의 Sys_id 또는 external_id입니다. 임계치 규칙 [sn_st_mgmt_threshold_rule] 테이블의 sys_id 또는 external_id에 위치 필드에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 최대값: 40 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | 임계치 규칙의 심각도 수준입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor | 테스트 측정 정의가 유효한 날짜 범위입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.endDateTime | 테스트 측정 정의의 유효성 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.startDateTime | 테스트 측정 정의의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor | 테스트 정의가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 상태가 폐기되는 테스트 정의의 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 상태가 게시된 테스트 정의의 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
이 예제에서는 인스턴스의 모든 테스트 서비스 테스트 정의에 대한 상세 정보를 검색합니다. 이 경우 두 개의 정의가 반환됩니다.
curl --location --request GET
“https://instance.servicenow.com//api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification” \
--user 'username’: ‘password'
응답 본문입니다.
[
{
"description": "Operation, Administration and Maintenance",
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"testMeasureDefinition": [
{
"id": "77b9b964432a02104fefe4511fb8f26e",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the Rx signal level",
"metricName": "Rx Optical Signal Level",
"name": "Rx Optical Signal Level",
"unitOfMeasure": "a minute",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": [
{
"id": "d3e97d64432a02104fefe4511fb8f281",
"description": "",
"name": "gponOntAniOpInfoRxOpticalSignalLevel",
"numberOfAllowedCrossing": "",
"thresholdRuleSeverity": "",
"tolerancePeriod": "",
"conformanceTargetUpper": "0",
"conformanceComparatorUpper": "less than",
"conformanceTargetLower": "-50",
"conformanceComparatorLower": "greater than",
"consequence": []
}
]
},
{
"id": "878afd64432a02104fefe4511fb8f28d",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the Tx signal level",
"metricName": "TX Optical Signal Level",
"name": "TX Optical Signal Level",
"unitOfMeasure": "a minute",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": [
{
"id": "b3dab5a4432a02104fefe4511fb8f2d3",
"description": "",
"name": "gponOntAniOpInfoTxOpticalSignalLevel",
"numberOfAllowedCrossing": "",
"thresholdRuleSeverity": "",
"tolerancePeriod": "",
"conformanceTargetUpper": "65",
"conformanceComparatorUpper": "less than",
"conformanceTargetLower": "-65",
"conformanceComparatorLower": "greater than",
"consequence": []
}
]
}
],
"specCharacteristic": [
{
"name": "AccessRequired",
"description": "AccessRequired",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 09:09:57"
},
"characteristicValueSpecification": [
{
"value": "Yes",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
},
{
"value": "No",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
}
]
}
],
"serviceTestSpecRelationship": [],
"relatedServiceSpecification": [
{
"id": "f559b564432a02104fefe4511fb8f2e0",
"name": "OAM"
}
]
},
{
"description": "Upstream and Downstream speed ",
"id": "89d2b920432a02104fefe4511fb8f22e",
"name": "Speed Test",
"validFor": {
"startDateTime": "2024-05-31",
"endDateTime": "2024-06-27"
},
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
},
"characteristicValueSpecification": [
{
"value": "No",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
}
]
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
]
서비스 테스트 관리 Open API - GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
서비스 테스트 정의 엔터티를 조회합니다.
URL 형식
기본 URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| id | 필수 검색할 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블에 있습니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| state | 테스트의 현재 상태를 기준으로 테스트 정의를 필터링합니다. 지정된 상태의 테스트 정의만 응답에 반환됩니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 설명 | 서비스 테스트 정의에 대한 설명입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 필수 서비스 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| relatedServiceSpecification | 필수 테스트 정의의 서비스 사양입니다. 데이터 형식: 객체 배열 |
| relatedServiceSpecification.id | 서비스 사양의 Sys_id 또는 external_id입니다. 사양 [sn_prd_pm_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedServiceSpecification.name | 서비스 사양의 이름입니다. 데이터 유형: 문자열 |
| **serviceTestSpecRelationship** | 관련 서비스 테스트 정의입니다. 데이터 형식: 개체 배열 |
| serviceTestSpecRelationship.id | 관련 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 테스트 정의 [sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.name | 관련 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.relationshipType | 관계의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| spec특성 | 테스트 정의의 특성입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| testMeasureDefinition (테스트 측정 정의) | 이 서비스 테스트 정의에 대한 테스트 측정 정의입니다. 자세한 내용은 Define test measure definitions for a service test 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.captureFrequency | 메트릭을 캡처하는 빈도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.capturePeriod | 메트릭 캡처 기간 또는 기간입니다. 데이터 유형: 객체 |
| testMeasureDefinition.capturePeriod.amount | 캡처 기간 수입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.capturePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasureDefinition.id | 테스트 측정 정의의 Sys_id 또는 external_id입니다. 테스트 측정 정의 테이블 [sn_st_mgmt_test_measure_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricName | 테스트 측정값의 사용자 정의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.name | 테스트 측정 정의의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule | 테스트 측정 정의에서 임계치가 초과되거나 초과되지 않을 때 결과를 적용하기 전에 달성할 조건을 정의하는 규칙입니다. 자세한 내용은 Define threshold rules for a test measure definition 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | 값이 에 대해 설정된 testMeasureDefinition.thresholdRule.conformanceTargetExact값과 동일한지 여부를 나타내는 플래그입니다. true testMeasureDefinition.thresholdRule.conformanceTargetExact 로 설정하면 필수입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 값이 임계치를 초과하는지 여부를 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.consequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 자세한 내용은 Define measure consequences for the threshold rules 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.consequence.description | 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.id | 측정 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.name | 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | 임계치 위반에 대해 수행할 사용자 정의 작업입니다. 작업은 인스턴스마다 다릅니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | 적용된 결과를 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | 결과가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | 결과의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | 결과의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.id | 임계치 규칙의 Sys_id 또는 external_id입니다. 임계치 규칙 [sn_st_mgmt_threshold_rule] 테이블의 sys_id 또는 external_id에 위치 필드에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 최대값: 40 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | 임계치 규칙의 심각도 수준입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor | 테스트 측정 정의가 유효한 날짜 범위입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.endDateTime | 테스트 측정 정의의 유효성 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.startDateTime | 테스트 측정 정의의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor | 테스트 정의가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 상태가 폐기되는 테스트 정의의 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 상태가 게시된 테스트 정의의 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
이 예제에서는 지정된 ID를 사용하여 서비스 테스트 정의의 상세 정보를 검색합니다.
curl --location --request GET "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e" \
--user 'username’: ‘password'
응답 본문입니다.
{
"description": "Upstream and Downstream speed ",
"id": "89d2b920432a02104fefe4511fb8f22e",
"name": "Speed Test",
"validFor": {
"startDateTime": "2024-05-31",
"endDateTime": "2024-06-27"
},
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
},
"characteristicValueSpecification": [
{
"value": "No",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
}
]
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
서비스 테스트 관리 Open API - PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
서비스 테스트 엔터티를 업데이트합니다.
URL 형식
기본 URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| id | 필수 검색할 서비스 테스트의 Sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 특성 | 관련 서비스 테스트의 특징을 설명하는 목록입니다. 테스트 정의 특성에 대한 자세한 내용은 데이터 형식: 개체 배열 |
| characteristic.id | 특성의 Sys_id 또는 external_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 해당 레코드에 대한 external_id 있으면 응답은 external_id 반환 없으면 sys_id 반환합니다. 데이터 유형: 문자열 |
| characteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| 특성.값 | 서비스 테스트와 관련된 특성 옵션입니다. 특성은 고객 인스턴스에 따라 다릅니다. 데이터 유형: 문자열 |
| characteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| 설명 | 서비스 테스트에 대한 설명입니다. 데이터 유형: 문자열 |
| 종료 날짜 시간 | 서비스 테스트의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| 모드 | 서비스 테스트가 실행 중인 모드입니다. 유효한 값은 다음과 같습니다.
기본값: ONDEMAND |
| 이름 | 필수 서비스 테스트의 이름입니다. 데이터 유형: 문자열 |
| 관련서비스 | 필수 서비스 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| relatedService.href | 관련 서비스에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| relatedService.id | 제품 인벤토리의 Sys_id 또는 external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| startDateTime | 서비스 테스트의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| 상태 | 서비스 테스트의 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 테스트 측정 | 제품, 서비스 또는 자원 테스트의 특정 측면(예: 패킷 손실 또는 연결 상태)을 측정합니다. 데이터 형식: 객체 배열 |
| 테스트 측정.정확도 | 관련 메트릭에 대해 캡처된 테스트 측정 정확도를 나타내는 부동 소수점 값입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.captureDateTime | 메트릭이 캡처된 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasure.id | 테스트 측정값의 Sys_id 또는 external_id입니다. 테스트 측정 테이블 [sn_st_mgmt_test_measure] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| testMeasure.Measure.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.메트릭 이름 | 테스트 측정 메트릭의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation | 규칙이 위반될 경우의 결과와 함께 임계치 규칙 정의의 규칙을 정의하기 위한 객체입니다. 데이터 형식: 개체 배열 |
| testMeasure.ruleViolation.tolerancePeriod.amount | 결과를 적용하기 전의 기간 수입니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.appliedConsequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 개체 배열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | 임계치 규칙이 위반될 때 수행할 작업입니다. 예를 들어, 경고를 보내거나 보고서를 생성합니다. 적용된 작업은 인스턴스마다 다를 수 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.description | 적용된 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.id | 적용된 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.name | 적용된 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.repeatAction | 두 번째 위반이 발생할 때 결과를 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComporatorExact | 값이 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComporatorLower | 값이 임계치 아래로 떨어지는지 확인하기 위한 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComporatorUpper | 값이 임계치 이상인지 확인하기 위한 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.id | 임계치 규칙 위반의 Sys_id 또는 external_id입니다. 임계치 규칙 위반 테이블 [sn_st_mgmt_threshold_rule_violation] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.tolerancePeriod | 즉각적인 결과나 작업을 트리거하지 않고 교차 발생을 활성화하는 지정된 시간 간격입니다. 날짜 유형: 개체 |
| testMeasure.ruleViolation.tolerancePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasure.unitOfMeasure | 테스트 측정의 적합성 대상 값에 대한 측정 단위를 지정합니다. 데이터 유형: 문자열 |
| testMeasure.value (테스트 측정.값) | 테스트 측정값입니다. 데이터 유형: 객체 |
| testMeasure.value.id | 테스트 측정값의 ID입니다. 데이터 유형: 문자열 |
| testMeasure.value.name | 테스트 측정값의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.value.value | 테스트 측정값입니다. 데이터 유형: 문자열 |
| testMeasure.value.valueType | 숫자, 텍스트 등과 같은 테스트 측정 값의 유형입니다. 데이터 유형: 문자열 |
| 테스트 사양 | 필수 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| testSpecification.href | 서비스 테스트 정의에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| testSpecification.id | 서비스 테스트 정의의 sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| validFor | 서비스 테스트가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 서비스 테스트의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 서비스 테스트의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 특성 | 관련 서비스 테스트의 특징을 설명하는 목록입니다. 데이터 형식: 개체 배열 |
| characteristic.id | 특성의 Sys_id 또는 external_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 해당 레코드에 대한 external_id 있으면 응답은 external_id 반환 없으면 sys_id 반환합니다. 데이터 유형: 문자열 |
| characteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| 특성.값 | 서비스 테스트와 관련된 특성 옵션입니다. 특성은 고객 인스턴스에 따라 다릅니다. 데이터 유형: 문자열 |
| characteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| 설명 | 서비스 테스트에 대한 설명입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 서비스 테스트의 이름입니다. 데이터 유형: 문자열 |
| 관련서비스 | 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| relatedService.id | 제품 인벤토리의 Sys_id 또는 external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedService.name | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 테스트 측정 | 제품, 서비스 또는 자원 테스트의 특정 측면(예: 패킷 손실 또는 연결 상태)을 측정합니다. 데이터 형식: 개체 배열 |
| 테스트 측정.정확도 | 관련 메트릭에 대해 캡처된 테스트 측정 정확도를 나타내는 부동 소수점 값입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.captureDateTime | 메트릭이 캡처된 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasure.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.id | 테스트 측정값의 Sys_id 또는 external_id입니다. 테스트 측정 테이블 [sn_st_mgmt_test_measure] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.메트릭 이름 | 테스트 측정값의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation | 규칙이 위반될 경우의 결과와 함께 임계치 규칙 정의의 규칙을 정의하기 위한 객체입니다. 데이터 형식: 객체 배열 |
| testMeasure.ruleViolation.appliedConsequence | 임계치 규칙이 위반될 때 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 객체 배열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | 임계치 규칙이 위반될 때 수행할 작업입니다. 예를 들어, 경고를 보내거나 보고서를 생성합니다. 적용된 작업은 인스턴스마다 다를 수 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction | 적용된 작업을 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.appliedConsequence.description | 적용된 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.id | 적용된 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.name | 적용된 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComparatorExact | 값이 의 값 conformanceTargetExact과 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComparatorUpper | 값이 임계치를 초과하는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.description | 임계치 규칙 위반에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.id | 임계치 규칙 위반의 Sys_id 또는 external_id입니다. 임계치 규칙 위반 테이블 [sn_st_mgmt_threshold_rule_violation] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.tolerancePeriod | 결과가 시작되기 전에 허용된 교차가 발생할 수 있는 기간 또는 시간 간격입니다. 날짜 유형: 개체 |
| testMeasure.ruleViolation.tolerancePeriod.amount | 숫자로 나타내는 기간의 양입니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.tolerancePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasure.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasure.value (테스트 측정.값) | 테스트의 메트릭 값입니다. 데이터 유형: 객체 |
| testMeasure.value.id | 테스트의 메트릭 값 ID입니다. 데이터 유형: 문자열 |
| testMeasure.value.name | 테스트의 메트릭 값 이름입니다. 데이터 유형: 문자열 |
| testMeasure.value.value | 테스트의 메트릭 값입니다. 데이터 유형: 문자열 |
| testMeasure.value.valueType | 숫자, 텍스트 등과 같은 테스트 측정 값의 유형입니다. 데이터 유형: 문자열 |
| 테스트 사양 | 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| testSpecification.href | 서비스 테스트 정의에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| testSpecification.id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| validFor | 서비스 테스트가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 서비스 테스트의 종료 날짜 및 타임스탬프입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 서비스 테스트의 시작 날짜 및 타임스탬프입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 요청 본문에 제공된 세부 정보에 따라 지정된 서비스 테스트 엔터티를 업데이트합니다.
curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/2b406ec043b202104fefe4511fb8f211" \
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'
--data {
"description": "Service test description",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "No"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
응답은 지정된 테스트 서비스에서 수정된 정보를 반환하여 성공적인 업데이트를 보여줍니다.
{
"description": "Service test description",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
서비스 테스트 관리 Open API - PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
서비스 테스트 정의 엔터티의 부분 업데이트를 허용합니다.
URL 형식
기본 URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| id | 필수 검색할 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 설명 | 서비스 테스트 정의에 대한 설명입니다. 데이터 유형: 문자열 |
| 이름 | 필수 서비스 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| relatedServiceSpecification | 필수 테스트 정의의 서비스 사양입니다. 데이터 형식: 객체 배열 |
| relatedServiceSpecification.id | 서비스 사양의 Sys_id 또는 external_id입니다. 사양 [sn_prd_pm_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedServiceSpecification.name | 서비스 사양의 이름입니다. 데이터 유형: 문자열 |
| **serviceTestSpecRelationship** | 관련 서비스 테스트 정의입니다. 데이터 형식: 개체 배열 |
| serviceTestSpecRelationship.id | 관련 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 테스트 정의 [sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.name | 관련 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.relationshipType | 관계의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| spec특성 | 테스트 정의의 특성입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| testMeasureDefinition (테스트 측정 정의) | 이 서비스 테스트 정의에 대한 테스트 측정 정의입니다. 자세한 내용은 Define test measure definitions for a service test 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.captureFrequency | 메트릭을 캡처하는 빈도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.capturePeriod | 메트릭 캡처 기간 또는 기간입니다. 데이터 유형: 객체 |
| testMeasureDefinition.capturePeriod.amount | 캡처 기간 수입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.capturePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasureDefinition.id | 테스트 측정 정의의 Sys_id 또는 external_id입니다. 테스트 측정 정의 테이블 [sn_st_mgmt_test_measure_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricName | 테스트 측정값의 사용자 정의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.name | 테스트 측정 정의의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule | 테스트 측정 정의에서 임계치가 초과되거나 초과되지 않을 때 결과를 적용하기 전에 달성할 조건을 정의하는 규칙입니다. 자세한 내용은 Define threshold rules for a test measure definition 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | 값이 에 대해 설정된 testMeasureDefinition.thresholdRule.conformanceTargetExact값과 동일한지 여부를 나타내는 플래그입니다. true testMeasureDefinition.thresholdRule.conformanceTargetExact 로 설정하면 필수입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 값이 임계치를 초과하는지 여부를 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.consequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 자세한 내용은 Define measure consequences for the threshold rules 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.consequence.description | 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.id | 측정 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.name | 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | 임계치 위반에 대해 수행할 사용자 정의 작업입니다. 작업은 인스턴스마다 다릅니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | 적용된 결과를 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | 결과가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | 결과의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | 결과의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.id | 임계치 규칙의 Sys_id 또는 external_id입니다. 임계치 규칙 [sn_st_mgmt_threshold_rule] 테이블의 sys_id 또는 external_id에 위치 필드에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 최대값: 40 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | 임계치 규칙의 심각도 수준입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor | 테스트 측정 정의가 유효한 날짜 범위입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.endDateTime | 테스트 측정 정의의 유효성 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.startDateTime | 테스트 측정 정의의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 설명 | 서비스 테스트 정의에 대한 설명입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 서비스 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| relatedServiceSpecification | 테스트 정의에 대한 서비스 사양입니다. 데이터 형식: 개체 배열 |
| relatedServiceSpecification.id | 서비스 사양의 sys_id 또는 external_id입니다. 사양 [sn_prd_pm_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedServiceSpecification.name | 서비스 사양의 이름입니다. 데이터 유형: 문자열 |
| **serviceTestSpecRelationship** | 관련 서비스 테스트 정의입니다. 데이터 형식: 개체 배열 |
| serviceTestSpecRelationship.id | 관련 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 테스트 정의 [sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.name | 관련 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.relationshipType | 관계의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| spec특성 | 테스트 정의 특성. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| testMeasureDefinition (테스트 측정 정의) | 이 서비스 테스트 정의에 대한 테스트 측정 정의입니다. 자세한 내용은 Define test measure definitions for a service test 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.captureFrequency | 메트릭을 캡처하는 빈도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.capturePeriod | 캡처의 지속 시간 또는 기간입니다. 데이터 유형: 객체 |
| testMeasureDefinition.capturePeriod.amount | 캡처 기간 수입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.capturePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasureDefinition.id | 테스트 측정 정의의 Sys_id 또는 external_id입니다. 테스트 측정 정의 테이블 [sn_st_mgmt_test_measure_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricName | 테스트 측정값의 사용자 정의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.name | 테스트 측정 정의의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule | 특정 테스트 측정 정의에 대해 임계치가 초과되거나 초과가 중단될 때 결과를 적용하기 위해 달성할 조건(올리기 또는 해제)을 정의하는 규칙입니다. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | 값이 의 값 conformanceTargetExact과 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 값이 임계치를 초과하는지 여부를 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.consequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.consequence.description | 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.id | 측정 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.name | 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | 임계치 위반에 대해 수행할 사용자 정의 작업입니다. 작업은 인스턴스마다 다릅니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | 적용된 작업을 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | 결과가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | 결과의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | 결과의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.id | 임계치 규칙의 Sys_id 또는 external_id입니다. 임계치 규칙 [sn_st_mgmt_threshold_rule] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor | 테스트 측정 정의가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.validFor.endDateTime | 테스트 측정 정의의 유효성 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.startDateTime | 테스트 측정 정의의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 요청 본문에 제공된 수정 사항에 따라 지정된 서비스 테스트 정의 ID를 부분적으로 업데이트합니다.
curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e "
--request PATCH
--header "Accept:application/json"
--user 'username':'password'
--data {
"description": "Upstream and Downstream speed ",
"name": "This is my new Speed Test",
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
}
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
응답 본문은 서비스 테스트 사양의 업데이트된 부분을 반환합니다.
{
"description": "Upstream and Downstream speed ",
"name": "This is my new Speed Test",
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
}
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
서비스 테스트 관리 Open API - POST /sn_sprb_mgmt/servicetestmanagement/serviceTest
서비스 테스트를 생성합니다.
URL 형식
기본 URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 특성 | 관련 서비스 테스트의 특징을 설명하는 목록입니다. 테스트 정의 특성에 대한 자세한 내용은 데이터 형식: 개체 배열 |
| characteristic.id | 특성의 Sys_id 또는 external_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 해당 레코드에 대한 external_id 있으면 응답은 external_id 반환 없으면 sys_id 반환합니다. 데이터 유형: 문자열 |
| characteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| 특성.값 | 서비스 테스트와 관련된 특성 옵션입니다. 특성은 고객 인스턴스에 따라 다릅니다. 데이터 유형: 문자열 |
| characteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| 설명 | 서비스 테스트에 대한 설명입니다. 데이터 유형: 문자열 |
| 종료 날짜 시간 | 서비스 테스트의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| id | 서비스 테스트의 Sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 이 ID는 서비스 테스트를 만들고 external_id로 사용됩니다. 데이터 유형: 문자열 |
| 모드 | 서비스 테스트가 실행 중인 모드입니다. 유효한 값은 다음과 같습니다.
기본값: ONDEMAND |
| 이름 | 필수 서비스 테스트의 이름입니다. 데이터 유형: 문자열 |
| 관련서비스 | 필수 서비스 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| relatedService.href | 관련 서비스에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| relatedService.id | 제품 인벤토리의 Sys_id 또는 external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedService.name | 제품 인벤토리 항목의 이름입니다. 데이터 유형: 문자열 |
| startDateTime | 서비스 테스트의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| 상태 | 서비스 테스트의 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 테스트 측정 | 제품, 서비스 또는 자원 테스트의 특정 측면(예: 패킷 손실 또는 연결 상태)을 측정합니다. 데이터 형식: 객체 배열 |
| 테스트 측정.정확도 | 관련 메트릭에 대해 캡처된 테스트 측정 정확도를 나타내는 부동 소수점 값입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.captureDateTime | 메트릭이 캡처된 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasure.id | 테스트 측정값의 Sys_id 또는 external_id입니다. 테스트 측정 테이블 [sn_st_mgmt_test_measure] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| testMeasure.Measure.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.메트릭 이름 | 테스트 측정 메트릭의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation | 규칙이 위반될 경우의 결과와 함께 임계치 규칙 정의의 규칙을 정의하기 위한 객체입니다. 데이터 형식: 개체 배열 |
| testMeasure.ruleViolation.appliedConsequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 개체 배열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | 임계치 규칙이 위반될 때 수행할 작업입니다. 예를 들어, 경고를 보내거나 보고서를 생성합니다. 적용된 작업은 인스턴스마다 다를 수 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.description | 적용된 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.id | 적용된 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.name | 적용된 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.repeatAction | 두 번째 위반이 발생할 때 결과를 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComporatorExact | 값이 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComporatorLower | 값이 임계치 아래로 떨어지는지 확인하기 위한 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComporatorUpper | 값이 임계치 이상인지 확인하기 위한 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.id | 임계치 규칙 위반의 Sys_id 또는 external_id입니다. 임계치 규칙 위반 테이블 [sn_st_mgmt_threshold_rule_violation] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.tolerancePeriod | 즉각적인 결과나 작업을 트리거하지 않고 교차 발생을 활성화하는 지정된 시간 간격입니다. 날짜 유형: 개체 |
| testMeasure.ruleViolation.tolerancePeriod.amount | 결과를 적용하기 전의 기간 수입니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.tolerancePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasure.unitOfMeasure | 테스트 측정의 적합성 대상 값에 대한 측정 단위를 지정합니다. 데이터 유형: 문자열 |
| testMeasure.value (테스트 측정.값) | 테스트 측정값입니다. 데이터 유형: 객체 |
| testMeasure.value.id | 테스트 측정값의 ID입니다. 데이터 유형: 문자열 |
| testMeasure.value.name | 테스트 측정값의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.value.value | 테스트 측정값입니다. 데이터 유형: 문자열 |
| testMeasure.value.valueType | 숫자, 텍스트 등과 같은 테스트 측정 값의 유형입니다. 데이터 유형: 문자열 |
| 테스트 사양 | 필수 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| testSpecification.href | 서비스 테스트 정의에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| testSpecification.id | 서비스 테스트 정의의 sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| validFor | 서비스 테스트가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 서비스 테스트의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 서비스 테스트의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 특성 | 관련 서비스 테스트의 특징을 설명하는 목록입니다. 데이터 형식: 개체 배열 |
| characteristic.id | 특성의 Sys_id 또는 external_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 해당 레코드에 대한 external_id 있으면 응답은 external_id 반환 없으면 sys_id 반환합니다. 데이터 유형: 문자열 |
| characteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| 특성.값 | 서비스 테스트와 관련된 특성 옵션입니다. 특성은 고객 인스턴스에 따라 다릅니다. 데이터 유형: 문자열 |
| characteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| 설명 | 서비스 테스트에 대한 설명입니다. 데이터 유형: 문자열 |
| 종료 날짜 시간 | 서비스 테스트의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 모드 | 서비스 테스트가 실행되는 모드입니다. 유효한 값은 다음과 같습니다.
기본값: ONDEMAND |
| 이름 | 서비스 테스트의 이름입니다. 데이터 유형: 문자열 |
| 관련서비스 | 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| relatedService.id | 제품 인벤토리의 Sys_id 또는 external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedService.name | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| startDateTime | 서비스 테스트의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| 상태 | 서비스 테스트의 상태입니다. 유효한 값은 다음과 같습니다.
|
| 테스트 측정 | 제품, 서비스 또는 자원 테스트의 특정 측면(예: 패킷 손실 또는 연결 상태)을 측정합니다. 데이터 형식: 개체 배열 |
| 테스트 측정.정확도 | 관련 메트릭에 대해 캡처된 테스트 측정 정확도를 나타내는 부동 소수점 값입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasure.captureDateTime | 메트릭이 캡처된 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasure.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.id | 테스트 측정값의 Sys_id 또는 external_id입니다. 테스트 측정 테이블 [sn_st_mgmt_test_measure] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.메트릭 이름 | 테스트 측정값의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation | 규칙이 위반될 경우의 결과와 함께 임계치 규칙 정의의 규칙을 정의하기 위한 객체입니다. 데이터 형식: 객체 배열 |
| testMeasure.ruleViolation.appliedConsequence | 임계치 규칙이 위반될 때 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 객체 배열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | 임계치 규칙이 위반될 때 수행할 작업입니다. 예를 들어, 경고를 보내거나 보고서를 생성합니다. 적용된 작업은 인스턴스마다 다를 수 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction | 적용된 작업을 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.appliedConsequence.description | 적용된 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.id | 적용된 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.appliedConsequence.name | 적용된 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComparatorExact | 값이 의 값 conformanceTargetExact과 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasure.ruleViolation.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceComparatorUpper | 값이 임계치를 초과하는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 임계치를 초과했는지 또는 더 이상 초과하지 않는지 여부를 결정합니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.description | 임계치 규칙 위반에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.id | 임계치 규칙 위반의 Sys_id 또는 external_id입니다. 임계치 규칙 위반 테이블 [sn_st_mgmt_threshold_rule_violation] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasure.ruleViolation.name | 임계치 규칙 위반의 이름입니다. 날짜 유형: 문자열 |
| testMeasure.ruleViolation.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasure.ruleViolation.tolerancePeriod | 결과가 시작되기 전에 허용된 교차가 발생할 수 있는 기간 또는 시간 간격입니다. 날짜 유형: 개체 |
| testMeasure.ruleViolation.tolerancePeriod.amount | 숫자로 나타내는 기간의 양입니다. 데이터 유형: 숫자 |
| testMeasure.ruleViolation.tolerancePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasure.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasure.value (테스트 측정.값) | 테스트의 메트릭 값입니다. 데이터 유형: 객체 |
| testMeasure.value.id | 테스트의 메트릭 값 ID입니다. 데이터 유형: 문자열 |
| testMeasure.value.name | 테스트의 메트릭 값 이름입니다. 데이터 유형: 문자열 |
| testMeasure.value.name | 테스트의 메트릭 값 이름입니다. 데이터 유형: 문자열 |
| testMeasure.value.value | 테스트의 메트릭 값입니다. 데이터 유형: 문자열 |
| testMeasure.value.valueType | 숫자, 텍스트 등과 같은 테스트 측정 값의 유형입니다. 데이터 유형: 문자열 |
| 테스트 사양 | 이 테스트와 관련된 테스트 정의입니다. 데이터 유형: 객체 |
| testSpecification.href | 서비스 테스트 정의에 대한 하이퍼링크 참조입니다. 데이터 유형: 문자열 |
| testSpecification.id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| validFor | 서비스 테스트가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 서비스 테스트의 종료 날짜 및 타임스탬프입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 서비스 테스트의 시작 날짜 및 타임스탬프입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 요청 본문에 제공된 특정 세부 정보에 따라 새 서비스 테스트를 만듭니다.
curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data {
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "Yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
응답은 새 테스트 서비스에 대한 확인 세부 정보를 반환하고 고유 ID 2b406ec043b202104fefe4511fb8f211을 할당합니다.
{
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "Yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
],
"id": "2b406ec043b202104fefe4511fb8f211"
}
서비스 테스트 관리 Open API - POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
새 서비스 테스트 정의를 생성합니다.
URL 형식
기본 URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 설명 | 서비스 테스트 정의에 대한 설명입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 서비스 테스트 정의[sn_st_mgmt_test_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 필수 서비스 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| relatedServiceSpecification | 필수 테스트 정의의 서비스 사양입니다. 데이터 형식: 객체 배열 |
| relatedServiceSpecification.id | 서비스 사양의 Sys_id 또는 external_id입니다. 사양 [sn_prd_pm_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedServiceSpecification.name | 서비스 사양의 이름입니다. 데이터 유형: 문자열 |
| **serviceTestSpecRelationship** | 관련 서비스 테스트 정의입니다. 데이터 형식: 개체 배열 |
| serviceTestSpecRelationship.id | 관련 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 테스트 정의 [sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.name | 관련 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.relationshipType | 관계의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| spec특성 | 테스트 정의의 특성입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| testMeasureDefinition (테스트 측정 정의) | 이 서비스 테스트 정의에 대한 테스트 측정 정의입니다. 자세한 내용은 Define test measure definitions for a service test 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.captureFrequency | 메트릭을 캡처하는 빈도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.capturePeriod | 메트릭 캡처 기간 또는 기간입니다. 데이터 유형: 객체 |
| testMeasureDefinition.capturePeriod.amount | 캡처 기간 수입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.capturePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasureDefinition.id | 테스트 측정 정의의 Sys_id 또는 external_id입니다. 테스트 측정 정의 테이블 [sn_st_mgmt_test_measure_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricName | 테스트 측정값의 사용자 정의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.name | 테스트 측정 정의의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule | 테스트 측정 정의에서 임계치가 초과되거나 초과되지 않을 때 결과를 적용하기 전에 달성할 조건을 정의하는 규칙입니다. 자세한 내용은 Define threshold rules for a test measure definition 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | 값이 에 대해 설정된 testMeasureDefinition.thresholdRule.conformanceTargetExact값과 동일한지 여부를 나타내는 플래그입니다. true testMeasureDefinition.thresholdRule.conformanceTargetExact 로 설정하면 필수입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 값이 임계치를 초과하는지 여부를 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.consequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 자세한 내용은 Define measure consequences for the threshold rules 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.consequence.description | 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.id | 측정 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.name | 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | 임계치 위반에 대해 수행할 사용자 정의 작업입니다. 작업은 인스턴스마다 다릅니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | 적용된 결과를 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | 결과가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | 결과의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | 결과의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.id | 임계치 규칙의 Sys_id 또는 external_id입니다. 임계치 규칙 [sn_st_mgmt_threshold_rule] 테이블의 sys_id 또는 external_id에 위치 필드에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 최대값: 40 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | 임계치 규칙의 심각도 수준입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor | 테스트 측정 정의가 유효한 날짜 범위입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.endDateTime | 테스트 측정 정의의 유효성 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.startDateTime | 테스트 측정 정의의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor | 테스트 정의가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 상태가 폐기되는 테스트 정의의 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 상태가 게시된 테스트 정의의 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 설명 | 서비스 테스트 정의에 대한 설명입니다. 데이터 유형: 문자열 |
| id | 서비스 테스트 정의의 sys_id 또는 external_id입니다. 서비스 테스트 [sn_st_mgmt_test] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 서비스 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| relatedServiceSpecification | 테스트 정의에 대한 서비스 사양입니다. 데이터 형식: 개체 배열 |
| relatedServiceSpecification.id | 서비스 사양의 sys_id 또는 external_id입니다. 사양 [sn_prd_pm_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| relatedServiceSpecification.name | 서비스 사양의 이름입니다. 데이터 유형: 문자열 |
| **serviceTestSpecRelationship** | 관련 서비스 테스트 정의입니다. 데이터 형식: 개체 배열 |
| serviceTestSpecRelationship.id | 관련 서비스 테스트 정의의 Sys_id 또는 external_id입니다. 테스트 정의 [sn_st_mgmt_test_definition] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.name | 관련 테스트 정의의 이름입니다. 데이터 유형: 문자열 |
| serviceTestSpecRelationship.relationshipType | 관계의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| spec특성 | 테스트 정의 특성. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification | 특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 |
| specCharacteristic.characteristicValueSpecification.value | 특성의 값입니다. 데이터 유형: 문자열 |
| specCharacteristic.description | 특성에 대한 설명입니다. 데이터 유형: 문자열 |
| specCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| specCharacteristic.validFor | 특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| specCharacteristic.validFor.endDateTime | 특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.validFor.startDateTime | 특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| specCharacteristic.valueType | 특성 값의 유형입니다.
데이터 유형: 문자열 |
| testMeasureDefinition (테스트 측정 정의) | 이 서비스 테스트 정의에 대한 테스트 측정 정의입니다. 자세한 내용은 Define test measure definitions for a service test 문서를 참조하십시오. 데이터 형식: 개체 배열 |
| testMeasureDefinition.captureFrequency | 메트릭을 캡처하는 빈도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.captureMethod | 메트릭을 캡처하는 데 사용되는 방법입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.capturePeriod | 캡처의 지속 시간 또는 기간입니다. 데이터 유형: 객체 |
| testMeasureDefinition.capturePeriod.amount | 캡처 기간 수입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.capturePeriod.units | 기간의 단위입니다. 허용되는 값:
데이터 유형: 문자열 |
| testMeasureDefinition.id | 테스트 측정 정의의 Sys_id 또는 external_id입니다. 테스트 측정 정의 테이블 [sn_st_mgmt_test_measure_definition] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricDescription | 메트릭에 대한 간단한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.metricName | 테스트 측정값의 사용자 정의 메트릭 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.name | 테스트 측정 정의의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule | 특정 테스트 측정 정의에 대해 임계치가 초과되거나 초과가 중단될 때 결과를 적용하기 위해 달성할 조건(올리기 또는 해제)을 정의하는 규칙입니다. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | 값이 의 값 conformanceTargetExact과 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | 값이 임계치 아래로 떨어지는지 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 값이 임계치를 초과하는지 여부를 확인하는 연산자입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | true로 설정된 경우 conformanceComparatorExact 필요합니다. conformanceComparatorExact 값을 true로 설정하면 해당 값이 에 정의된 값과 일치합니다conformanceTargetExact. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | 테스트 측정 결과를 비교하기 위한 하한 임계값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | 테스트 측정 결과를 비교하기 위한 상한 임계치 값입니다. 데이터 유형: 숫자 |
| testMeasureDefinition.thresholdRule.consequence | 임계치 규칙이 초과될 경우 수행할 작업(규정된 작업 또는 알림)입니다. 데이터 형식: 개체 배열 |
| testMeasureDefinition.thresholdRule.consequence.description | 결과에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.id | 측정 결과의 Sys_id 또는 external_id입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.name | 결과의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | 임계치 위반에 대해 수행할 사용자 정의 작업입니다. 작업은 인스턴스마다 다릅니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | 적용된 작업을 반복할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | 결과가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | 결과의 유효 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | 결과의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.description | 임계치 규칙에 대한 설명입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.id | 임계치 규칙의 Sys_id 또는 external_id입니다. 임계치 규칙 [sn_st_mgmt_threshold_rule] 테이블에 있습니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.name | 임계치 규칙의 이름입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | 결과가 적용되기 전에 허용 오차 기간 내에 허용되는 최대 교차입니다. 데이터 유형: 숫자 최대값: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | 임계치 규칙의 심각도입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| testMeasureDefinition.unitOfMeasure | 서비스 성과를 일, 분, 초 단위로 계산하는 데 사용되는 측정 가능한 시간 값입니다. 데이터 유형: 문자열 |
| testMeasureDefinition.validFor | 테스트 측정 정의가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| testMeasureDefinition.validFor.endDateTime | 테스트 측정 정의의 유효성 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| testMeasureDefinition.validFor.startDateTime | 테스트 측정 정의의 유효 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor | 서비스 테스트가 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.endDateTime | 서비스 테스트의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.startDateTime | 서비스 테스트의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
cURL 요청
다음 예제에서는 새 서비스 테스트 정의를 만듭니다.
curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
-- data {
"description": "Upstream and Downstream speed ",
"name": "Speed Test",
"validFor": {
"startDateTime": "2024-05-31",
"endDateTime": "2024-06-27"
},
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
},
"characteristicValueSpecification": [
{
"value": "No",
},
{
"value": "Yes",
}
]
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
응답 본문입니다.
{
"description": "Upstream and Downstream speed ",
"name": "Speed Test",
"validFor": {
"startDateTime": "2024-05-31",
"endDateTime": "2024-06-27"
},
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
},
"characteristicValueSpecification": [
{
"value": "No",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
}
]
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
"id": "89d2b920432a02104fefe4511fb8f22e"
}