공용 유스 케이스 관리자 API 워크플로

이 워크플로우를 사용하여 보고서 데이터를 CSV 또는 JSON 파일로 다운로드합니다. JSON 형식의 경우 페이지 번호가 매겨진 형식 또는 전체 보고서를 생성하도록 선택할 수 있습니다. 페이지 번호가 매겨진 파일은 사용자 인터페이스와 같이 JSON이 필요하고 결과를 통해 페이지 번호를 매겨야 하는 위치에 유용합니다. 전체 결과 세트가 아닌 페이지별로 요청할 수 있습니다. 전체 보고서 파일은 JSON 본문보다 다운로드 속도가 빠르지만 파일 다운로드 형식에서는 페이지 매김을 사용할 수 없습니다.

보고서 데이터를 다운로드할 워크플로우를 선택하십시오.

JSON으로 페이지 번호를 매긴 결과를 생성하는 워크플로우

페이지별 형식으로 유스 케이스 탐색기 보고서를 JSON 배열로 생성합니다. 이 워크플로우는 사용자 인터페이스와 같이 JSON이 필요하고 페이지 매김이 필요한 위치에 유용합니다. 전체 결과 세트가 아닌 페이지별로 요청할 수 있습니다. 워크플로우는 다음 표에 설명된 순서대로 API 엔드포인트를 사용하는 3단계프로세스입니다.
엔드포인트 설명
POST /api/use_case_explorer 사용 사례 탐색기 보고서를 생성하고 reportId을(를) 리턴합니다. 보고서 생성을 시작할 때 처음 이 엔드포인트를 사용해야 합니다. 생성된 보고서에서 원하는 필터 또는 테이블 그룹화와 보고서 열로 요청의 본문을 채우십시오. 워크플로우의 다른 API 호출에서 리턴된 reportId 값을 사용하십시오.
GET /api/use_case_explorer/{reportId}/status /api/use_case_explorer 상태를 리턴합니다. 이 엔드포인트를 사용하여 보고서 생성의 성공 또는 실패 여부를 확인합니다.
GET /api/use_case_explorer/{reportId}/result 페이지 번호 지정된 JSON 배열에서 /api/use_case_explorer 결과를 리턴합니다. 결과를 얻기 위해 경로에 /api/use_case_explorer 엔드포인트에서 리턴되는 reportId 값을 포함하십시오.

CSV로 보고서를 생성 및 다운로드하는 워크플로우

CSV 형식으로 사용 사례 탐색기 전체 보고서를 생성합니다. 이 워크플로우는 다음 표에 설명된 순서대로 API 엔드포인트를 사용하는 5단계프로세스입니다.

엔드포인트 설명
POST /api/use_case_explorer 사용 사례 탐색기 보고서를 생성하고 reportId을(를) 리턴합니다. 보고서 생성을 시작할 때 처음 이 엔드포인트를 사용해야 합니다. 생성된 보고서에서 원하는 필터 또는 테이블 그룹화와 보고서 열로 요청의 본문을 채우십시오. 워크플로우의 다른 API 호출에서 리턴된 reportId 값을 사용하십시오.
GET /api/use_case_explorer/{reportId}/status /api/use_case_explorer 상태를 리턴합니다. 이 엔드포인트를 사용하여 보고서 생성의 완료 또는 실패 여부를 확인합니다.
POST /api/use_case_explorer/{reportId}/download_csv 유스 케이스 탐색기 보고서 CSV 파일의 다운로드를 시작합니다. 경로에 /api/use_case_explorer result 의 reportId 값을 포함시키고 요청의 본문을 선택한 열 코드, 정렬 매개변수, 규칙 ID 또는 검색 매개변수로 채워서 jobId를 가져오십시오.
GET /api/use_case_explorer/download_csv/{jobId}/status 유스 케이스 탐색기 보고서 CSV 파일 다운로드 작업을 상태를 확인합니다. /api/use_case_explorer/{reportId}/download_csv 엔드포인트에서 리턴된 jobId 값을 경로에 포함시켜 작업이 완료되었는지 또는 실패했는지 여부에 대한 상태를 가져오십시오.
GET /api/use_case_explorer/download_csv/{jobId}/result /api/use_case_explorer/download_csv/{jobId}/status 엔드포인트에서 '완료됨' 상태를 리턴하는 경우 CSV 파일에서 유스 케이스 탐색기 보고서를 리턴합니다. 엔드포인트에서 /api/use_case_explorer/{reportId}/download_csv 반환되는 jobId 값과 원하는 CSV 파일 이름을 쿼리에 포함시켜 CSV 파일의 다운로드 링크를 얻으십시오.

