자체 정정 API

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기6분

    • Next Experience 문제를 생성하거나 관리하기 위한 엔드포인트를 제공합니다.

    자체 정정 API는 사용자 지정 스크립트된 REST API로 사용할 수 있습니다. 이 API에는 Self-Remediation-Framework(self-remediation-framework) 플러그인과 sn_srf.experience_issue_create 역할이 필요합니다.

    모든 DEX/DEM 공급자는 자체 수정 API를 사용하여 사용자의 엔드포인트에서 문제를 감지할 때 환경 문제를 만들 수 있습니다. 생성된 경험 문제는 사용자와의 참여를 유도하고 사용자가 문제를 스스로 해결하는 데 도움이 됩니다. 자체 교정 API는 내부 또는 외부 DEM/DEX 제공자가 사용할 수 있습니다.

    이 API를 사용하려면 다음 테이블이 기록으로 채워져 있는지 확인하십시오.

    • sn_srf_issue_registry_template
    • sn_srf_issue_registry
    • sn_srf_resolution
    • sn_srf_notification_content
    • sn_srf_provider

    자체 정정 - CREATE /sn_srf/self_remediation/experience_issue/create

    DEM/DEX 공급자가 사용자의 엔드포인트에서 문제를 감지할 때 공급자가 환경 문제를 만들 수 있습니다.

    URL 형식

    기본 URL: / api/sn_srf/self_remediation/experience_issue/create

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    엔드포인트 필수 이 endpoint 개체는 키를 사용하여 사용자 및 CI(구성 항목) 정보를 감지하는 경험 문제에 대한 세부 정보를 지정합니다. 프레임워크가 사용자를 식별할 수 있도록 하나 이상의 키를 전달합니다. 잘못된 키는 오류를 반환합니다.

    데이터 유형: 객체

    
--data “{
  "endpoint": {
    "CI": "String",
    "user_id": "String",
    "user_name": "String",
    "email": "String"
  },
    endpoint.user_id 옵션입니다. 문제가 탐지된 사용자의 Sys_id입니다.

    데이터 유형: 문자열
    endpoint.user_name 옵션입니다. 문제가 검색된 사용자의 사용자 이름입니다.

    데이터 유형: 문자열
    endpoint.email 옵션입니다. 문제가 검색된 사용자의 이메일입니다.

    데이터 유형: 문자열
    endpoint.CI 선택 사항입니다. 문제가 탐지된 CI(장치)의 Sys_id입니다.

    데이터 유형: 문자열
    issue_code 필수 문제가 고유하게 발생했는지 식별합니다. 문제 코드가 사용 가능해야 하며 고객의 인스턴스에 배포되어야 합니다. 비어 있거나 잘못된 문제가 제공되면 매개 변수는 오류를 반환합니다.

    데이터 유형: 문자열
    제공자 필수 제공자의 고유 코드입니다. 이 코드는 고객의 인스턴스와 sn_srf_provider 일치해야 provider_code 합니다.

    데이터 유형: 문자열
    input_parameters 옵션입니다. 전송된 입력 매개변수는 구성된 해결(예: 하위 플로우, 플로우 작업 또는 CI 작업)로 전달됩니다.

    데이터 유형: 객체

    "input_parameters": {
    "process_id": "Number"
  }
    investigative_details 옵션입니다. PUE(전력 사용 효율성) 해결이 실패할 경우 수동 조사에 유용할 수 있는 세부 정보를 지정합니다. 조사 상세 정보는 PUE 해결이 실패할 경우 폴백으로 생성되는 인시던트로 복사됩니다.

    데이터 유형: 객체

    "investigative_details": {
    "cpu usage": "String",
    "processes running": "String",
    "available memory": "String"
  }
    experience_id 옵션입니다. 제공자가 특정 experience_id(sys_id 아님)로 환경 문제를 생성하려는 경우 요청에 이를 보냅니다. 이는 경험 문제 체인 케이스에서 추가 추적에 사용할 수 있습니다.

    데이터 유형: 숫자

    헤더

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

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

    기본값: application/json
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    상태 코드 설명
    200 환경 문제가 성공적으로 생성되었습니다. experience_Id 반환합니다.
    400 잘못된 요청입니다. 엔드포인트 상세 정보를 제공하십시오.

    요청에 빈 endpoint 객체가 전송되었습니다.
    400 잘못된 문제 코드입니다. 올바른 문제 코드를 제공하십시오.

    요청에 빈 issue_code 항목이 전송됩니다.
    400 잘못된 제공자입니다. 올바른 제공자를 제공하십시오.

    요청에 빈 공급자가 전송됩니다.
    400 잘못된 문제 코드 또는 제공자입니다. 올바른 상세 정보를 제공하십시오.

    고객 인스턴스에서 문제를 탐지할 수 없습니다. 확인 issue_code 및 provider 세부 정보.
    400 문제 코드에 적절한 해결 방법이 없습니다.

    식별된 문제에 대해 PUE 프레임워크에 유효한 해결 방법이 구성되어 있지 않습니다.
    400 엔드포인트 상세 정보에서 사용자를 확인할 수 없습니다. 올바른 상세 정보를 제공하십시오.

    PUE 프레임워크 ID가 지정된 엔드포인트 세부 정보에서 사용자를 식별할 수 없는 경우 이 오류가 반환됩니다.
    400 지정된 사용자에게 주어진 문제 코드로 환경 문제를 해결하고 있습니다.

    지정된 환경 문제가 현재 진행 중 또는 오픈 상태입니다.
    400 주어진 experience_id 기존 경험 문제가 아직 실행 중이거나 종결되었습니다.

    이 오류는 환경 문제가 연결 시나리오에 있을 때 발생합니다(예: 새 issue_code 키가 기존 experience_id 키와 함께 전송되고 이전 환경 문제가 여전히 실행 중이거나 닫힌 상태인 경우).

    이전 experience_id 사용하여 새 issue_code 보내려면 이 experience_id의 환경 문제가 action_wait 상태여야 합니다.
    400 환경 문제를 생성하는 동안 오류가 발생했습니다.

    이는 기술적 오류를 나타냅니다.

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

    이름 설명
    experienceId 생성된 경험 문제의 경험 ID 번호입니다.

    cURL 요청

    다음 예제에서는 사용자 Abel Tuter에 대한 환경 문제를 만듭니다.

    curl  "http://instance.servicenow.com//api/sn_srf/self_remediation/experience_issue/create" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
--data “{
  "endpoint": {
    "CI": "d049b28e936aa1106f98f6db5cba10d5",
    "user_id": "62826bf03710200044e0bfc8bcbe5df1",
    "user_name": "abel.tuter",
    "email": ""
  },
  "issue_code": "100",
  "provider": "sn",
  "experience_id": "09ed4830f393739df33",
  "input_parameters": {
    "process_id": "10644"
  },
  "investigative_details": {
    "cpu usage": "78%",
    "processes running": "35",
    "available memory": "23%"
  }
}”\

    응답 본문은 문제 생성이 성공했음을 나타내는 경험 ID를 반환합니다.

    { 
  "result": { 
    "experience_id": “xxxxxxxxxxxxxx”
  } 
}