다음을 통해 공유

Microsoft Marketplace용 보고서 쿼리 API 가져오기

보고서 가져오기 쿼리 API는 보고서에서 사용할 수 있는 모든 쿼리를 가져옵니다. 기본적으로 모든 시스템 및 사용자 정의 쿼리를 가져옵니다.

요청 구문

메서드 요청 URI
가져오기 https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

요청 헤더

헤더 형식 설명
권한 부여 문자열 필수. Microsoft Entra 액세스 토큰 Bearer <token> 형식으로
콘텐츠 유형 (Content-Type) 문자열 Application/JSON

Path 매개 변수

없음

Query 매개 변수

매개 변수 이름 형식 필수 설명
queryId 문자열 아니요 인수에 지정된 ID를 사용하여 쿼리에 대한 세부 정보만 가져오도록 필터링
queryName 문자열 아니요 인수에 지정된 이름을 가진 쿼리에 대한 세부 정보만 가져오는 필터
IncludeSystemQueries 부울 자료형 아니요 응답에 미리 정의된 시스템 쿼리를 포함합니다. 기본값은 True입니다.
IncludeOnlySystemQueries 부울 자료형 아니요 응답에 시스템 쿼리만 포함합니다. 기본값은 false

요청 페이로드

없음

용어집

없음

응답

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

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

응답 페이로드:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

용어집

이 표에서는 응답에 있는 요소의 주요 정의에 대해 설명합니다.

매개 변수 설명
QueryId 쿼리의 고유 UUID
Name 쿼리를 만들 때 쿼리에 지정된 이름
Description 쿼리를 만드는 동안 지정된 설명
Query 보고서 쿼리 문자열
Type 사용자가 만든 쿼리는 userDefined으로 설정하고, 미리 정의된 시스템 쿼리는 system으로 설정하십시오.
User 쿼리를 만든 사용자 ID
CreatedTime 쿼리 생성 시간
TotalCount 값 배열의 데이터 세트 수
StatusCode 결과 코드입니다. 가능한 값은 200, 400, 401, 403, 500입니다.
  • Last updated on