Bendrinti naudojant


msdyn_ForecastApi veiksmas

Kaip kūrėjas, perskaitykite šią informacinę dokumentaciją, kad galėtumėte naudoti pasirinktinį msdyn_ForecastApi veiksmą prognozės duomenims gauti ir atnaujinti. Šį veiksmą taip pat galite naudoti norėdami retkarčiais saugoti prognozės duomenis kaip momentinę kopiją. Tada galite naudoti momentinę kopiją, kad palygintumėte prognozės duomenis laikui bėgant. Naudokite prognozavimo API pavyzdinį kodą , kad pradėtumėte atlikti pasirinktinį msdyn_ForecastApi veiksmą.

Parametrus

Parametro pavadinimas Privalomas Aprašymas
WebApiName Taip Yra vykdytinos API pavadinimas.
RequestJson Taip Yra API iškvietimo parametrai ir argumentai.

API sąrašas

Toliau pateikiamas API rinkinys, kurį galite iškviesti naudodami pasirinktinį msdyn_ForecastApi veiksmą.

GET_ForecastConfigurations

Pateikia visų sukonfigūruotų prognozės konfigūracijų sąrašą.

Pavyzdžiui

POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi/ HTTP/1.1
Content-Type: application/json

{
    "WebApiName": "GET_ForecastConfigurations",
    "RequestJson": "{}"
}
Parametras Tipas Aprašymas
WebApiName Eilutės API pavadinimas
RequestJson Eilutės Nuosekliai suskirstytas JSON objektas

Atsakas

{
   "@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"
      }
   ]
}

Grąžinama reikšmė

Prognozės konfigūracijų sąrašas.

GET_ForecastConfigurationsByName

Pateikia visas prognozės konfigūracijas, kurių pavadinimas pateiktas kaip užklausos naudingosios apkrovos dalis.

Pavyzdžiui

POST [Organization URI]/api/data/v9.1/msdyn_ForecastApi HTTP/1.1
Content-Type: application/json

{
    "WebApiName": "GET_ForecastConfigurationsByName",
    "RequestJson": "{\"Name\":\"api_test1\"}"
}
Parametras Tipas Aprašymas
WebApiName Eilutės API pavadinimas
RequestJson JSON objektas Susideda iš Name: prognozės konfigūracijos pavadinimas

Atsakas

{
   "@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"
      }
   ]
}

Grąžinama reikšmė

Prognozės konfigūracijų sąrašas.

GET_ForecastPeriodsByForecastConfigurationId

Pateikia visus aktyvaus prognozės konfigūracijos ID, kuris pateikiamas kaip užklausos naudingosios apkrovos dalis, prognozės laikotarpius.

Pavyzdžiui

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\"
      }"
}
Parametras Tipas Aprašymas
WebApiName Eilutės API pavadinimas
RequestJson JSON objektas Sudėtyje yra ForecastConfigurationId: prognozės konfigūracijos ID

Atsakas

{
   "@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
      }
    ]
}

Grąžinama reikšmė

Prognozuojamų laikotarpių sąrašas.

GET_ForecastInstances

Pateikia prognozės egzempliorių, kurie yra vienos eilutės objekto įrašas, sąrašą.

Pastaba.

Prognozės laikotarpiai gali turėti daug prognozės egzempliorių. Daug daugiau, nei norėtumėte nutraukti vienu prašymu. API galiniai punktai pagal numatytuosius nustatymus pateikia ribotą elementų skaičių vienoje užklausoje.
Pastaba: Didelės užklausos gali pakenkti našumui, todėl rezultatų skaičius puslapyje negali viršyti 4000 įrašų. Jei norite gauti daugiau nei 4000 įrašų, pvz., sukurti visų galimų prognozės egzempliorių kliento sąrašą, galite pateikti kelias API užklausas ir sujungti rezultatus savo programoje.

Pavyzdžiui

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"}"
}
Parametras Tipas Aprašymas
WebApiName Eilutės API pavadinimas
RequestJson JSON objektas Susideda iš
ForecastPeriodId: Unikalus prognozės laikotarpio identifikatorius
ForecastConfigurationId: Unikalus prognozės konfigūracijos identifikatorius
SortingAttribute: atributas, pagal kurį norite atlikti rūšiavimą puslapių puslapyje
SortingOrder: ASC didėjančia tvarka DSC mažėjančia tvarka
PageSize: įrašų, kuriuos norite nuskaityti viename puslapyje, skaičius
PageNo: kurį puslapio įrašą norite gauti.
GetParticipatingRecordsFetchXml: Žyma, nurodanti, ar dalyvaujantys įrašai turi gauti XML atsakymą.
ParticipatingRecordsViewId: Tai reikalinga, kai GetParticipatingRecordsFetchXml yra tiesa. Tai įrašytas užklausos (rodinio) ID, pagal kurį generuojamas dalyvaujančių įrašų gaunamas XML.

Žemiau pateikiamas objekto JSON RequestJson pavyzdys.

{
    "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\"}"
}

Atsakas

{
   "@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"
   }
}

Grąžinama reikšmė

Prognozės egzempliorių sąrašas.