JSON로 보고서를 생성 및 다운로드하는 워크플로우

전체 보고서 형식의 JSON 배열로 유스 케이스 탐색기 보고서를 생성하십시오. 이 워크플로우는 JSON 파일이 JSON 본문보다 빠르게 다운로드되기 때문에 전체 결과 세트를 다운로드하려는 경우에 유용합니다. 파일 다운로드 형식에서는 페이지 매김을 사용할 수 없습니다. 워크플로우는 다음 표에 설명된 순서대로 API 엔드포인트를 사용하는 5단계프로세스입니다.

엔드포인트 설명
POST /api/use_case_explorer 사용 사례 탐색기 보고서를 생성하고 reportId을(를) 리턴합니다. 보고서 생성을 시작할 때 처음 이 엔드포인트를 사용해야 합니다. 생성된 보고서에서 원하는 필터 또는 테이블 그룹화와 보고서 열로 요청의 본문을 채우십시오. 워크플로우의 다른 API 엔드포인트에서 리턴된 reportId 값을 사용하십시오.
GET /api/use_case_explorer/{reportId}/status /api/use_case_explorer 상태를 리턴합니다. 이 엔드포인트를 사용하여 보고서 생성의 성공 또는 실패 여부를 확인합니다.
POST /api/use_case_explorer/{reportId}/download_json

JSON 파일로 유스 케이스 탐색기 보고서를 다운로드합니다. /api/use_case_explorer 엔드포인트의 reportId 값을 경로에 포함시키고 본문을 선택한 열 코드, 정렬 매개변수, 규칙 ID 또는 검색 매개변수로 채워서 jobId을 가져오십시오.
GET /api/use_case_explorer/download_json/{jobId}/status

유스 케이스 탐색기 보고서 JSON 파일 다운로드 작업을 상태를 확인합니다. /api/use_case_explorer/{reportId}/download_json 엔드포인트에서 리턴된 jobId 값을 경로에 포함시켜 작업이 완료되었는지 또는 실패했는지 여부에 대한 상태를 가져오십시오.
GET /api/use_case_explorer/download_json/{jobId}/result

/api/use_case_explorer/download_json/{jobId}/status 엔드포인트에서 '완료됨' 상태를 리턴한 후에 유스 케이스 탐색기 JSON 파일의 최종 결과를 리턴합니다. JSON 파일에 대한 다운로드 링크를 가져오기 위해 조회에 JSON 파일에 대해 원하는 이름 및 /api/use_case_explorer/{reportId}/download_json 엔드포인트에서 리턴되는 jobId 값을 포함하십시오.

보고서 데이터 다운로드

프로시저

  1. 사용할 워크플로우를 선택하십시오.
  2. 사용해 보기 를 클릭한 후 선택한 워크플로우에 대한 요청 매개변수를 완료하십시오. 자세한 정보는 유스 케이스 탐색기 필터 및 보고서 API의 보고서 열 코드를 참조하십시오.

다음에 수행할 작업

엔드포인트 워크플로를 검토하고 예제 스크립트를 사용해보거나 자체 스크립트의 기본으로 스크립트를 사용하십시오. 환경 및 요구사항에 적합한 필터 및 보고서 컬럼을 사용하십시오.