다음을 통해 공유

Microsoft Marketplace용 보고서 API 업데이트

이 API는 보고서 매개 변수를 수정하는 데 도움이 됩니다.

요청 구문

메서드 요청 URI
놓다 https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID}

요청 헤더

머리글 유형 묘사
권한 부여 문자열 필수. Microsoft Entra 액세스 토큰은 Bearer <token> 형식입니다.
콘텐츠 유형 (Content-Type) 문자열 Application/JSON

Path 매개 변수

없음

Query 매개 변수

매개 변수 이름 필수 유형 묘사
reportId 예 문자열 수정 중인 보고서의 ID

요청 페이로드

{
  "ReportName": "string",
  "Description": "string",
  "StartTime": "string",
  "RecurrenceInterval": 0,
  "RecurrenceCount": 0,
  "Format": "string",
  "CallbackUrl": "string"
}

용어집

이 표에는 요청 페이로드의 요소에 대한 주요 정의가 나열되어 있습니다.

매개 변수 필수 묘사 허용되는 값
ReportName 예 보고서에 할당할 이름 문자열
Description 아니요 만든 보고서에 대한 설명 문자열
StartTime 예 보고서 생성이 시작되는 타임스탬프 문자열
RecurrenceInterval 아니요 보고서를 몇 시간 안에 생성해야 하는 빈도입니다. 최소값은 4입니다. 정수
RecurrenceCount 아니요 생성할 보고서 수입니다. 기본값은 무한입니다. 정수
Format 예 내보낸 파일의 파일 형식입니다. 기본값은 CSV입니다. CSV/TSV
CallbackUrl 예 보고서 생성 시 호출할 https 콜백 URL 문자열
CallbackMethod 아니요 콜백 URL로 구성할 수 있는 Get/Post 메서드 GET/POST
endTime 아니요 보고서 생성이 종료되는 UTC 타임스탬프입니다. 형식은 yyyy-MM-ddTHH:mm:ssZ여야 합니다. 문자열

용어집

없음

응답

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

응답 코드: 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 보고서를 만드는 동안 요청 페이로드에 제공된 쿼리 시작 시간입니다. 이는 ExecuteNow "True"로 설정된 경우에만 적용됩니다.
queryEndTime 보고서를 만드는 동안 요청 페이로드에 제공된 쿼리 종료 시간입니다. 이는 ExecuteNow "True"로 설정된 경우에만 적용됩니다.
StartTime 보고서를 만드는 동안 요청 페이로드에 제공된 시작 시간
ReportStatus 보고서 실행의 상태입니다. 가능한 값은 일시 중지된, 활성, 그리고 비활성입니다.
RecurrenceInterval 보고서를 만드는 동안 요청 페이로드에 제공된 되풀이 간격
RecurrenceCount 보고서의 나머지 되풀이 횟수
CallbackUrl 보고서를 만드는 동안 요청 페이로드에 제공된 콜백 URL
CallbackMethod 보고서를 만드는 동안 요청 페이로드에 제공된 콜백 메서드
Format 보고서를 만드는 동안 요청 페이로드에 제공된 보고서 파일의 형식
EndTime 보고서를 만드는 동안 요청 페이로드에 제공된 종료 시간입니다. 이는 ExecuteNow "True"로 설정된 경우에만 적용됩니다.
TotalRecurrenceCount 보고서를 만드는 동안 요청 페이로드에 제공된 것은 RecurrenceCount입니다.
nextExecutionStartTime 다음 보고서 실행이 시작되는 UTC 타임스탬프
TotalCount 값 배열의 레코드 수
StatusCode 결과 코드입니다. 가능한 값은 200, 400, 401, 403, 500입니다.
message API 실행의 상태 메시지
  • Last updated on