상업용 Marketplace용 보고서 API 가져오기

이 API는 예약된 모든 보고서를 가져옵니다.

요청 구문

방법	요청 URI
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

요청 헤더

Header	Type	설명
권한 부여	string	필수입니다. 양식의 Microsoft Entra 액세스 토큰 Bearer <token>
콘텐츠-종류	string	Application/JSON

경로 매개 변수

None

쿼리 매개 변수

매개 변수 이름	Required	Type	설명
reportId	아니요	string	필터를 사용하여 이 인수에 지정된 보고서 reportId 만 세부 정보를 가져옵니다. 다중 reportId 항목은 세미콜론으로 구분하여 지정할 수 있습니다(;)
reportName	아니요	string	이 인수에 지정된 reportName를 사용하여 보고서의 세부 정보만 가져오도록 필터링합니다
queryId	아니요	부울 값	응답에 미리 정의된 시스템 쿼리 포함

용어 설명

None

Response

응답 페이로드는 다음과 같이 JSON 형식으로 구성됩니다.

응답 코드: 200, 400, 401, 403, 404, 500

응답 페이로드:

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      " RecurrenceCount": 0,
      "CallbackUrl": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

용어 설명

이 표에는 응답에 있는 요소의 주요 정의가 나열되어 있습니다.

매개 변수	설명
ReportId	만든 보고서의 UUID(범용 고유 식별자)
ReportName	보고서를 만드는 동안 요청 페이로드에 제공된 이름
Description	보고서를 만드는 동안 요청 페이로드에 제공된 설명
QueryId	보고서를 만드는 동안 요청 페이로드에 제공된 쿼리 ID
Query	이 보고서에 대해 실행될 쿼리 텍스트
User	보고서를 만드는 데 사용되는 사용자 ID
CreatedTime	보고서가 생성된 UTC 시간(yyyy-MM-ddTHH:mm:ssZ 형식)
ModifiedTime	보고서가 마지막으로 수정된 UTC 시간: yyyy-MM-ddTHH:mm:ssZ
ExecuteNow	보고서를 만드는 동안 요청 페이로드에 제공된 ExecuteNow 매개 변수
queryStartTime	보고서를 만드는 동안 요청 페이로드에 제공된 쿼리 시작 시간입니다. 이는 "True"로 설정된 경우에만 ExecuteNow 적용됩니다.
queryEndTime	보고서를 만드는 동안 요청 페이로드에 제공된 쿼리 종료 시간입니다. 이는 "True"로 설정된 경우에만 ExecuteNow 적용됩니다.
StartTime	보고서를 만드는 동안 요청 페이로드에 제공된 시작 시간
ReportStatus	보고서 실행의 상태입니다. 가능한 값은 Paused, Active 및 Inactive입니다.
RecurrenceInterval	보고서를 만드는 동안 요청 페이로드에 제공된 되풀이 간격
RecurrenceCount	보고서의 나머지 되풀이 횟수
CallbackUrl	보고서를 만드는 동안 요청 페이로드에 제공된 콜백 URL
CallbackMethod	보고서를 만드는 동안 요청 페이로드에 제공된 콜백 메서드
Format	보고서를 만드는 동안 요청 페이로드에 제공된 보고서 파일의 형식
EndTime	보고서를 만드는 동안 요청 페이로드에 제공된 종료 시간입니다. 이는 "True"로 설정된 경우에만 ExecuteNow 적용됩니다.
TotalRecurrenceCount	RecurrenceCount 보고서를 만드는 동안 요청 페이로드에 제공됨
nextExecutionStartTime	다음 보고서 실행이 시작되는 UTC 타임스탬프
TotalCount	값 배열의 레코드 수
StatusCode	결과 코드입니다. 가능한 값은 200, 400, 401, 403, 500입니다
message	API 실행의 상태 메시지