Update_SimpleColumnByEntityId

Atnaujina konkrečias stulpelių reikšmes naudojant perduodamų parametrų reikšmes.

Pastaba.

Didelis naujinimo užklausų skaičius per vieną API iškvietimą gali pakenkti našumui, todėl vienos užklausos naujinimų skaičius ribojamas iki 50.

Pavyzdžiui

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}]}"
}
Parametras Pavadinimą Aprašymas
WebApiName Eilutės API pavadinimas
Prognozės konfigūracijos ID GUID Prognozės konfigūracijos ID
PrognozėRecurranceId GUID Prognozės pasikartojimo ID arba prognozės laikotarpio ID Masyvo SimpleColumnUpdateRequests sąrašas
HierarchyEntityRecordId GUID EntityRecordId
ForecastConfigurationColumnId GUID Prognozės konfigūracijos stulpelio ID
ForecastConfigurationColumnValue ForecastConfigurationColumn duomenų tipas Reikšmė, į kurią reikia atnaujinti
IsRolledUpColumnUpdate(pasirinktinai) Bulio logikos True Jei apibendrinto stulpelio reikšmė atnaujinama, False jei suvestinės stulpelio reikšmė atnaujinama

Atsakas

{
   "@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"
      }
   ]
}

Grąžinama reikšmė

Įrašų sąrašasUpdateSimpleColumnByEntityResponse, kurį sudaro HierarchyEntityRecordId, ForecastConfigurationColumnId, Message, . StatusCode

Update_SimpleColumnByFIId

Atnaujina konkrečią stulpelio reikšmę nustatant perduodamų parametrų reikšmes.

Pastaba.

Didelis naujinimo užklausų skaičius per vieną API iškvietimą gali pakenkti našumui, todėl vienos užklausos naujinimų skaičius ribojamas iki 50.

Pavyzdžiui

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}]}"
}
Parametras Tipas Aprašymas
WebApiName Eilutės API pavadinimas
Prognozės konfigūracijos ID GUID Prognozės konfigūracijos ID
PrognozėRecurranceId GUID Prognozės pasikartojimo ID arba prognozės laikotarpio ID
SimpleColumnUpdateRequests Masyvas Apima:
Prognozės egzemplioriaus ID GUID Prognozės egzemplioriaus ID
ForecastConfigurationColumnId GUID Prognozės konfigūracijos stulpelio ID
ForecastConfigurationColumnValue ForecastConfigurationColumn duomenų tipas Reikšmė, į kurią reikia atnaujinti
IsRolledUpColumnUpdate(pasirinktinai) Bulio logikos True Jei apibendrinto stulpelio reikšmė atnaujinama, false jei suvestinės stulpelio reikšmė atnaujinama

Atsakas

{
   "@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"
      }
   ]
}

Grąžinama reikšmė

Įrašų sąrašasUpdateSimpleColumnByEntityResponse, kurį sudaro ForecastInstanceId, ForecastConfigurationColumnId, Message, . StatusCode

GET_ParticipatingRecordsFetchxml

Pateikia gavimo XML, kad būtų galima nuskaityti pagrindinius prognozės įrašus.

Pavyzdžiui


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"
}

Parametras Tipas Aprašymas
Prognozės konfigūracijos ID GUID Prognozės konfigūracijos ID
ForecastPeriodId GUID Prognozės laikotarpio ID
HierarchyRecordId GUID "Dataverse" įrašo ID, kurio pagrindinis įrašas turėtų būti nuskaitytas. Pavyzdžiui, sistemos vartotojo ID, jei tai organizacijos diagramos prognozė, arba teritorijos ID, jei tai teritorijos prognozė.
Prognozės egzemplioriaus ID GUID Prognozės egzemplioriaus ID
ForecastConfigurationColumnId GUID Prognozės stulpelio, kurį reikia nuskaityti, ID. Pavyzdžiui, jei norite gauti tik dalyvaujančius prognozės stulpelio Geriausias atvejis įrašus, įveskite stulpelio Geriausias atvejis ID. Kiekvienai užklausai galite įvesti tik vieną stulpelio ID. Norėdami gauti daugiau stulpelių, turėtumėte išsiųsti užklausą kiekvienam stulpeliui. Praleiskite šį parametrą, jei norite gauti XML visiems prognozės stulpeliams. Stulpelio ID galite gauti iš prognozės konfigūracijos aprašo.
Įrašo peržiūros ID GUID Pagrindinių įrašų įrašo rodinio ID. Sužinokite daugiau apie rodinio ID gavimą "savedquery" EntityType
IsRolledUpNodeRequested Bulio logikos Nurodo, ar grąžinti apibendrinto mazgo (grupės), ar atskiro mazgo reikšmes. Jei nustatyta kaip teisinga, grąžinami visi grupės mazgo įrašai. Jei nustatyta kaip klaidinga, grąžinamas tik asmens įrašas.

Atsakas

{

    "@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>"

}

Grąžinama reikšmė

XML gavimo užklausa, grąžinanti pagrindinius prognozės įrašus.

Pasirinktiniai prognozavimo veiksmai