REST 단계

외부 시스템에 아웃바운드 REST 웹 서비스 요청을 보냅니다.

주:

REST 단계 는 기본 시스템에서 사용할 수 없으며 구독이 ServiceNow® 통합 허브 필요합니다. 필요한 플러그인이 활성화되면 통합 아래에 단계가 표시됩니다.

아웃바운드 REST 웹 서비스는 REST 아키텍처를 지원하는 웹 서비스 서버에서 데이터를 검색, 생성, 업데이트 또는 삭제할 수 있는 플랫폼 기능입니다.

역할 및 가용성

작업 단계로 워크플로우 스튜디오 사용할 수 있습니다. action_designer 역할을 가진 사용자는 하나 이상의 작업 단계로 사용자 지정 작업을 생성할 수 있습니다.

필드

필드	설명
연결	사용할 연결의 유형입니다. 연결 인라인 정의: 동작 단계 내에서 연결 정보를 정의합니다. 연결 별칭 사용: 연결 별칭 테이블을 사용하여 연결 정보를 정의합니다. 별칭을 사용하면 여러 환경에서 작업을 사용할 때 여러 자격 증명과 연결 정보 프로필을 구성하지 않아도 됩니다. 마찬가지로 연결 정보가 변경되면 사용자 지정 동작을 업데이트할 필요가 없습니다. 연결 및 자격 증명에 대한 자세한 내용은 자격 증명, 연결 및 별칭 소개를 참조하세요.
연결 별칭	시스템에서 작업 단계를 실행하는 데 사용하는 연결 및 자격 증명 별칭 기록입니다. flow_designer 또는 관리자 역할을 가진 사용자는 연결된 연결 기록을 만들거나 선택할 수 있습니다. 별칭을 사용하면 여러 환경에서 작업을 사용할 때 여러 자격 증명과 연결 정보 프로필을 구성하지 않아도 됩니다. 마찬가지로 연결 정보가 변경되면 사용자 지정 동작을 업데이트할 필요가 없습니다. 연결 및 자격 증명에 대한 자세한 내용은 자격 증명, 연결 및 별칭 섹션을 참조하세요. 자격 증명 값은 데이터 패널에 암호(2단계 암호화됨) 데이터 알약으로 표시됩니다. 주: 이 필드는 연결 목록에서 연결 별칭 사용을 선택한 경우에 사용할 수 있습니다.
자격 증명 별칭	시스템에서 작업 단계를 실행하는 데 사용하는 자격 증명 별칭입니다. flow_designer 또는 관리자 역할을 가진 사용자는 연결된 연결 기록을 만들거나 선택할 수 있습니다. 별칭을 사용하면 여러 환경에서 작업을 사용할 때 여러 자격 증명을 구성하지 않아도 됩니다. 마찬가지로 자격 증명 정보가 변경되면 사용자 지정 작업을 업데이트할 필요가 없습니다. 연결 및 자격 증명에 대한 자세한 내용은 자격 증명, 연결 및 별칭 섹션을 참조하세요. 자격 증명 값은 데이터 패널에 암호(2단계 암호화됨) 데이터 알약으로 표시됩니다. 주: 이 필드는 연결 목록에서 연결 인라인 정의(Define Connection Inline )를 선택한 경우에 사용할 수 있습니다.
MID 사용	를 ServiceNow® MID 서버 사용하여 .REST 단계 이 확인란을 선택하여 MID 애플리케이션 및 기능 필드를 표시합니다. 주: 시스템은 아웃바운드 웹 서비스 로깅 이 발생하는 방식과 같은 방식으로 MID 서버를 통해 전송되는 REST 요청, 응답 및 매개변수 런타임 데이터를 기록하지 않습니다. 대신 플로우 실행 상세 정보에서 이 데이터를 볼 수 있습니다.
기본 URL	REST 요청의 기본 URL입니다. 연결 별칭 사용을 선택하면 이 필드에 별칭과 연결된 기본 URL이 표시됩니다. 잠금 아이콘( )을 클릭하고 직접 입력하여 기본 URL을 재정의할 수 있습니다. 연결 인라인 정의를 선택한 경우 연결의 기본 URL을 입력합니다.
테스트 REST 단계	REST 단계를 테스트하는 버튼입니다. 테스트하려면 REST 단계 테스트 단추를 선택합니다. 필요한 입력 값을 입력하고 테스트 실행 버튼을 선택합니다. 테스트가 실행된 후 모든 단계 출력 또는 오류 메시지가 테스트 창의 테스트 결과 섹션에 표시됩니다.
연결 시간 제한	호스트가 성공적으로 연결되기까지 시스템에서 기다리는 시간(밀리초)입니다. 이 시간 동안 단계에서 연결에 성공하지 못하면 연결 요청이 시간 초과됩니다. 연결 인라인 정의를 선택한 경우 연결에 대한 시간 제한 값을 입력합니다. 시스템 기본 연결 시간 제한 값을 사용하려면 이 필드를 비워두십시오. 주: 연결 시간 제한 값을 0으로 설정하면 연결이 부실해질 수 있으므로 0으로 설정하지 마십시오.
MID 선택	특정 MID 서버 또는 MID 클러스터를 선택하는 옵션입니다. 다음 옵션 중 하나를 선택합니다. MID 서버 자동 선택: ServiceNow 인스턴스에서 수동 입력 없이 MID MID 서버 서버를 선택합니다. 특정 MID 서버: 인스턴스에서 ServiceNow 지정한 것을 사용합니다 MID 서버 . 특정 MID 클러스터: 인스턴스는 ServiceNow 지정한 MID 클러스터를 사용합니다. MID 클러스터는 인스턴스에서 ServiceNow 여러 통합을 처리하고 통합 속도를 개선할 수 있는 MID Server 그룹입니다. 자세한 내용은 Configure a MID Server cluster 문서를 참조하십시오. 이 필드는 연결 목록에서 연결 인라인 정의 를 선택하고 MID 사용 이 선택된 경우에 사용할 수 있습니다.
MID 애플리케이션	선택 자격을 갖추기 위해 지원해야 하는 MID 서버 역량입니다. 시스템은 선택한 기능을 지원하는 작업 MID 서버 단계를 실행합니다. 이 필드는 연결 목록에서 연결 인라인 정의 가 선택되고 MID 사용 확인란이 활성화되며 MID 선택 목록에서 MID 서버 자동 선택이 선택된 경우에 사용할 수 있습니다.
역량	선택 자격을 갖추기 위해 지원해야 하는 MID 서버 역량입니다. 시스템은 선택한 기능을 지원하는 작업 MID 서버 단계를 실행합니다. 이 필드는 연결 목록에서 연결 인라인 정의 가 선택되고 MID 사용 확인란이 활성화되며 MID 선택 목록에서 MID 서버 자동 선택이 선택된 경우에 사용할 수 있습니다.
MID 서버	필요한 MID 서버데이터 정제 . 이 필드는 연결 목록에서 연결 인라인 정의 가 선택되고 MID 사용 확인란이 활성화되며 MID 선택 목록에서 특정 MID 서버를 선택한 경우에 사용할 수 있습니다.
MID 클러스터	사용하려는 MID 클러스터에 대한 데이터 정제입니다. 이 필드는 연결 목록에서 연결 인라인 정의 를 선택하고 MID 사용 을 선택한 후 MID 선택 목록에서 특정 MID 클러스터를 선택한 경우에 사용할 수 있습니다.
빌드 요청	요청을 수동으로 만들거나, OpenAPI 사양을 가져오거나, REST 메시지를 임포트하는 옵션입니다. 수동으로: 작업 입력을 생성하고 REST 단계 양식을 수동으로 작성합니다. OpenAPI 사양에서: OpenAPI 사양을 임포트하여 작업 입력을 생성하고 REST 단계 양식을 작성합니다. 자세한 내용은 REST 단계에서 OpenAPI 지원을 참조하십시오. REST 메시지에서: 플랫폼 REST 메시지를 임포트합니다. 자세한 정보는 REST 메시지를 REST 단계로 임포트을 참조하십시오.
API 소스	요청을 구성하는 데 사용되는 OpenAPI 사양을 선택하거나 OpenAPI 임포트 를 선택하여 새 OpenAPI 사양을 임포트하는 옵션입니다. YAML 또는 JSON에 대한 URL을 제공하거나 컨텐츠를 복사하여 붙여넣어 사양을 임포트할 수 있습니다. 주: 이 필드는 빌드 요청 목록에서 OpenAPI 사양에서 를 선택할 때 사용할 수 있습니다.
API 작업	목록에서 작업을 선택하는 옵션입니다. 사용 가능한 작업은 API 소스 필드의 OpenAPI 사양에 의해 제공됩니다. 주: 이 필드는 빌드 요청 목록에서 OpenAPI 사양에서 를 선택할 때 사용할 수 있습니다.
REST 메시지	임포트할 REST 메시지의 이름입니다. 목록에서 REST 메시지를 선택합니다. 주: 빌드 요청 목록에서 REST 메시지에서를 선택하면 이 필드를 사용할 수 있습니다.
REST 메시지 함수	REST 메시지에서 임포트할 기능의 이름입니다. 사용 가능한 옵션은 선택한 REST 메시지와 연결된 HTTP 메서드에 따라 결정됩니다. 주: 빌드 요청 목록에서 REST 메시지에서를 선택하면 이 필드를 사용할 수 있습니다.
REST 메시지 임포트	REST 메시지를 임포트하는 버튼입니다. 주: 이 필드는 REST 메시지 필드에서 REST 메시지를 선택할 때 사용할 수 있습니다.
자원 경로	자원의 경로입니다.
HTTP 메서드	요청을 처리하는 데 사용되는 HTTP 메서드입니다. 가져오기 POST PUT 패치 DELETE
쿼리 매개 변수	REST 엔드포인트에 전달할 이름-값 쌍입니다. 이러한 매개변수를 수동으로 생성하거나 입력 변수를 매개변수 필드로 끌어온 다음 값을 할당할 수 있습니다. 중복된 쿼리 매개변수 이름이 포함된 REST 단계 요청을 지원합니다. 중복된 쿼리 매개변수 이름이 워크플로우 스튜디오 포함된 REST 요청을 생성하는 경우 정의한 순서와 동일한 순서로 요청에 쿼리 매개변수를 추가합니다. 주: OpenAPI 사양을 임포트할 때, 시스템은 사양에 있는 모든 매개변수와 헤더를 REST 단계에 추가합니다. 마지막 REST 단계 값을 검토하고 요청에서 보내지 않으려는 매개변수를 제거합니다. 예를 들어, API가 JSON과 XML에 대한 컨텐츠 유형 헤더를 허용하는 경우 시스템은 두 헤더를 모두 REST 단계에 추가합니다. 응답에서 수신하려는 컨텐츠 유형에 따라 헤더 중 하나를 제거하십시오.
머리글	요청과 함께 전송할 헤더입니다. 헤더를 수동으로 생성하거나 입력 변수를 매개변수 필드로 끌어온 다음 값을 할당할 수 있습니다. 중복 요청 헤더가 포함된 REST 단계 요청을 지원합니다. 중복 요청 헤더가 포함된 REST 요청을 만들면 헤더는 정의한 순서와 동일한 순서로 전송됩니다. 주: OpenAPI 사양을 임포트할 때, 시스템은 사양에 있는 모든 매개변수와 헤더를 REST 단계에 추가합니다. 마지막 REST 단계 값을 검토하고 요청에서 보내지 않으려는 매개변수를 제거합니다. 예를 들어, API가 JSON과 XML에 대한 컨텐츠 유형 헤더를 허용하는 경우 시스템은 두 헤더를 모두 REST 단계에 추가합니다. 응답에서 수신하려는 컨텐츠 유형에 따라 헤더 중 하나를 제거하십시오.
요청 유형	요청의 형식입니다. 옵션은 다음과 같습니다. 텍스트: JSON, XML 또는 기타 텍스트 형식의 요청입니다. 이진수: 바이너리 파일 형식의 요청입니다. 멀티파트: 여러 컨텐츠 유형으로 구성된 요청입니다. URL 인코딩 양식: URL로 인코딩된 쿼리의 요청입니다. 주: HTTP 메서드가POST, PUT이나 PATCH 또는 DELETE이면 이 필드를 편집할 수 있습니다.
요청 본문 [텍스트]	JSON 또는 XML 형식의 요청 본문입니다. 플로우 실행 상세 정보는 응답 본문을 포함된 텍스트 뷰어에 대한 링크 또는 응답이 포함된 첨부 파일 기록의 sys_id으로 표시합니다. 주: 요청 유형 목록에서 텍스트를 선택하면 이 필드를 편집할 수 있습니다.
첨부 파일	요청을 포함하는 첨부 파일 기록입니다. 이전 단계에서 이 기록을 조회하거나 작성하고 입력 변수로 정의할 수 있습니다. 스크립트 단계에서 JSONStreamingBuilder 및 XMLStreamingBuilder API를 사용하여 생성합니다. 주: 이 필드는 요청 유형 목록에서 이진을 선택할 때 사용할 수 있습니다.
이름, 파트 유형, 값	멀티파트 요청의 컨텐츠입니다. 각 부품에 대해 필드를 개별적으로 사용하거나 모든 부품에 대해 인라인 스크립트를 사용하여 이름, 부품 유형 및 값을 지정합니다. 스크립팅 전환 아이콘( )을 클릭하고 스크립트를 편집하여 다중 파트 값을 지정할 수 있습니다. 인라인 스크립팅에 대한 자세한 내용은 다음 문서를 참조하십시오 인라인 스크립트. 이름: 파트의 이름입니다. 유효한 문자열이 될 수 있습니다. 파트 유형: 파트의 유형입니다. 텍스트 또는 파일을 선택합니다. 텍스트: 파트의 텍스트입니다. 텍스트를 선택한 후에는 콘텐츠 유형을 지정할 수 있습니다. 파일:파트의 파일입니다. 파일을 선택한 경우 값은 컨텐츠를 포함하는 첨부 파일 기록의 sys_id여야 합니다. 이전 단계에서 이 기록을 조회하거나 입력 값으로 정의할 수 있습니다. 파일을 선택한 후에는 파일 이름과 콘텐츠 유형을 지정할 수 있습니다. [파일 이름 설정]에서 [첨부 파일로부터]를 선택하여 첨부된 기록의 파일 이름을 사용하거나 [파일 이름 입력에서]를 선택하여 직접 입력합니다. 콘텐츠 유형 설정의 경우 첨부 파일에서를 선택하여 첨부된 기록의 콘텐츠 유형을 사용하거나 콘텐츠 유형 입력에서를 선택하여 직접 입력합니다. 값: 파트의 컨텐츠입니다. 텍스트의 경우 값은 텍스트 컨텐츠입니다. 파일의 경우 이 값은 컨텐츠를 포함하는 첨부 파일 기록의 sys_id입니다. 주: 이러한 필드는 요청 유형 목록에서 멀티파트 를 선택할 때 사용할 수 있습니다.
이름, 값	양식의 컨텐츠 URL로 인코딩된 요청입니다. URL 인코딩 요청의 각 부분을 이름-값 쌍으로 지정하거나, 필드를 개별적으로 사용하거나 모든 부분에 대해 인라인 스크립트를 사용합니다. 스크립팅 전환 아이콘(인라인 )을 클릭하고 스크립트를 편집하여 양식 URL로 인코딩된 값 인라인 스크립트를 지정할 수 있습니다. 인라인 스크립팅에 대한 자세한 내용은 다음 문서를 참조하십시오 인라인 스크립트. 주: 이 필드는 요청 유형 목록에서 URL 인코딩 양식을 선택한 경우에 사용할 수 있습니다.
재시도 정책 사용	재시도 정책을 활성화하는 옵션입니다. 자세한 내용은 재시도 정책을 참조하십시오.
별칭에 대한 기본 정책 무효화	기본 재시도 정책을 무효화하는 옵션입니다. 연결 목록에서 연결 인라인 정의를 선택한 경우에는 이 확인란을 적용할 수 없습니다.
재시도 정책	연결 별칭에 연결된 기본 재시도 정책입니다. 별칭에 대한 기본 정책 무효화를 선택한 경우 기본 재시도 정책을 무효화하고 필요에 따라 다른 기존 재시도 정책을 선택할 수 있습니다.
첨부 파일로 저장함	응답을 첨부 파일 [sys_attachment] 테이블에 기록으로 저장할지 여부를 지정하는 옵션입니다.
첨부 파일 이름	REST 응답으로 작성된 첨부 파일의 이름입니다. 예를 들어 rest-response.txt. 주: 이 필드는 첨부 파일로 저장을 선택한 경우에 사용할 수 있습니다.
첨부 파일 기록	첨부 파일이 연결된 대상 기록입니다. 대상 기록은 기록 유형의 데이터 알약이어야 합니다. 특정 인시던트 기록을 예로 들 수 있습니다. 이전 단계에서 이 기록을 조회하거나 입력 변수로 정의할 수 있습니다. 플로우 실행 상세 정보에는 연결된 기록의 sys_id 표시됩니다. 주: 이 필드는 첨부 파일로 저장을 선택한 경우에 사용할 수 있습니다.

