SG 서비스 API

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

    • SG 서비스 API는 애플리케이션 서비스와 이들 간의 업스트림 관계를 만들고 관리하는 엔드포인트를 제공합니다.

    스토어에서 앱 요청

    ServiceNow Store 웹 사이트를 방문하면 사용 가능한 모든 앱을 확인하고 스토어에 요청을 제출하는 방법에 대한 정보를 참조할 수 있습니다. 출시된 모든 앱의 누적 릴리스 정보는 ServiceNow Store 릴리스 정보를 참조하십시오.

    이 API는 CMDB 애플리케이션 API 및 CLI(sn_service_graph) 플러그인이 활성화된 경우에만 사용할 수 있습니다. 이 API는 sn_service_graph 네임스페이스 내에서 사용됩니다.

    이 API를 사용하면 소스 테이블이나 관계 유형에 대한 세부 정보가 필요하지 않습니다.

    엔터프라이즈 전체에서 자동화를 지원하는 중요한 작업을 스크립팅하려면 사용자 인터페이스를 사용하는 대신 API를 활용하거나 CMDB 애플리케이션 CLI 및 API 스토어 앱에서 제공하는 명령줄 작업을 실행할 수 있습니다. CMDB 애플리케이션 CLI 및 API 스토어 앱은 애플리케이션 서비스와 관련된 모든 API와 해당 API에 대한 인터페이스에 액세스할 수 있는 명령줄을 통합하는 강력한 프레임워크를 제공합니다.

    CMDB 애플리케이션 CLI 및 API 명령을 사용하면 다음 작업을 수행할 수 있습니다.
    • 애플리케이션 서비스 등록 및 생성과 업스트림 관계 설정
    • 지정된 애플리케이션 서비스 및 해당 업스트림 관계에 대한 상세 정보 가져오기
    • 비즈니스 애플리케이션 및 비즈니스 서비스 오퍼링과 같은 상위 수준 구성 연결
    • 지정된 채우기 유형으로 애플리케이션 서비스 채우기
    • 애플리케이션 서비스의 상태 변경

    명령줄 솔루션은 CMDB 애플리케이션 CLI 및 API 사용 가능한 명령을 참조하십시오.

    SG 서비스 – POST – /sg_services/app_service/변환

    수동 또는 빈 유형의 애플리케이션 서비스를 계산된 애플리케이션 서비스로 변환합니다. 변환하는 동안 애플리케이션 서비스 기록은 새로 할당된 클래스가 있는 [cmdb_ci_service_calculated] 테이블로 이동합니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/convert

    기본 URL: /api/sn_service_graph/sg_services/app_service/convert

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(JSON)
    이름 설명
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    수준 변환에 포함할 수준의 수입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

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

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    상태 성공 또는 실패를 나타냅니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예는 애플리케이션 서비스 유형을 변환하는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/convert" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
 \"name\": \"Test Register\",
 \"environment\": \"Test\",
 \"version\": \"1.0\",
 \"levels\" : 8
}" \
--user 'username':'password'

    계산된 애플리케이션 서비스로의 변환이 성공적으로 이루어졌음을 나타내는 결과입니다.

    {
  "result": {
  "status": "success"
  }
}

    SG 서비스 – POST – /sg_services/app_service/delete

    애플리케이션 서비스를 삭제합니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/delete

    기본 URL: /api/sn_service_graph/sg_services/app_service/delete

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 8. 쿼리 매개변수
    이름 설명
    없음
    표 9. 요청 본문 매개변수(JSON)
    이름 설명
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

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

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

    상태 코드

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

    표 12. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    상태 성공 또는 실패를 나타냅니다.

    데이터 유형: 문자열

    cURL 요청

    다음은 애플리케이션 서비스를 삭제하는 예시입니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\": \"Test Register\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
}" \
--user 'username':'password'

    애플리케이션 서비스가 성공적으로 제거되었음을 나타내는 결과입니다.

    {
  "result": {
  "status": "success"
  }
}

    SG 서비스 – POST – /sg_services/app_service/find

    지정된 애플리케이션 서비스와 해당 업스트림 관계의 상세 정보를 찾습니다.

    app_service_user 역할이 있는 사용자는 이 API를 사용할 수 있지만 결과는 운영 상태의 애플리케이션 서비스로 제한됩니다. app_service_admin 역할은 애플리케이션 서비스를 무제한으로 볼 수 있습니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/find

    기본 URL: /api/sn_service_graph/sg_services/app_service/find

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(JSON)
    이름 설명
    <IRE 필드> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

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

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

    상태 코드

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

    표 18. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    operational_status 애플리케이션 서비스의 운영 상태입니다. 예: active.

    데이터 유형: 문자열
    관계 애플리케이션 서비스의 업스트림 관계를 정의하는 객체 목록입니다.

    데이터 유형: 배열

    "relationships": [
 {
    "name": "String",
    "number": "String",
    "sys_id": "String",
    "class_name": "String",
    "relationship": "String"
 }
]
    relationships.class_name 애플리케이션 서비스를 포함하는 클래스의 이름입니다.

    데이터 유형: 문자열
    relationships.name 관계의 이름입니다.

    데이터 유형: 문자열
    관계.번호 관계의 고유 번호입니다.

    데이터 유형: 문자열
    관계.관계 관계 규칙입니다.

    데이터 유형: 문자열
    relationships.sys_id 관계의 Sys_id입니다.

    데이터 유형: 문자열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예는 애플리케이션 서비스의 상세 정보를 찾는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/find" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\": \"Test App Service1\"
 }" \
--user 'username':'password'

    응답 본문에는 애플리케이션 서비스 및 관계 정보가 포함됩니다.

    {
  "result": {
    "aliases": null,
    "asset": null,
    "asset_tag": null,
    "assigned": "",
    "assigned_to": null,
    "assignment_group": null,
    "attestation_score": null,
    "attested": "0",
    "attested_by": null,
    "attested_date": "",
    "attributes": null,
    "bucket": null,
    "business_contact": null,
    "business_need": null,
    "business_relation_manager": null,
    "business_unit": null,
    "busines_criticality": "4 - not critical",
    "can_print": "0",
    "category": null,
    "change_control": null,
    "checked_in": "",
    "checked_out": "",
    "checkout": null,
    "comments": null,
    "company": null,
    "compatibility_dependencies": null,
    "consumer_type": "internal",
    "correlation_id": null,
    "cost": null,
    "cost_cc": "USD",
    "cost_center": null,
    "delivery_date": "",
    "delivery_manager": null,
    "department": null,
    "discovery_source": "Manual Entry",
    "dns_domain": null,
    "due": "",
    "due_in": null,
    "duplicate_of": null,
    "end_date": "",
    "environment": null,
    "fault_count": "0",
    "first_discovered": "2021-07-19 20:09:48",
    "fqdn": null,
    "gl_account": null,
    "hide_from_dashboard": "0",
    "install_date": "",
    "install_status": "1",
    "invoice_number": null,
    "ip_address": null,
    "justification": null,
    "last_discovered": "2021-07-19 20:09:48",
    "last_review_date": "",
    "layer": null,
    "lease_id": null,
    "life_cycle_stage": null,
    "life_cycle_stage_status": null,
    "location": null,
    "mac_address": null,
    "maintenance_schedule": null,
    "managed_by": null,
    "managed_by_group": null,
    "manufacturer": null,
    "model_id": null,
    "model_number": null,
    "monitor": "0",
    "monitoring_requirements": null,
    "name": "Test App Service1",
    "number": "SNSVC0001014",
    "operational_status": "2",
    "order_date": "",
    "owned_by": null,
    "parent": null,
    "portfolio_status": "pipeline",
    "po_number": null,
    "prerequisites": null,
    "price_model": "per_unit",
    "price_unit": null,
    "published_ref": null,
    "purchase_date": "",
    "schedule": null,
    "serial_number": null,
    "service_classification": "Application Service",
    "service_level_requirement": null,
    "service_owner_delegate": null,
    "service_status": "requirements",
    "severity": null,
    "short_description": null,
    "skip_sync": "0",
    "sla": null,
    "spm_service_portfolio": null,
    "spm_taxonomy_node": null,
    "stakeholders": null,
    "start_date": "",
    "state": null,
    "subcategory": null,
    "supported_by": null,
    "support_group": null,
    "sys_class_name": "cmdb_ci_service_auto",
    "sys_class_path": "/!!/!7/!(",
    "sys_created_by": "admin",
    "sys_created_on": "2021-07-19 20:09:48",
    "sys_domain": "global",
    "sys_domain_path": "/",
    "sys_id": "a2f0618040697410f87713b656474255",
    "sys_mod_count": "0",
    "sys_updated_by": "admin",
    "sys_updated_on": "2021-07-19 20:09:48",
    "unit_description": null,
    "unverified": "0",
    "used_for": "Production",
    "user_group": null,
    "vendor": null,
    "version": null,
    "view_service": "61e1cb757f23220002d31ccebefa9120",
    "warranty_expiration": "",
    "relationships": [
      {
        "name": "Test Biz App1",
        "sys_id": "0250a94040697410f87713b656474250",
        "number": "APM0001001",
        "class_name": "cmdb_ci_business_app",
        "relationship": "Consumes::Consumed by"
      },
      {
        "name": "Tech Service Offering1",
        "sys_id": "98d0ed4040697410f87713b6564742ef",
        "number": "BSN0001005",
        "class_name": "service_offering",
        "relationship": "Contains::Contained by"
      }
    ]
  }
}

    SG 서비스 – POST – /sg_services/app_service/populate

    서비스 채우기 메서드로 애플리케이션 서비스를 채웁니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/populate

    기본 URL: /api/sn_service_graph/sg_services/app_service/populate

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 20. 쿼리 매개변수
    이름 설명
    없음
    표 21. 요청 본문 매개변수(JSON)
    이름 설명
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    population_method 필수 채우기 메서드와 이에 수반되는 속성을 식별하여 채우기에 대한 컨텐츠를 식별합니다.

    유형당 하나의 동반 개체만 유효합니다.

    데이터 유형: 객체
    population_method.group_id입니다. cmdb_group 채우기 유형으로 구성된 CMDB 그룹의 그룹 ID입니다.

    데이터 형식: "문자열"

    "population_method": {
  "group_id": "String",
  "type": "cmdb_group"
}

    관련 인구 유형: cmdb_group
    population_method.수준 서비스를 빌드하는 데 사용할 수준의 수입니다. 수준 값이 제공되지 않은 경우 시스템은 값에 대한 sys_property 확인합니다. svc.manual.convert.levels.default_value 채우지 않으면 기본값 3이 사용됩니다.

    데이터 유형: 숫자

    "population_method": {
  "levels": Number,
  "type": "dynamic_service"
}

    관련 인구 유형: dynamic_service

    기본값: sys_property에 대해 수준 값이 설정되지 않은 경우 3
    population_method.service_candidate

    서비스 후보의 고유 식별자입니다.

    데이터 유형: 문자열

    "population_method": {
  "service_candidate": "String",
  "type": "tag_based_service_family"
}

    관련 인구 유형: tag_based_service_family
    population_method.service_relations 애플리케이션 서비스 내 CI에 대한 계층 구조 데이터를 포함하는 객체 목록입니다. 모든 CI는 상위 및 하위 CI와 쌍을 이룹니다. 애플리케이션 서비스의 엔트리포인트라고 하는 최상위 CI에는 상위 CI가 없습니다.

    데이터 유형: 배열

    "population_method": {

  "service_relations":[
     {
      "child": "String",
      "parent": "String"
     }
  ],

  "type": "service_hierarchy"   
}

    관련 인구 유형: service_hierarchy
    population_method.service_relations.child CI와 관련된 하위 CI의 이름입니다.

    데이터 유형: 문자열
    population_method.service_relations.parent CI와 관련된 상위 CI의 이름입니다.

    데이터 유형: 문자열
    population_method.태그 CI와 연결할 태그가 포함된 객체의 목록입니다. 이 정보는 키 값 [cmdb_key_value] 테이블에 있습니다.

    데이터 유형: 배열

    "population_method": {

  "tags": [
     {
      "tag": "String",
      "value": "String"
     }
  ],

  "type": "tag_list"  
}

    관련 인구 유형: tag_list
    population_method.tags.tag 태그 이름입니다.

    데이터 유형: 문자열
    population_method.tags.value 태그 값입니다.

    데이터 유형: 문자열
    population_method.type 필수 애플리케이션 서비스에 추가할 채우기 유형입니다.

    데이터 유형: 객체

    유효한 값은 다음과 같습니다.
    • cmdb_group
    • service_hierarchy
    • dynamic_service
    • tag_list
    • tag_based_service_family
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

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

    표 22. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 24. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    상태 성공 또는 실패를 나타냅니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예는 애플리케이션 서비스를 dynamic_service 유형으로 채우는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/populate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",

 \"population_method\": {
   \"type\": \"dynamic_service\",
   \"levels\" : 8
  }
}" \
--user 'username':'password'

    애플리케이션 서비스의 성공적인 채우기를 나타내는 결과입니다.

    {
  "result": {
  "status": "success"
  }
}

    SG 서비스 – POST – /sg_services/app_service/register

    애플리케이션 서비스를 생성하고 태그를 지정하며 비즈니스 애플리케이션, 비즈니스 서비스 오퍼링 및 기타 애플리케이션 서비스와 같은 업스트림 관계를 구성합니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/register

    기본 URL: /api/sn_service_graph/sg_services/app_service/register

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 26. 쿼리 매개변수
    이름 설명
    없음
    표 27. 요청 본문 매개변수(JSON)
    이름 설명
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    관계 유형별로 분류된 업스트림 관계입니다.

    데이터 유형: 객체

    "relationships": {
 "business_app": [Array],
 "business_service_offering": [Array],
 "parent_app_service": [Array],
 "technical_service_offering": [Array]
}

    최대 관계 수는 25개입니다.
    relationships.business_app
    비즈니스 애플리케이션 관계 유형을 나타내는 객체의 목록입니다. 이러한 값은 다음 항목 중 하나를 키-값 쌍으로 사용하여 정의할 수 있습니다.
    • <IRE 필드 이름>
    • 번호
    • sys_id

    데이터 유형: 배열
    relationships.business_service_offering
    비즈니스 서비스 오퍼링 관계 유형을 나타내는 객체 목록입니다. 이러한 값은 다음 항목을 키-값 쌍으로 사용하여 정의할 수 있습니다.
    • <IRE 필드 이름>
    • 번호
    • sys_id

    데이터 유형: 배열
    relationships.parent_app_service
    애플리케이션 서비스 관계 유형을 나타내는 객체의 목록입니다. 이러한 값은 다음 항목을 키-값 쌍으로 사용하여 정의할 수 있습니다.
    • <IRE 필드 이름>
    • 번호
    • sys_id

    데이터 유형: 배열
    relationships.technical_service_offering
    기술 서비스 오퍼링 관계 유형을 나타내는 객체의 목록입니다. 이러한 값은 다음 항목을 키-값 쌍으로 사용하여 정의할 수 있습니다.
    • <IRE 필드 이름>
    • 번호
    • sys_id

    데이터 유형: 배열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열
    태그 태그 정의를 키-값 쌍으로 포함하는 객체의 목록입니다.
    "tags": [
 {
  "key": "String",
  "value": "String"
 }]

    데이터 유형: 배열
    tags.key 태그 범주 이름입니다.

    데이터 유형: 문자열
    tags.value 태그 값입니다.

    데이터 유형: 문자열

    헤더

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

    표 28. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 29. 응답 헤더
    c헤더 설명
    없음

    상태 코드

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

    표 30. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    c헤더 설명
    app_service 애플리케이션 서비스 상세 정보입니다.

    데이터 유형: 객체

    "app_service": {
  "name": "String",
  "number": "String",
  "sys_id": "String"
}
    app_service.이름 애플리케이션 서비스의 이름입니다.

    데이터 유형: 문자열
    app_service.번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    app_service.sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열
    메시지 상태를 설명하는 메시지입니다.
    가능한 값:
    • 서비스가 이미 있습니다.
    • 서비스가 성공적으로 등록됨

    데이터 유형: 문자열
    상태 서비스가 등록되었는지 여부를 나타내는 상태입니다.
    가능한 값:
    • 삽입: 애플리케이션 서비스가 성공적으로 작성되었습니다.
    • 작업 없음: 애플리케이션 서비스가 이미 있습니다. 아무 작업도 수행하지 않았습니다.

    데이터 유형: 문자열

    cURL 요청

    다음은 애플리케이션 서비스를 등록하는 예시입니다.

    curl "instance.service-now.com/api/sn_service_graph/sg_services/app_service/register" \--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",
  \"number\": \" SNSVC0001014\",
  \"relationships\": {
    \"business_application\": [
      {
        \"sys_id\": \"0250a94040697410f87713b656474250\"
      },
      {
        \"number\": \"APM0001002\"
      },
      {
        \"name\": \"Test Biz App1\"
      }
    ],
    \"business_service_offering\": [
      {
        \"sys_id\": \"ed32e98040697410f87713b656474259\"
      }
    ],
    \"technical_service_offering\": [
      {
        \"sys_id\": \"80e12d8040697410f87713b65647421c\"
      },
      {
        \"number\": \"BSN0001005\"
      },
      {
        \"name\": \"Tech Service Offering2\"
      }
    ],
    \"parent_app_service\": [
      {
        \"sys_id\": \"a2f0618040697410f87713b656474255\"
      }
    ]
  },
  \"tags\": [
    {
      \"key\": \"key1\",
      \"value\": \"value1\"
    },
    {
      \"key\": \"key2\",
      \"value\": \"value2\"
    }
  ]
}" \
--user 'username':'password'

    응답 본문에는 ID 및 상태 정보가 포함됩니다.

    {
  "result": {
    "app_service": {
      "sys_id": "5780cb604061f410f87713b656474271",
      "name": "Test Register",
      "number": " SNSVC0001014"
    },
    "message": "Service registered successfully",
    "status": "INSERT"
  }
}

    SG 서비스 – POST – /sg_services/app_service/relationship/create

    비즈니스 애플리케이션, 비즈니스 서비스 오퍼링 및 기타 애플리케이션 서비스와 같은 업스트림 관계를 구성합니다.

    이 API는 단일 상위 및 해당 하위 객체와의 입력을 받아 관계를 생성합니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/create

    기본 URL: /api/sn_service_graph/sg_services/app_service/relationship/create

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 32. 쿼리 매개변수
    이름 설명
    없음
    표 33. 요청 본문 매개변수(JSON)
    이름 설명
    하위 관계를 생성할 하위 애플리케이션 서비스를 식별하는 정보입니다. 하위 항목은 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 있습니다.

    동적 CI 그룹은 하위로 추가할 수 있지만 상위가 될 수는 없습니다.

    데이터 유형: 객체

    "child": {
  "<service_app_identifier>": "String"
}
    아이.<service_app_identifier> 관계를 생성할 하위 애플리케이션 서비스를 식별하는 상세 정보입니다.
    하나의 옵션만 필요합니다. 각 옵션은 처리 우선 순위에 따라 나열됩니다.
    • sys_id - 하위 애플리케이션 서비스의 Sys_id입니다.
    • number – 하위 애플리케이션 서비스를 식별하는 고유 번호입니다.
    • <IRE 필드 이름> - 애플리케이션 서비스를 식별하는 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    상위 관계를 생성할 상위 애플리케이션 서비스를 식별하는 상세 정보입니다.

    데이터 유형: 객체

    "parent": {
  "<service_app_identifier>": "String",
  "class_name": "String"
}
    상위.<service_app_identifier> 애플리케이션 서비스를 식별하는 정보입니다.
    하나의 옵션만 필요합니다. 각 옵션은 처리 우선 순위에 따라 나열됩니다.
    • sys_id – 애플리케이션 서비스 [cmdb_ci_service_auto]에 나열된 애플리케이션 서비스를 Sys_id.
    • number - 애플리케이션 서비스를 식별하는 고유 번호입니다.
    • <IRE 필드 이름> - 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    parent.class_name 애플리케이션 서비스를 포함하는 클래스의 이름입니다.
    상위 클래스 이름은 다음 테이블 중 하나에서 가져와야 합니다.
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    기본값: cmdb_ci_service_auto

    데이터 유형: 문자열

    헤더

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

    표 34. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 35. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 36. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    상태 성공 또는 실패를 나타냅니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예는 애플리케이션 서비스에서 관계를 만드는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"child\": {
   \"name\": \"wdfsdf\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
   },
  \"parent\": {
   \"sys_id\": \"abcdefg\",
   \"name\": \"business App1\",
   \"class_name\": \"service_offering\"
  }
}" \
--user 'username':'password'

    애플리케이션 서비스 관계가 성공적으로 만들어졌음을 나타내는 결과입니다.

    {
  "result": {
  "status": "success"
  }
}

    SG 서비스 – POST – /sg_services/app_service/relationship/delete

    애플리케이션 서비스 업스트림 관계를 삭제합니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/delete

    기본 URL: /api/sn_service_graph/sg_services/app_service/relationship/delete

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 38. 쿼리 매개변수
    이름 설명
    없음
    표 39. 요청 본문 매개변수(JSON)
    이름 설명
    하위 서비스 애플리케이션에서 삭제할 하위 관계를 설명하는 정보입니다.

    데이터 유형: 객체

    "child": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String"
}
    child.<IRE 필드 이름입니다> 하위 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    child.번호 하위 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    child.sys_id 애플리케이션 서비스 [cmdb_ci_service_auto]에 나열된 하위 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열
    상위 관계를 제거할 상위 애플리케이션 서비스를 식별하는 상세 정보입니다.

    데이터 유형: 객체

    "parent": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String",
  "class_name": "String"
}
    parent.<IRE 필드 이름입니다> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    parent.number 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    parent.sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열
    parent.class_name 애플리케이션 서비스를 포함하는 클래스의 이름입니다.
    상위 클래스 이름은 다음 테이블 중 하나에서 가져와야 합니다.
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    기본값: cmdb_ci_service_auto

    데이터 유형: 문자열

    헤더

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

    표 40. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 41. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 42. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    상태 성공 또는 실패를 나타냅니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예는 애플리케이션 서비스에서 관계를 제거하는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"child\": {
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\"

  },
  \"parent\": {
   \"sys_id\": \"abcdefg\",
   \"name\": \"business App1\",
   \"class_name\": \"service_offering\"
     }
 }" \
--user 'username':'password'

    애플리케이션 서비스 관계가 성공적으로 제거되었음을 나타내는 결과입니다.

    {
  "result": {
  "status": "success"
  }
}

    SG 서비스 – POST – /sg_services/app_service/state

    애플리케이션 서비스 수명주기 상태를 활성화, 비활성화 또는 폐기로 변경합니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/state

    기본 URL: /api/sn_service_graph/sg_services/app_service/state

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 44. 쿼리 매개변수
    이름 설명
    없음
    표 45. 요청 본문 매개변수(JSON)
    이름 설명
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    상태 필수 애플리케이션 서비스의 수명주기 상태입니다. 이러한 값은 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에서 업데이트됩니다.
    유효한 값은 다음과 같습니다.
    • ACTIVATE – 수명 주기가 작동 중이고 사용 중입니다.
      • operational_status=운영
      • life_cycle_stage=운영
      • life_cycle_stage_status=사용 중
    • 비활성화 – 수명 주기가 작동하지 않으며 설계 단계에 있습니다.
      • operational_status=비작동
      • life_cycle_stage=디자인
      • life_cycle_stage_status=빌드
    • RETIRE – 수명 종료.
      • operational_status=폐기됨
      • life_cycle_stage=수명 종료
      • life_cycle_stage_status=폐기됨

    데이터 유형: 문자열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

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

    표 46. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 47. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 48. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    상태 성공 또는 실패를 나타냅니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예는 애플리케이션 서비스 수명 주기 상태를 활성화로 변경하는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/state" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  {
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",
  \"state\": \"activate\"
  }
}" \
--user 'username':'password'

    성공적인 작업을 나타내는 결과입니다.

    {
  "result": {
  "status": "success"
  }
}

    SG 서비스 – POST – /sg_services/app_service/update

    제공된 기존 애플리케이션 서비스를 업데이트하고 지정된 애플리케이션 서비스에 대한 태그를 생성합니다.

    CI를 식별하기 위한 다음 속성이 다음과 같이 우선 순위를 갖습니다.
    1. sys_id – sys_id 경우 시스템은 sys_id만 사용하고 추가 값은 무시합니다.
    2. number – sys_id 없이 제공된 경우 시스템은 숫자만 사용하고 추가 값은 무시합니다.
    3. <IRE 필드 이름> - 시스템은 sys_id 또는 번호가 제공되지 않은 경우에만 이 값을 사용합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_service_graph/{api_version}/sg_services/app_service/update

    기본 URL: /api/sn_service_graph/sg_services/app_service/update

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 50. 요청 본문 매개변수(JSON)
    이름 설명
    <업데이트할 필드 또는 태그입니다> 키-값 쌍을 사용하여 업데이트할 각 필드 또는 태그를 식별합니다.

    기본 정보만 업데이트할 수 있으며 업스트림 관계는 업데이트할 수 없습니다.

    데이터 유형: 문자열
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    sys_id, 번호 또는 IRE를 전송하여 애플리케이션 서비스를 식별할 수 있습니다. 그러나 식별자로 사용할 때는 이러한 필드를 업데이트할 수 없습니다. IRE 필드를 업데이트하려면 입력에 sys_id 또는 번호가 식별자로 포함되어야 합니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

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

    표 51. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 52. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 53. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 사용자에게 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    <IRE 필드 이름> 애플리케이션 서비스를 식별하는 하나 이상의 IRE 필드입니다. 예를 들어 이름 또는 버전입니다.

    데이터 유형: 문자열
    번호 애플리케이션 서비스를 식별하는 고유 번호입니다.

    데이터 유형: 문자열
    sys_id 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 나열된 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열
    <업데이트된 필드> 업데이트가 성공하면 페이로드에 전송된 수정된 각 필드가 응답 본문에 나열됩니다.

    cURL 요청

    다음 예는 이름을 IRE 필드로 사용하여 애플리케이션 서비스를 업데이트하는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  {
   \"name\": \"Test Register\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
  }
}" \
--user 'username':'password'

    응답에는 애플리케이션 서비스 식별 정보 및 업데이트된 필드가 포함됩니다.

    {
  "result": {
  "sys_id": "123456",
  "number": "SVCKji0w9e",
  "name": "Test Register",
  "environment": "Test",
  "version": "1.0"
  }
}