다음을 통해 공유


보고서 실행 일시 중지 API

실행할 때 이 API는 예약된 보고서 실행을 일시 중지합니다.

요청 구문

메서드 요청 URI
PUT https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport/pause/{ReportID}

요청 헤더

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

경로 매개 변수

매개 변수 이름 Type 필수 설명
reportId string 아니요 수정 중인 보고서의 ID

쿼리 매개 변수

None

요청 페이로드

None

요청 용어집

None

Response

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

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

응답 페이로드 예제:

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

응답 용어집

이 표는 응답의 주요 요소를 정의합니다.

매개 변수 설명
ReportId 일시 중지된 보고서의 UUID(범용 고유 식별자)
ReportName 만드는 동안 보고서에 지정된 이름
설명 보고서를 만드는 동안 제공된 설명
QueryId 보고서를 만들 때 전달된 쿼리 ID
쿼리 이 보고서에 대해 실행될 쿼리 텍스트
사용자 보고서를 만드는 데 사용되는 사용자 ID
CreatedTime 보고서를 만든 시간입니다. 시간 형식은 yyyy-MM-ddTHH:mm:ssZ입니다
ModifiedTime 보고서를 마지막으로 수정한 시간입니다. 시간 형식은 yyyy-MM-ddTHH:mm:ssZ입니다
ExecuteNow 보고서가 생성되었을 때 설정된 ExecuteNow 플래그
StartTime 보고서 실행이 시작되는 시간입니다. 시간 형식은 yyyy-MM-ddTHH:mm:ssZ입니다
ReportStatus 보고서 실행의 상태입니다. 가능한 값은 Paused, Active 및 Inactive입니다.
RecurrenceInterval 보고서를 만드는 동안 제공된 되풀이 간격
RecurrenceCount 보고서를 만드는 동안 제공된 되풀이 횟수
CallbackUrl 요청에 제공된 콜백 URL
CallbackMethod 요청에 제공된 콜백 메서드
형식 보고서 파일의 형식
TotalCount 값 배열의 데이터 집합 수
메시지 API 실행의 상태 메시지
StatusCode 결과 코드입니다. 가능한 값은 200, 400, 401, 403, 500입니다