작업 오류 평가

이 단계가 실패할 경우

데이터 유형: Choice

다음 단계를 계속 실행하거나 오류 평가로 이동하는 옵션입니다. 사용자 지정 작업 오류 조건에 단계 상태 코드 또는 메시지를 사용하려면 다음 문서를 참조하십시오 작업 오류 평가.

REST 응답 크기 제한

기본적으로 시스템은 첨부 파일로 저장되지 않은 REST 응답의 크기를 5MB로 제한합니다. 이 한도를 초과하는 직접 REST 응답은 오류를 생성합니다. 더 큰 응답 크기를 지원하려면 응답을 첨부 파일로 저장하거나 시스템 속성을 사용하여 응답 크기 제한을 늘리십시오 glide.pf.rest.response_payload_max_size . 이 시스템 속성은 REST 응답의 크기를 10MB로 제한하는 최댓값인 10240KB를 지원합니다.

REST 응답 구문 분석

REST API 호출은 응답 본문에 데이터를 반환합니다. 응답 본문 데이터는 일반적으로 JSON 또는 XML 형식으로 구조화됩니다. 를 스크립트 단계 사용하여 구조화된 데이터를 변수로 구문 분석하여 작업 또는 플로우의 다른 곳에서 사용할 수 있습니다. XML 형식의 응답 본문을 구문 분석하는 방법도 XML parser step 있습니다.

응답에서 추출된 데이터를 가져오는 일반적인 전략은 다음을 수행하는 것입니다.

1. 응답 본문을 검토하여 반환할 데이터를 선택합니다.
2. 스크립트 단계에서 입력 및 출력 변수를 생성합니다.
   • REST 단계에서 응답 본문에 전달할 입력 변수를 생성합니다.
   • 응답에서 데이터를 반환하는 출력 변수를 만듭니다.
3. 데이터를 구문 분석하고 매핑하는 스크립트를 만듭니다.
   • 스크립트 단계에서 JSON.parse() 메서드를 사용하여 JSON 응답 본문을 구문 분석합니다.
   • 구문 분석된 데이터를 출력 변수에 매핑합니다.
4. 데이터를 플로우에 사용할 수 있도록 출력 변수에 대한 작업 출력을 생성합니다.

자세한 예는 통합 허브에서 REST 개발자 교육(Zurich)의 REST 응답 구문 분석 섹션을 참조하십시오.