Získání rozhraní API sestavy
Toto rozhraní API získá všechny naplánované sestavy.
Syntaxe požadavku
metoda | Identifikátor URI žádosti |
---|---|
GET | https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID} |
Hlavička požadavku
Hlavička | Typ | Popis |
---|---|---|
Autorizace | řetězec | Povinný: Přístupový token Microsoft Entra ve formuláři Bearer <token> |
Typ obsahu | řetězec | Application/JSON |
Parametr cesty
Nic
Parametr dotazu
Název parametru | Typ | Požadováno | Popis |
---|---|---|---|
reportId | řetězec | No | Filtrováním získáte podrobnosti pouze o sestavách s ID sestavy zadané v tomto argumentu. |
reportName | řetězec | No | Filtrováním získáte podrobnosti pouze o sestavách s názvem reportName zadaným v tomto argumentu. |
queryId | řetězec | No | Filtrováním získáte podrobnosti pouze o sestavách s ID dotazu zadaným v tomto argumentu. |
Datová část žádosti
Nic
Glosář žádosti
Nic
Odpověď respondenta
Datová část odpovědi je strukturovaná takto:
Kód odpovědi: 200, 400, 401, 403, 404, 500
Příklad datové části odpovědi:
{
"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": null,
"Format": "string"
}
],
"TotalCount": 0,
"Message": "string",
"StatusCode": 0
}
Glosář odpovědí
Tato tabulka definuje klíčové prvky v odpovědi:
Parametr | Popis |
---|---|
ReportId | Jedinečné UUID vytvořené sestavy |
ReportName | Název předaný sestavě v datové části požadavku |
Popis | Popis zadaný při vytvoření sestavy |
QueryId | ID dotazu předané v době vytvoření sestavy |
Dotazu | Text dotazu, který se spustí pro tuto sestavu |
Uživatele | ID uživatele použité k vytvoření sestavy |
Čas vytvoření | Čas vytvoření sestavy Formát času je rrrr-MM-ddTHH:mm:ssZ |
Čas změny | Čas poslední změny sestavy Formát času je rrrr-MM-ddTHH:mm:ssZ |
executeNow | Příznak ExecuteNow nastavený v době vytvoření sestavy |
Starttime | Spustí se čas. Formát času je rrrr-MM-ddTHH:mm:ssZ |
ReportStatus | Stav provádění sestavy Možné hodnoty jsou Pozastaveno, Aktivní a Neaktivní. |
RecurrenceInterval | Interval opakování zadaný během vytváření sestavy |
RecurrenceCount | Počet opakování zadaný během vytváření sestavy |
CallbackUrl | Adresa URL zpětného volání zadaná v požadavku |
CallbackMethod | Metoda zpětného volání zadaná v požadavku |
Formát | Formát souborů sestavy |
TotalCount | Počet datových sad v poli Hodnota |
Zprávu | Stavová zpráva ze spuštění rozhraní API |
Statuscode | Kód výsledku Možné hodnoty jsou 200, 400, 401, 403, 500 |
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro