Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Jako vývojář si přečtěte tuto referenční dokumentaci a použijte msdyn_ForecastApi vlastní akci k načtení a aktualizaci dat prognózy. Tuto akci můžete také použít k občasnému ukládání dat prognózy jako snímku. Snímek pak můžete použít k porovnání dat prognózy v průběhu času. Pomocí ukázkového kódu rozhraní API pro prognózy můžete začít s msdyn_ForecastApi vlastní akcí.
Parametry
| Název parametru | Povinné | Description |
|---|---|---|
WebApiName |
Ano | Obsahuje název rozhraní API, které se má spustit. |
RequestJson |
Ano | Obsahuje parametry a argumenty pro volání rozhraní API. |
Seznam rozhraní API
Níže je uvedena sada rozhraní API, která můžete vyvolat pomocí msdyn_ForecastApi vlastní akce.
GET_ForecastConfigurations
Vrátí seznam všech konfigurovaných konfigurací prognózy.
Example
POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi/ HTTP/1.1
Content-Type: application/json
{
"WebApiName": "GET_ForecastConfigurations",
"RequestJson": "{}"
}
| Parameter | Typ | Description |
|---|---|---|
WebApiName |
String | Název rozhraní API |
RequestJson |
String | Serializovaný objekt JSON |
Odezva
{
"@odata.context": "[Organization URI]/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.msdyn_ForecastApiResponse",
"response": [
{
"Columns": [
{
"ForecastConfigurationColumnId": "0ad51075-912b-4e00-a7a1-91170e437d27",
...
"ForecastConfigurationId": "27bd2c40-f868-ea11-a811-000d3a37bb2c",
...
},
{
"ForecastConfigurationColumnId": "c3ef8024-6517-4168-adc7-bb5b520554a0",
...
"ForecastConfigurationId": "27bd2c40-f868-ea11-a812-125d3a37bb2d",
...
}],
"PermissionRoles": null,
"AdditionalFilters": "<fetch version=\"1.0\" mapping=\"logical\"><entity name=\"opportunity\"><\/entity><\/fetch>",
"IsSnapshotScheduled": false,
"SnapshotSchedule": null,
"SnapshotTimeZone": null,
"PublishedDateTime": "0001-01-01T00:00:00",
"DefaultViewIdForUnderlyingRecords": "bf649add-6c30-ea11-a813-000d3a5475f7"
}
]
}
Návratová hodnota
Seznam konfigurací prognózy.
GET_ForecastConfigurationsByName
Vrátí všechny konfigurace prognózy, jejichž název byl zadán jako součást datové části požadavku.
Example
POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi HTTP/1.1
Content-Type: application/json
{
"WebApiName": "GET_ForecastConfigurationsByName",
"RequestJson": "{\"Name\":\"api_test1\"}"
}
| Parameter | Typ | Description |
|---|---|---|
WebApiName |
String | Název rozhraní API |
RequestJson |
Objekt JSON | Skládá se z Name: název konfigurace prognózy |
Odezva
{
"@odata.context": "[Organization URI]/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.msdyn_ForecastApiResponse",
"response": [
{
"Columns": [
{
"Name": "api_test1",
...
"ForecastConfigurationId": "bcf37937-487e-ea11-a811-000d3a37bb2c",
...
}
],
"PermissionRoles": null,
"AdditionalFilters": "<fetch version=\"1.0\" mapping=\"logical\"><entity name=\"opportunity\"><\/entity><\/fetch>",
"IsSnapshotScheduled": false,
"SnapshotSchedule": null,
"SnapshotTimeZone": null,
"PublishedDateTime": "0001-01-01T00:00:00",
"DefaultViewIdForUnderlyingRecords": "bf649add-6c30-ea11-a813-000d3a5475f7"
}
]
}
Návratová hodnota
Seznam konfigurací prognózy.
GET_ForecastPeriodsByForecastConfigurationId
Vrátí všechna období prognózy pro ID konfigurace aktivní prognózy, které je poskytnuto jako součást datové části požadavku.
Example
POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi HTTP/1.1
Content-Type: application/json
{
"WebApiName": "GET_ForecastPeriodsByForecastConfigurationId",
"RequestJson": "{
\"ForecastConfigurationId\":\"04323a04-da7f-ea11-a811-000d3a37bb2c\"
}"
}
| Parameter | Typ | Description |
|---|---|---|
WebApiName |
String | Název rozhraní API |
RequestJson |
Objekt JSON | Obsahuje ForecastConfigurationId: ID konfigurace předpovědi |
Odezva
{
"@odata.context": "[Organization URI]/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.msdyn_ForecastApiResponse",
"response": [
{
"Id": "8b8cadd8-ede3-4b21-97cf-93efc0337089",
"ForecastConfigurationId": "04323a04-da7f-ea11-a811-000d3a37bb2c",
"RecurrenceIndex": 0,
"ValidFrom": "2020-04-01T00:00:00Z",
"ValidTo": "2020-06-30T23:59:59Z",
"Name": "FY2020 Q2",
"RecomputeStatus": 10,
"LastRecomputedOn": "2020-05-25T08:04:24.817Z",
"RecomputationStartTime": "2020-06-05T05:04:30.904Z",
"RecomputeStatusChangedOn": "2020-06-05T06:04:00.363Z",
"FailureInfo": "Microsoft.Azure.WebJobs.FunctionFailedException: The activity function 'CreateUpdateForecastHierarchy' failed: \"An item with the same key has already been added. Key: aaaaaaaa-0b0b-1c1c-2d2d-333333333333\". See the function execution logs for additional details. ---> System.ArgumentException: An item with the same key has already been added. Key: aaaaaaaa-0b0b-1c1c-2d2d-333333333333\r\n at System.Collections.Generic.Dictionary`2.TryInsert(TKey key, TValue value, InsertionBehavior behavior)\r\n at Microsoft.Dynamics.Forecasting.RecomputeEngine.HierarchyManager.<>c__DisplayClass23_0.<GetForecastInstancesByHierarchyEntityId>b__0(ForecastInstance forecastInstance) in C:\\src\\cloud_IDEs\\ide5\\Azure\\RecomputeEngine\\HierarchyManager\\HierarchyManager.cs:line 727\r\n at System.Collections.Generic.List`1.ForEach(Action`1 action)\r\n at Microsoft.Dynamics.Forecasting.RecomputeEngine.HierarchyManager.GetForecastInstancesByHierarchyEntityId(ForecastConfiguration forecastConfiguration, Guid forecastRecurrenceId) in C:\\src\\cloud_IDEs\\ide5\\Azure\\RecomputeEngine\\HierarchyManager\\HierarchyManager.cs:line 727\r\n at Microsoft.Dynamics.Forecasting.RecomputeEngine.HierarchyManager.CreateOrUpdateForecastDataWithLatestHierarchy(ForecastConfiguration forecastConfiguration, Guid forecastRecurrenceId, Dictionary`2 latestHierarchyEntityList) in C:\\src\\cloud_IDEs\\ide5\\Azure\\RecomputeEngine\\HierarchyManager\\HierarchyManager.cs:line 602\r\n at Microsoft.Dynamics.Forecasting.RecomputeEngine.HierarchyManager.<>c__DisplayClass16_0.<CreateOrUpdateForecastHierarchy>b__0() in C:\\src\\cloud_IDEs\\ide5\\Azure\\RecomputeEngine\\HierarchyManager\\HierarchyManager.cs:line 283\r\n at System.Threading.Tasks.Task.InnerInvoke()\r\n at System.Threading.Tasks.Task.<>c.<.cctor>b__275_1(Object obj)\r\n at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)\r\n--- End of stack trace from previous location where exception was thrown ---\r\n at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)\r\n at System.Threading.Tasks.Task.ExecuteWithThreadLocal(Task& currentTaskSlot)\r\n--- End of stack trace from previous location where exception was thrown ---\r\n at Microsoft.Dynamics.Forecasting.RecomputeEngine.HierarchyManager.CreateOrUpdateForecastHierarchy(ForecastConfiguration forecastConfiguration, Guid forecastRecurrenceId, Dictionary`2 latestHierarchyEntityList) in C:\\src\\cloud_IDEs\\ide5\\Azure\\RecomputeEngine\\HierarchyManager\\HierarchyManager.cs:line 255\r\n at Microsoft.Dynamics.Forecasting.RecomputeEngine.HierarchyManager.CreateOrUpdateForecastHierarchy(Guid orgId, Guid forecastConfigurationId, Guid forecastRecurrenceId, Dictionary`2 latestHierarchyEntityList) in C:\\src\\cloud_IDEs\\ide5\\Azure\\RecomputeEngine\\HierarchyManager\\HierarchyManager.cs:line 167\r\n at Microsoft.Dynamics.Forecasting.AzureFunctions.CreateUpdateForecastHierarchy.Run(CreateUpdateForecastHierarchyInput input) in C:\\src\\cloud_IDEs\\ide5\\Azure\\AzureFunctions\\Recompute\\ActivityFunctions\\CreateUpdateForecastHierarchy.cs:line 43\r\n at Microsoft.Azure.WebJobs.Host.Executors.VoidTaskMethodInvoker`2.InvokeAsync(TReflected instance, Object[] arguments) in C:\\projects\\azure-webjobs-sdk-rqm4t\\src\\Microsoft.Azure.WebJobs.Host\\Executors\\VoidTaskMethodInvoker.cs:line 20\r\n at Microsoft.Azure.WebJobs.Host.Executors.FunctionInvoker`2.InvokeAsync(Object instance, Object[] arguments) in C:\\projects\\azure-webjobs-sdk-rqm4t\\src\\Microsoft.Azure.WebJobs.Host\\Executors\\FunctionInvoker.cs:line 52\r\n at Microsoft.Azure.WebJobs.Host.Executors.FunctionExecutor.InvokeAsync(IFunctionInvoker invoker, ParameterHelper parameterHelper, CancellationTokenSource timeoutTokenSource, CancellationTokenSource functionCancellationTokenSource, Boolean throwOnTimeout, TimeSpan timerInterval, IFunctionInstance instance) in C:\\projects\\azure-webjobs-sdk-rqm4t\\src\\Microsoft.Azure.WebJobs.Host\\Executors\\FunctionExecutor.cs:line 585\r\n at Microsoft.Azure.WebJobs.Host.Executors.FunctionExecutor.ExecuteWithWatchersAsync(IFunctionInstanceEx instance, ParameterHelper parameterHelper, ILogger logger, CancellationTokenSource functionCancellationTokenSource) in C:\\projects\\azure-webjobs-sdk-rqm4t\\src\\Microsoft.Azure.WebJobs.Host\\Executors\\FunctionExecutor.cs:line 532\r\n at Microsoft.Azure.WebJobs.Host.Executors.FunctionExecutor.ExecuteWithLoggingAsync(IFunctionInstanceEx instance, ParameterHelper parameterHelper, IFunctionOutputDefinition outputDefinition, ILogger logger, CancellationTokenSource functionCancellationTokenSource) in C:\\projects\\azure-webjobs-sdk-rqm4t\\src\\Microsoft.Azure.WebJobs.Host\\Executors\\FunctionExecutor.cs:line 468\r\n at Microsoft.Azure.WebJobs.Host.Executors.FunctionExecutor.ExecuteWithLoggingAsync(IFunctionInstanceEx instance, FunctionStartedMessage message, FunctionInstanceLogEntry instanceLogEntry, ParameterHelper parameterHelper, ILogger logger, CancellationToken cancellationToken) in C:\\projects\\azure-webjobs-sdk-rqm4t\\src\\Microsoft.Azure.WebJobs.Host\\Executors\\FunctionExecutor.cs:line 278\r\n --- End of inner exception stack trace ---\r\n at Microsoft.Azure.WebJobs.DurableOrchestrationContext.CallDurableTaskFunctionAsync[TResult](String functionName, FunctionType functionType, String instanceId, RetryOptions retryOptions, Object input) in E:\\functions\\azure-functions-durable-extension\\src\\WebJobs.Extensions.DurableTask\\DurableOrchestrationContext.cs:line 498\r\n at Microsoft.Dynamics.Forecasting.AzureFunctions.OrchestratorFunctionBase.ExecuteActivityAsync(DurableOrchestrationContext context, String functionName, Object input, Dictionary`2 telemetryProps) in C:\\src\\cloud_IDEs\\ide5\\Azure\\AzureFunctions\\OrchestratorFunctionBase.cs:line 252\r\n at Microsoft.Dynamics.Forecasting.AzureFunctions.RecomputeOrchestrator.ExecuteRecomputeOrchestration(DurableOrchestrationContext context, RecomputeOrchestratorInput recomputeInput, String correlationId, Dictionary`2 telemetryProps) in C:\\src\\cloud_IDEs\\ide5\\Azure\\AzureFunctions\\Recompute\\RecomputeOrchestrator.cs:line 169",
"RecurrenceState": 0,
"UpdatedAttribteList": null
}
]
}
Návratová hodnota
Seznam předpovědních období.
GET_ForecastInstances
Vrátí seznam instancí prognózy, které jsou záznamem entity s jedním řádkem.
Poznámka:
Období prognózy mohou mít mnoho instancí prognózy. Mnohem více, než byste chtěli stáhnout v jediném požadavku. Koncové body rozhraní API ve výchozím nastavení poskytují omezený počet položek na požadavek.
Poznámka: Velké dotazy mohou snížit výkon, proto je počet výsledků na stránku omezen na 4000 záznamů. Pokud si přejete načíst více než 4000 záznamů, například pro vytvoření seznamu všech dostupných instancí prognózy na straně klienta, můžete zadat více požadavků API a kombinovat výsledky v rámci vaší aplikace.
Example
POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi HTTP/1.1
Content-Type: application/json
{
"WebApiName": "GET_ForecastInstances",
"RequestJson": "{\"ForecastPeriodId\":\"a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1\",\"ForecastConfigurationId\":\"b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2\",\"PageInfo\":{\"SortingAttribute\":\"HierarchyEntityRecord.RecordId\",\"SortingOrder\":\"DESC\",\"PageSize\":1,\"PageNo\":5},\"GetParticipatingRecordsFetchXml\":false,\"ParticipatingRecordsViewId\":\"c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3"}"
}
| Parameter | Typ | Description |
|---|---|---|
WebApiName |
String | Název rozhraní API |
RequestJson |
Objekt JSON | Skládá se zForecastPeriodId: Jedinečný identifikátor prognózovaného obdobíForecastConfigurationId: Jedinečný identifikátor konfigurace prognózySortingAttribute: Atribut, na jehož základě chcete provést Řazení ve stránkováníSortingOrder: ASC pro vzestupné pořadí DSC pro sestupné pořadíPageSize: Počet záznamů, které chcete načíst na jedné stráncePageNo: Které záznamy stránky chcete načíst.GetParticipatingRecordsFetchXml: Příznak označující, zda je v odpovědi potřeba načíst XML zúčastněných záznamů.ParticipatingRecordsViewId: To je potřeba, když GetParticipatingRecordsFetchXml je true. Jedná se o uložené ID dotazu (zobrazení), pomocí kterého se ze zúčastněných záznamů načítá XML |
Níže je uveden ukázkový kód JSON pro RequestJson objekt.
{
"WebApiName": "GET_ForecastInstances",
"RequestJson": "{\"ForecastPeriodId\":\"{{frid}}\",\"ForecastConfigurationId\":\"{{fcid}}\",\"PageInfo\":{\"SortingAttribute\":\"HierarchyEntityRecord.RecordId\",\"SortingOrder\":\"ASC\",\"PageSize\":1,\"PageNo\":5},\"GetParticipatingRecordsFetchXml\":false,\"ParticipatingRecordsViewId\":\"bf649add-6c30-ea11-a813-000d3a5475f7\"}"
}
Odezva
{
"@odata.context": "[Organization URI]/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.msdyn_ForecastApiResponse",
"response": {
"ForecastInstances": [
"ForecastInstanceId": "95d2305a-a0be-4b34-84ac-b10e67b0771a",
"ForecastConfigurationId": "04323a04-da7f-ea11-a811-000d3a37bb2c",
...],
"HasMorePages": false,
"ParticipatingRecordsFetchXml": "",
"Code": 200,
"Message": "OK"
}
}
Návratová hodnota
Seznam instancí prognózy.
Update_SimpleColumnByEntityId
Aktualizuje konkrétní hodnoty sloupců pomocí hodnot předaných parametrů.
Poznámka:
Velký počet požadavků na aktualizaci v jednom volání rozhraní API může snížit výkon, takže počet aktualizací na požadavek je omezen na 50.
Example
POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi HTTP/1.1
content-type: application/json
{
"WebApiName": "Update_ SimpleColumnByEntityId",
"RequestJson": "
{
\"ForecastConfigurationId\":\"0461fb6b-8d85-ea11-a811-000d3a37bb2c\",
\"ForecastRecurranceId\":\"f8b1122c-b913-4e88-9727-368b6134be3e\",
\"SimpleColumnUpdateRequests\":[{
\" HierarchyEntityRecordId\":\"d8680b00-fd31-46c2-8136-7c4df19cf2a8\",
\"ForecastConfigurationColumnId\":\"65ec7bd1-2de6-49fa-b259-ba74bc721c78\",
\"ForecastConfigurationColumnValue\":0.0,
\"IsRolledUpColumnUpdate\":false},{
\" HierarchyEntityRecordId\":\"11141300-131b-493a-9857-22bd8689b775\",
\"ForecastConfigurationColumnId\":\"65ec7bd1-2de6-49fa-b259-ba74bc721c78\",
\"ForecastConfigurationColumnValue\":0.0,
\"IsRolledUpColumnUpdate\":false}]}"
}
| Parameter | Název | Description |
|---|---|---|
| Název WebApi | String | Název rozhraní API |
| Identifikátor konfigurace prognózy | GUID | ID konfigurace prognózy |
| Identifikátor ForecastRecurranceId | GUID | ID opakování prognózy nebo ID období prognózy Seznam SimpleColumnUpdateRequests je pole |
| Identifikátor záznamu entity v hierarchii | GUID | ID záznamu entity |
| ForecastConfigurationColumnId | GUID | ID sloupce konfigurace prognózy |
| Hodnota sloupce ForecastConfigurationColumnValue | Datový typ ForecastConfigurationColumn | Hodnota, na kterou je třeba aktualizovat |
| IsRolledUpColumnUpdate (volitelné) | logický |
True Pokud je hodnota aktualizována pro souhrnný sloupec, False pokud je hodnota Update pro agregovaný sloupec |
Odezva
{
"@odata.context": "[Organization URI]/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.msdyn_ForecastApiResponse",
"response": [
{
"Message": "Update Successful",
"StatusCode": 0,
"HierarchyEntityRecordId": "d8680b00-fd31-46c2-8136-7c4df19cf2a8",
"ForecastConfigurationColumnId": "65ec7bd1-2de6-49fa-b259-ba74bc721c78"
},
{
"Message": "Update Successful",
"StatusCode": 0,
"HierarchyEntityRecordId": "11141300-131b-493a-9857-22bd8689b775",
"ForecastConfigurationColumnId": "65ec7bd1-2de6-49fa-b259-ba74bc721c78"
}
]
}
Návratová hodnota
Seznam záznamů UpdateSimpleColumnByEntityResponse se skládá z HierarchyEntityRecordId, ForecastConfigurationColumnId, MessageStatusCode, .
Update_SimpleColumnByFIId
Aktualizuje konkrétní hodnotu sloupce nastavením hodnot předaných parametrů.
Poznámka:
Velký počet požadavků na aktualizaci v jednom volání rozhraní API může snížit výkon, takže počet aktualizací na požadavek je omezen na 50.
Example
POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi HTTP/1.1
content-type: application/json
{
"WebApiName": "Update_SimpleColumnByFIId",
"RequestJson": "
{
\"ForecastConfigurationId\":\"0461fb6b-8d85-ea11-a811-000d3a37bb2c\",
\"ForecastRecurranceId\":\"f8b1122c-b913-4e88-9727-368b6134be3e\",
\"SimpleColumnUpdateRequests\":[
{
\"ForecastInstanceId\":\"d8680b00-fd31-46c2-8136-7c4df19cf2a8\",
\"ForecastConfigurationColumnId\":\"65ec7bd1-2de6-49fa-b259-ba74bc721c78\",
\"ForecastConfigurationColumnValue\":0.0,
\"IsRolledUpColumnUpdate\":false},
{
\"ForecastInstanceId\":\"11141300-131b-493a-9857-22bd8689b775\",
\"ForecastConfigurationColumnId\":\"65ec7bd1-2de6-49fa-b259-ba74bc721c78\",
\"ForecastConfigurationColumnValue\":0.0,
\"IsRolledUpColumnUpdate\":false}]}"
}
| Parameter | Typ | Description |
|---|---|---|
| Název WebApi | String | Název rozhraní API |
| Identifikátor konfigurace prognózy | GUID | ID konfigurace prognózy |
| Identifikátor ForecastRecurranceId | Průvodce | ID opakování prognózy nebo ID období prognózy |
| SimpleColumnUpdateRequests | Array | Obsahuje následující |
| ForecastInstanceId | GUID | ID instance předpovědi |
| ForecastConfigurationColumnId | GUID | ID sloupce konfigurace prognózy |
| Hodnota sloupce ForecastConfigurationColumnValue | Datový typ ForecastConfigurationColumn | Hodnota, na kterou je třeba aktualizovat |
| IsRolledUpColumnUpdate (volitelné) | logický |
True Pokud je hodnota aktualizována pro souhrnný sloupec, false pokud je hodnota Update pro agregovaný sloupec |
Odezva
{
"@odata.context": "[Organization URI]/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.msdyn_ForecastApiResponse",
"response": [
{
"Message": "Update Successful",
"StatusCode": 0,
"ForecastInstanceId": "d8680b00-fd31-46c2-8136-7c4df19cf2a8",
"ForecastConfigurationColumnId": "65ec7bd1-2de6-49fa-b259-ba74bc721c78"
},
{
"Message": "Update Successful",
"StatusCode": 0,
"ForecastInstanceId": "11141300-131b-493a-9857-22bd8689b775",
"ForecastConfigurationColumnId": "65ec7bd1-2de6-49fa-b259-ba74bc721c78"
}
]
}
Návratová hodnota
Seznam záznamů UpdateSimpleColumnByEntityResponse se skládá z ForecastInstanceId, ForecastConfigurationColumnId, MessageStatusCode, .
GET_ParticipatingRecordsFetchxml
Vrátí kód XML pro načtení podkladových záznamů v prognóze.
Example
POST /api/GET_ParticipatingRecordsFetchxml HTTP/1.1
Host: your-api-endpoint.com
Content-Type: application/json
{
"ForecastConfigurationId": "a01f86da-1b45-ef11-bfe2-6045bd066f80",
"ForecastPeriodId": "a51f86da-1b45-ef11-bfe2-6045bd066f80",
"HierarchyRecordId": "697adf08-df43-ef11-bfe2-6045bd07ea28",
"ForecastInstanceId": "69169046-520b-4040-abfa-2981a2f0aee3",
"ForecastConfigurationColumnId": "f06490f5-6c27-453c-b06c-0194819202a4",
"RecordViewId": "bf649add-6c30-ea11-a813-000d3a5475f7",
"IsRolledUpNodeRequested": "true"
}
| Parameter | Typ | Description |
|---|---|---|
| Identifikátor konfigurace prognózy | GUID | ID konfigurace prognózy |
| Identifikátor předpovězeného období | GUID | ID předpovědního období |
| ID záznamu v hierarchii | GUID | ID záznamu v Dataverse, pro který má být načten podkladový záznam. Například ID systémového uživatele v případě prognózy organizačního diagramu nebo ID obvodu v případě prognózy obvodu. |
| ForecastInstanceId | GUID | ID instance prognózy |
| ForecastConfigurationColumnId | GUID | ID sloupce prognózy, který je třeba načíst. Pokud například chcete načíst pouze zúčastněné záznamy pro sloupec Nejlepší případ prognózy, zadejte ID sloupce Nejlepší případ . Pro každý požadavek můžete zadat pouze jeden sloupec ID. Chcete-li načíst více sloupců, měli byste odeslat požadavek pro každý sloupec. Tento parametr přeskočte, pokud chcete načíst XML pro všechny sloupce prognózy. ID sloupce můžete získat z definice Konfigurace prognózy . |
| RecordViewId | GUID | ID zobrazení záznamu podkladových záznamů. Další informace o získání ID zobrazení v uloženém dotazu EntityType |
| IsRolledUpNodeRequested | logický | Určuje, zda se mají vrátit hodnoty pro zahrnutý uzel (skupinu) nebo pro jednotlivý uzel. Pokud je nastavená hodnota true, vrátí se všechny záznamy v uzlu skupiny. Pokud je nastavena hodnota false, vrátí se pouze záznam jednotlivce. |
Odezva
{
"@odata.context": "https://orgname.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msdyn_ForecastApiResponse",
"response": "<fetch version=\"1.0\" mapping=\"logical\" distinct=\"true\"><entity name=\"opportunity\"><filter type=\"and\"><condition attribute=\"estimatedclosedate\" operator=\"between\"><value>2024-07-01T00:00:00.0000000Z</value><value>2024-09-30T23:59:59.0000000Z</value></condition><condition attribute=\"msdyn_forecastcategory\" operator=\"eq\" value=\"100000001\" /></filter><link-entity name=\"systemuser\" from=\"systemuserid\" to=\"ownerid\" link-type=\"inner\"><attribute name=\"systemuserid\" /><filter type=\"and\"><condition attribute=\"systemuserid\" operator=\"eq-or-under\" value=\"697adf08-df43-ef11-bfe2-6045bd07ea28\" /></filter></link-entity><attribute name=\"name\" /><attribute name=\"statuscode\" /><attribute name=\"statecode\" /><attribute name=\"customerid\" /><attribute name=\"ownerid\" /><attribute name=\"msdyn_forecastcategory\" /><attribute name=\"estimatedvalue\" /><attribute name=\"estimatedclosedate\" /><attribute name=\"actualvalue\" /><attribute name=\"actualclosedate\" /><attribute name=\"opportunityid\" /><order attribute=\"name\" descending=\"false\" /></entity></fetch>"
}
Návratová hodnota
Dotaz XML, který vrací podkladové záznamy v prognóze.