애플리케이션 서비스 API

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기31분
  • 애플리케이션 서비스 API는 애플리케이션 서비스를 생성, 수정 및 업데이트할 수 있는 엔드포인트를 제공합니다.

    이 API를 사용하려면 사용자에게 애플리케이션 서비스 관리자 [app_service_admin] 역할이 있어야 합니다.

    중요사항:
    릴리스부터 Rome애플리케이션 서비스 API는 더 이상 개선되거나 지원되지 않습니다. 자세한 내용은 Now Support 지식베이스에서 사용 중단 프로세스 [KB0867184] 문서를 참조하십시오.

    애플리케이션 서비스 - GET /now/cmdb/app_service/{sys_id}/getContent

    매핑된 애플리케이션 서비스의 CI(구성 항목) 목록과 해당 항목 간의 관계를 검색합니다. 수동으로 생성된 서비스에 대한 컨텐츠만 검색합니다.

    URL 형식

    기본 URL: /api/now/cmdb/app_service/{sys_id}/getContent

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    sys_id 매핑된 애플리케이션 서비스의 Sys_id입니다. 매핑된 애플리케이션 서비스 [cmdb_ci_service_discovered] 테이블에 위치합니다.

    데이터 유형: 문자열

    표 2. 쿼리 매개변수
    이름 설명
    모드 반환할 관계 데이터의 양입니다.
    유효한 값은 다음과 같습니다.
    • 단순: 서비스 내 CI 간의 상위 및 하위 관계를 반환합니다.
    • 전체: 단순 모드로 반환되는 데이터 외에 CI 속성 및 조회 정보를 반환합니다.
    값은 대소문자를 구분하지 않습니다.

    데이터 유형: 문자열

    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

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

    기본값: application/json

    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

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

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

    이름 설명
    cmdb 지정된 애플리케이션 서비스와 연결된 CI를 설명하는 객체 목록입니다.

    데이터 유형: 객체

    "cmdb": [
      {
        "items": {Object},
        "relations": [Array]
      }
    ]
    cmdb.items 애플리케이션 서비스 내의 CI입니다. 전체 쿼리 매개변수가 요청에 전달된 경우 이 섹션에는 각 CI에 대한 속성 및 조회 정보가 포함됩니다.

    데이터 유형: 배열

    "items": [
      {
        "className": "String",
        "values": {Object}
      }
    ]
    cmdb.items.className CI가 포함된 클래스의 이름입니다.

    데이터 유형: 문자열

    cmdb.items.values 연결된 CI를 찾는 데 사용할 정보입니다.

    데이터 유형: 객체

    "values": {
      "name": "String",
      "sys_id": "String"
    }
    cmdb.items.values.name CI의 이름입니다.

    데이터 유형: 문자열

    cmdb.items.values.sys_id CI의 Sys_id입니다.

    데이터 유형: 문자열

    cmdb.relations 호스트 및 그 하위 항목과 같은 연결된 CI에 대한 관계 데이터입니다.

    데이터 유형: 배열

    서비스 식별된 서비스와 관련된 서비스 목록입니다.

    데이터 유형: 배열

    "service": [
      {
        "name": "String",
        "service_relations": [Array],
        "url": "String"
      }
    ]
    service.name 애플리케이션 서비스의 이름입니다.

    데이터 유형: 문자열

    service.service_relations 애플리케이션 서비스 내 CI에 대한 계층 구조 데이터입니다. 모든 CI는 상위 및 하위 CI와 쌍을 이룹니다. 애플리케이션 서비스의 엔트리포인트라고 하는 최상위 CI에는 상위 CI가 없습니다.

    데이터 유형: 배열

    "service_relations": [
      {
        "child": "String",
        "parent": "String"
      }
    ]
    service.service_relations.하위 CI와 관련된 하위 CI의 이름입니다.

    데이터 유형: 문자열

    service.service_relations.parent CI와 관련된 상위 CI의 이름입니다.

    데이터 유형: 문자열

    서비스.url 애플리케이션 서비스의 상대 경로입니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    curl "https://instance.servicenow.com/api/now/cmdb/app_service/2fce42d80a0a0bb4004af34d7e3984c8/getContent?mode=shallow" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'
    {
      "service": {
        "name": "PeopleSoft Portals",
        "url": "/api/now/table/cmdb_ci_service_discovered/2fce42d80a0a0bb4004af34d7e3984c8",
        "service_relations": [
          {
            "parent": "",
            "child": "3a2810c20a0a0bb400268337d6e942ca"
          },
          {
            "parent": "3a27f1520a0a0bb400ecd6ff7afcf036",
            "child": "3a5dd3dbc0a8ce0100655f1ec66ed42c"
          },
          {
            "parent": "3a290cc60a0a0bb400000bdb386af1cf",
            "child": "3a307c930a0a0bb400353965d0b8861f"
          },
          {
            "parent": "3a172e820a0a0bb40034228e9f65f1be",
            "child": "3a27d4370a0a0bb4006316812bf45439"
          },
          {
            "parent": "",
            "child": "3a172e820a0a0bb40034228e9f65f1be"
          },
          {
            "parent": "",
            "child": "3a27f1520a0a0bb400ecd6ff7afcf036"
          },
          {
            "parent": "3a2810c20a0a0bb400268337d6e942ca",
            "child": "3a290cc60a0a0bb400000bdb386af1cf"
          }
        ]
      },
      "cmdb": {
        "relations": [],
        "items": [
          {
            "values": {
              "sys_id": "3a172e820a0a0bb40034228e9f65f1be",
              "name": "PS LoadBal01"
            },
            "className": "cmdb_ci_win_server"
          },
          {
            "values": {
              "sys_id": "3a2810c20a0a0bb400268337d6e942ca",
              "name": "PS Apache03"
            },
            "className": "cmdb_ci_web_server"
          },
          {
            "values": {
              "sys_id": "55b35562c0a8010e01cff22378e0aea9",
              "name": "ny8500-nbxs08"
            },
            "className": "cmdb_ci_netgear"
          },
          {
            "values": {
              "sys_id": "3a27f1520a0a0bb400ecd6ff7afcf036",
              "name": "PS Apache02"
            },
            "className": "cmdb_ci_web_server"
          },
          {
            "values": {
              "sys_id": "3a307c930a0a0bb400353965d0b8861f",
              "name": "PS ORA01"
            },
            "className": "cmdb_ci_database"
          }
        ]
      }
    }

    애플리케이션 서비스 - GET /now/cmdb/csdm/app_service/find_service

    지정된 애플리케이션 서비스 및 관련 비즈니스 컨텍스트에 대한 기본 정보를 반환합니다.

    주:
    이 엔드포인트는 더 이상 사용되지 않으므로 대신 사용하십시오 SG 서비스 – POST – /sg_services/app_service/find .

    URL 형식

    기본 URL: /api/now/cmdb/csdm/app_service/find_service

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    없음
    표 8. 쿼리 매개변수
    이름 설명
    이름 전달되지 않은 경우 number 필수입니다. 정보를 반환할 서비스의 이름입니다. 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 있습니다.

    데이터 유형: 문자열

    번호 전달되지 않은 경우 name 필수입니다. 정보를 반환할 애플리케이션 서비스를 식별하는 고유 번호입니다. 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 있습니다.

    데이터 유형: 문자열

    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

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

    상태 코드

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

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

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

    이름 설명
    오류 발생한 오류에 대해 설명합니다.

    데이터 유형: 객체

    "error": {
      "details": "String",
      "message": "String"
    }
    오류.세부 정보 오류에 대한 추가 정보입니다.

    데이터 유형: 문자열

    오류.메시지 오류를 설명하는 메시지입니다.

    데이터 유형: 문자열

    services 지정된 애플리케이션 서비스와 연결된 서비스의 상세 정보를 포함하는 각 객체의 배열입니다.

    데이터 유형: 배열

    "services": [
      {
        "environment": "String",
        "name": "String",
        "number": "String",
        "relationships": {Object},
        "sys_id": "String",
        "version": "String"
      }
    ]
    서비스.환경 애플리케이션 서비스가 배포되는 환경(예: "프로덕션" 또는 "테스트 랩 2")입니다. 이는 구현자에게 적합한 모든 값이 될 수 있습니다.

    데이터 유형: 문자열

    최대 길이: 40

    기본값: null

    services.name 필수 애플리케이션 서비스의 이름입니다. 다른 모든 애플리케이션 서비스의 고유한 이름이어야 합니다.

    데이터 유형: 문자열

    최대 길이: 255

    서비스.번호 애플리케이션 서비스를 식별하는 고유 번호입니다. 이 값은 처음에 엔드포인트에서 생성됩니다.

    데이터 유형: 문자열

    서비스.관계 애플리케이션 서비스와 연결된 서비스 유형입니다.

    데이터 유형: 객체

    "relationships": {
      "business_app": [Array],
      "business_service_offering": [Array],
      "technical_service_offering": [Array]
    }
    services.relationships.business_app 애플리케이션 서비스와 관련된 비즈니스 애플리케이션의 sys_ids 목록입니다.

    데이터 유형: 배열

    services.relationships.technical_service_offering 애플리케이션 서비스와 관련된 비즈니스 서비스 오퍼링의 sys_ids 목록입니다.

    데이터 유형: 배열

    services.relationships.business_service_offering 애플리케이션 서비스와 관련된 기술 서비스 오퍼링의 sys_ids 목록입니다.

    데이터 유형: 배열

    services.sys_id 애플리케이션 서비스의 Sys_id입니다.

    데이터 유형: 문자열

    서비스.버전 애플리케이션 서비스 버전 번호입니다.

    데이터 유형: 문자열

    최대 길이: 40

    형식: 사용자 정의 가능

    기본값: null

    샘플 cURL 요청

    curl -X GET \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/find_service?name=Email_East&number=SNSVC0001018 \
      -H 'Accept: application/json' \
      -u 'username':'password'
    
    {
    "result": {
      "services": [
        {
          "name": "Email_East",
          "number": "SNSVC0001018",
          "sys_id": "f809cb60db94101037740f95ca96190f",
          "environment": "Production",
          "version": "1.1.1",
          "relationships": {
            "business_app": [
              "658c7620db54101037740f95ca9619f2"
            ],
            "technical_service_offering": [],
            "business_service_offering": [
              "069c7e20db54101037740f95ca9619bf"
            ]
          }
        }
      ]
     }
    }

    애플리케이션 서비스 - POST /now/cmdb/app_service/create

    애플리케이션 서비스를 만들거나 기존 애플리케이션 서비스를 업데이트합니다.

    URL 형식

    기본 URL: /api/now/cmdb/app_service/create

    지원되는 요청 매개변수

    표 13. 매개변수
    매개변수 설명
    없음

    헤더

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

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

    기본값: application/json

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

    기본값: application/json

    표 15. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 16. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.

    요청 본문

    API는 요청 본문에서 이러한 JSON 요소를 허용합니다. 또한 매핑된 애플리케이션 서비스 [cmdb_ci_service_discovered] 테이블의 필드를 추가하여 데이터를 애플리케이션 서비스 기록에 전달할 수 있습니다. 예를 들어 주석 필드에 내용을 추가하려면 JSON 요청에 "comments": "Passing data to the Comments field" 를 추가합니다.

    표 17. 요청 본문에 수락된 요소
    요소 설명
    이름 작성하거나 업데이트하려는 애플리케이션 서비스의 이름입니다.
    service_relations CI와 CI가 형성하는 계층 구조에 대한 정보입니다. 모든 CI는 상위 CI 및 하위 CI와 쌍을 이룹니다. 애플리케이션 서비스의 엔트리포인트라고 하는 최상위 CI에는 상위 CI가 없습니다.
    상위 나가는 연결이 맵 계층 구조의 하위 수준에 있는 CI와 이 CI를 조인하는 CI의 Sys_ ID입니다.
    하위 들어오는 연결이 맵 계층 구조에서 더 높은 수준에 있는 CI와 이 CI를 조인하는 CI의 Sys_ ID입니다.

    응답 본문

    API는 응답 본문에 이러한 JSON 요소를 반환합니다.

    표 18. 응답 본문에 반환된 요소
    요소 설명
    URL 애플리케이션 서비스 기록의 sys_id 표시하기 위한 표준 테이블 REST API의 URL입니다.

    이 요소는 엔드포인트가 성공한 경우에만 나타납니다.

    데이터 유형: 문자열

    getContentUrl 애플리케이션 서비스 컨텐츠를 가져오기 위한 REST API 경로입니다.

    이 요소는 엔드포인트가 성공한 경우에만 나타납니다.

    데이터 유형: 문자열

    정보 애플리케이션 서비스에 추가된 CI 수입니다.

    이 요소는 엔드포인트가 성공한 경우에만 나타납니다.

    데이터 유형: 문자열

    오류 오류 메시지 상세 정보입니다.

    이 요소는 엔드포인트가 실패한 경우에만 나타납니다.

    데이터 유형: 객체

    메시지 실패의 특성을 설명하는 오류 메시지입니다.

    이 요소는 엔드포인트가 실패한 경우에만 나타납니다.

    데이터 유형: 문자열

    상태 REST API가 실패하면 "실패"로 표시됩니다.

    이 요소는 엔드포인트가 실패한 경우에만 나타납니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    curl "http://<instance.servicenow.com>/api/now/cmdb/app_service/create" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
    \"name\": \"myTestAppService\",
    \"comments\": \"Passing data to the Comments field\",
    \"service_relations\": [
    { \"parent\": \"\",
    \"child\": \"3a70f789c0a8ce010091b0ea635b982a\"
    },{ \"parent\": \"3a70f789c0a8ce010091b0ea635b982a\",
    \"child\": \"b4fd7c8437201000deeabfc8bcbe5dc1\"
    },{ \"parent\": \"b4fd7c8437201000deeabfc8bcbe5dc1\",
    \"child\": \"53fdbc8437201000deeabfc8bcbe5d10\"
    }
    ]
    }" \
    --user 'admin':'admin'
    {
      "result": {
        "url": "/api/now/table/cmdb_ci_service_discovered/b1cff89fc9e19300964fcbb1ac3059a5",
        "getContentUrl": "/api/now/cmdb/app_service/b1cff89fc9e19300964fcbb1ac3059a5/getContent",
        "info": "3 CIs added to service"
      }
    }

    애플리케이션 서비스 - POST /now/cmdb/csdm/app_service/register_service

    애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 애플리케이션 서비스 기록 스텁을 생성하고 전달된 정보로 채웁니다.

    기록을 저장하기 전에 전달된 매개변수와 애플리케이션 서비스 이름의 고유성을 확인합니다. 또한 지정된 비즈니스 애플리케이션, 비즈니스 서비스 오퍼링 및 기술 서비스 오퍼링을 서비스 애플리케이션에 연결하여 서비스에 비즈니스 컨텍스트를 제공하는 업스트림 관계를 생성합니다. 인프라에 대한 다운스트림 관계는 생성하지 않습니다. 다운스트림 관계를 정의하려면 애플리케이션 서비스 - PUT /now/cmdb/csdm/app_service/{service_sys_id}/populate_service 엔드포인트를 호출해야 합니다.
    주:
    이 엔드포인트는 더 이상 사용되지 않으므로 대신 사용하십시오 SG 서비스 – POST – /sg_services/app_service/register .

    URL 형식

    기본 URL: /api/now/cmdb/csdm/app_service/register_service

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    없음
    표 20. 쿼리 매개변수
    이름 설명
    없음
    표 21. 요청 본문 매개변수
    이름 설명
    basic_details 필수 지정된 애플리케이션 서비스와 연결된 서비스의 상세 정보입니다.

    데이터 유형: 객체

    "basic_details": {
      "environment": "String",
      "name": "String",
      "version": "String"
    }
    basic_details.환경 애플리케이션 서비스가 배포되는 환경(예: "프로덕션" 또는 "테스트 랩 2")입니다. 이는 구현자에게 적합한 모든 값이 될 수 있습니다.

    데이터 유형: 문자열

    최대 길이: 40

    기본값: null

    basic_details.이름 필수 애플리케이션 서비스의 이름입니다. 다른 모든 애플리케이션 서비스의 고유한 이름이어야 합니다.

    데이터 유형: 문자열

    최대 길이: 255

    basic_details.버전 애플리케이션 서비스 버전 번호입니다.

    데이터 유형: 문자열

    최대 길이: 40

    형식: 사용자 정의 가능

    기본값: null

    관계 애플리케이션 서비스와 연결할 업스트림(상위) 서비스 유형입니다. 이러한 관계는 CI 관계 [cmdb_rel_ci] 테이블에 저장됩니다.

    데이터 유형: 객체

    "relationships": {
      "business_app": [Array],
      "business_service_offering": [Array],
      "technical_service_offering": [Array]
    }
    relationships.business_app 애플리케이션 서비스와 관련된 비즈니스 애플리케이션의 sys_ids 목록입니다.

    데이터 유형: 배열

    relationships.business_service_offering 애플리케이션 서비스와 관련된 비즈니스 서비스 오퍼링의 sys_ids 목록입니다.

    데이터 유형: 배열

    relationships.technical_service_offering 애플리케이션 서비스와 관련된 기술 서비스 오퍼링의 sys_ids 목록입니다.

    데이터 유형: 배열

    헤더

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

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

    상태 코드

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

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

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

    이름 설명
    오류 발생한 오류에 대해 설명합니다.

    데이터 유형: 객체

    "error": {
      "details": "String",
      "message": "String"
    }
    오류.세부 정보 오류에 대한 추가 정보입니다.

    데이터 유형: 문자열

    오류.메시지 오류를 설명하는 메시지입니다.

    데이터 유형: 문자열

    번호 애플리케이션 서비스를 식별하는 고유 번호입니다. 이 번호는 엔드포인트에서 생성됩니다.
    service_sys_id 등록된 애플리케이션 서비스의 Sys_id입니다.

    샘플 cURL 요청

    curl -X POST \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/register_service \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password'
      -d '{
      "basic_details": {
        "environment": "Test Lab 2",
        "name": "Test Lab 2",
        "version": "1.1.1"
      },
      "relationships": {
        "business_app":["f07c7620db54101037740f95ca96199a"],
        "business_service_offering":["069c7e20db54101037740f95ca9619bf"]
      }
    }'
    {
      "result": {
        "service_sys_id": "80f21bbadbd410103d3a93c3e296199a",
        "number": "SNSVC0001018    
        }
    }

    애플리케이션 서비스 - PUT /now/cmdb/csdm/app_service/{service_sys_id}/populate_service

    지정된 다운스트림 CI(구성 항목) 세트로 지정된 애플리케이션 서비스를 채웁니다.

    이 엔드포인트를 호출하기 전에 POST /now/cmdb/csdm/app_service/register_service 엔드포인트를 호출하여 애플리케이션 서비스를 생성해야 합니다.
    주:
    이 엔드포인트는 더 이상 사용되지 않으므로 대신 사용하십시오 SG 서비스 – POST – /sg_services/app_service/populate .

    URL 형식

    기본 URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/populate_service

    지원되는 요청 매개변수

    표 25. 경로 매개변수
    이름 설명
    service_sys_id 지정된 CI로 채울 애플리케이션 서비스의 Sys_id입니다. 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 있습니다.

    데이터 유형: 문자열

    표 26. 쿼리 매개변수
    이름 설명
    없음
    표 27. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    population_method 지정된 애플리케이션 서비스와 연결할 CI입니다. 개체의 요소는 populate_method 채워지는 정보의 형식(매개 변수에 의해 정의됨)에 type 따라 달라집니다.

    데이터 유형: 객체

    = type cmdb_group_based

    {
      "population_method": {
        "group_id": "String",
        "type": "String"
      }
    }
    = discovery에 대해 type
    주:
    이 유형을 사용하려면 서비스 매핑(com.snc.service-mapping) 플러그인을 활성화해야 합니다.
    {
      "population_method": {
        "attributes": [Array],
        "entry_point_id": "String",
        "type":"String"
      }
    }
    = type tag_list
    주:
    이 유형을 사용하려면 서비스 매핑(com.snc.service-mapping) 플러그인을 활성화해야 합니다.
    {
      "population_method": {
        "tags":[Array],
        "type":"String"  }
    }
    population_method.attributes 호스트, 포트, 이름 및 URL과 같이 CI와 연결할 속성 목록입니다.

    엔트리포인트에 대한 자세한 내용은 엔트리포인트 속성을 참조하세요.

    주:
    모든 필수 속성을 전달해야 합니다.

    데이터 유형: 배열

    {
      "attributes": {
        "name":"String",
        "value":"String"
      }
    }
    population_method.attributes.name 속성의 이름(예: 호스트, 포트, 이름 및 URL)입니다.

    데이터 유형: 문자열

    population_method.속성.값 속성 값입니다.

    데이터 유형: 문자열

    population_method.entry_point = discovery인 경우 population_method.type 필수입니다. 애플리케이션 서비스의 엔트리포인트입니다. 엔트리포인트에 대한 자세한 내용은 엔트리포인트 속성서비스 매핑에 대한 엔트리포인트 유형 생성을 참조하십시오.

    데이터 유형: 문자열

    population_method.group_id입니다. = cmdb_group_based인 경우 population_method.type 필수입니다. CI와 연결할 그룹의 Sys_id입니다. CMDB 그룹 [cmdb_group] 테이블에 있습니다.

    데이터 유형: 문자열

    population_method.태그 CI와 연결할 태그의 목록입니다. 이 정보는 키 값 [cmdb_key_value] 테이블에 있습니다.

    데이터 유형: 배열

    {
      "tags": {
        "tag": "String",
        "value": "String"
      }
    }
    population_method.tags.tag 태그의 이름입니다.

    데이터 유형: 문자열

    population_method.tags.value 태그 값입니다.

    데이터 유형: 문자열

    population_method.type 필수 채울 CI의 유형입니다.
    유효한 값은 다음과 같습니다.
    • cmdb_group_based
    • 검색
    • tag_list

    데이터 유형: 문자열

    헤더

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

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

    상태 코드

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

    표 30. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 올바르지 않거나 app_service_admin 역할이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다.

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

    이름 설명
    오류 발생한 오류에 대해 설명합니다.

    데이터 유형: 객체

    "error": {
      "details": "String",
      "message": "String"
    }
    오류.세부 정보 오류에 대한 추가 정보입니다.

    데이터 유형: 문자열

    오류.메시지 오류를 설명하는 메시지입니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    다음 코드 예는 CI 유형이 cmdb_group_based일 때 애플리케이션 서비스를 채우는 방법을 보여줍니다.

    curl -X PUT \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
      "population_method": {
        "type":"cmdb_group_based",
        "group_id": "e809cf60db94101037640f95ca961932"
      }
    }'
    {
        "result": {}
    }

    다음 코드 예제에서는 검색 애플리케이션 서비스를 채우는 방법을 보여 줍니다.

    curl -X PUT \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
      "population_method": {
        "type":"discovery",
        "entry_point_id":"cmdb_ci_endpoint_ad_forest",
        "attributes": [
          {
            "name":"host",
            "value":"test1.com"
          },
          {
            "name":"port",
            "value":"500"
          },
          {
            "name":"protocol",
            "value":"ssh"
          }
        ]
      }
    }'
    {
        "result": {}
    }

    애플리케이션 서비스 - PUT /now/cmdb/csdm/app_service/{service_sys_id}/service_details

    지정된 애플리케이션 서비스를 전달된 기본 정보로 업데이트합니다.

    또한 애플리케이션 서비스 클래스에 정의된 IRE(식별 및 조정 엔진) 규칙에 대해 전달된 정보를 확인하여 애플리케이션 서비스의 고유성을 확인합니다.
    주:
    이 엔드포인트는 더 이상 사용되지 않으므로 대신 사용하십시오 SG 서비스 – POST – /sg_services/app_service/update .

    URL 형식

    기본 URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/service_details

    지원되는 요청 매개변수

    표 31. 경로 매개변수
    이름 설명
    service_sys_id 업데이트할 애플리케이션 서비스의 Sys_id입니다. 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 있습니다.

    데이터 유형: 문자열

    표 32. 쿼리 매개변수
    이름 설명
    없음
    표 33. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    basic_details 지정된 애플리케이션 서비스와 연결된 서비스의 상세 정보입니다.

    데이터 유형: 객체

    "basic_details": {
      "environment": "String",
      "name": "String"
    }
    basic_details.환경 애플리케이션 서비스가 배포되는 환경(예: "프로덕션" 또는 "테스트 랩 2")입니다. 이는 구현자에게 적합한 모든 값이 될 수 있습니다.

    데이터 유형: 문자열

    최대 길이: 40

    기본값: null

    basic_details.이름 필수 애플리케이션 서비스의 이름입니다. 다른 모든 애플리케이션 서비스의 고유한 이름이어야 합니다.

    데이터 유형: 문자열

    최대 길이: 255

    관계 애플리케이션 서비스와 연결할 서비스 유형입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다.

    데이터 유형: 객체

    "relationships": {
      "business_app": [Array],
      "business_service_offering": [Array],
      "technical_service_offering": [Array]
    }
    relationships.business_app 애플리케이션 서비스와 관련된 비즈니스 애플리케이션의 sys_ids 목록입니다.

    데이터 유형: 배열

    relationships.business_service_offering 애플리케이션 서비스와 관련된 비즈니스 서비스 오퍼링의 sys_ids 목록입니다.

    데이터 유형: 배열

    relationships.technical_service_offering 애플리케이션 서비스와 관련된 기술 서비스 오퍼링의 sys_ids 목록입니다.

    데이터 유형: 배열

    헤더

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

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

    상태 코드

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

    표 36. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 올바르지 않거나 app_service_admin 역할이 없습니다.

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

    이름 설명
    오류 발생한 오류에 대해 설명합니다.

    데이터 유형: 객체

    "error": {
      "details": "String",
      "message": "String"
    }
    오류.세부 정보 오류에 대한 추가 정보입니다.

    데이터 유형: 문자열

    오류.메시지 오류를 설명하는 메시지입니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    curl -X PUT \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/service_details \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
      "basic_details": {
        "environment": "Test Lab 2"
      },  "relationships": {
        "business_app" :["f07c7620db54101037740f95ca96199a"]
      }
    }'
    {
        "result": {}
    }