msdyn_ForecastApi العمل

بصفتك مطورا، اقرأ هذه الوثائق المرجعية لاستخدام الإجراء المخصص msdyn_ForecastApi لاسترداد بيانات التنبؤ وتحديثها. يمكنك أيضا استخدام هذا الإجراء لتخزين بيانات التنبؤ من وقت لآخر، كلقطة. يمكنك بعد ذلك استخدام اللقطة لمقارنة بيانات التنبؤ بمرور الوقت. استخدم نموذج التعليمات البرمجية لواجهة برمجة تطبيقات التنبؤ لبدء الإجراء msdyn_ForecastApi المخصص.

المعلمات

اسم المعلمة مطلوب الوصف
WebApiName نعم يحتوي على اسم واجهة برمجة التطبيقات المراد تنفيذها.
RequestJson نعم يحتوي على المعلمات والوسيطات لاستدعاء واجهة برمجة التطبيقات.

قائمة واجهات برمجة التطبيقات

فيما يلي مجموعة واجهات برمجة التطبيقات التي يمكنك استدعاؤها باستخدام الإجراء المخصص msdyn_ForecastApi .

GET_ForecastConfigurations

إرجاع قائمة بكافة تكوينات التنبؤ التي تم تكوينها.

مثال

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

{
    "WebApiName": "GET_ForecastConfigurations",
    "RequestJson": "{}"
}
المعلمة النوع الوصف
WebApiName سلسلة‬‬ اسم واجهة برمجة التطبيقات
RequestJson سلسلة‬‬ كائن JSON المتسلسل

استجابة

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

قيمة الإرجاع

قائمة تكوينات التنبؤ.

GET_ForecastConfigurationsByName

إرجاع كافة تكوينات التنبؤ التي تحتوي على الاسم المتوفر كجزء من حمولة الطلب.

مثال

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

{
    "WebApiName": "GET_ForecastConfigurationsByName",
    "RequestJson": "{\"Name\":\"api_test1\"}"
}
المعلمة النوع الوصف
WebApiName سلسلة‬‬ اسم واجهة برمجة التطبيقات
RequestJson كائن JSON يتكون من Name: اسم تكوين التنبؤ

استجابة

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

قيمة الإرجاع

قائمة تكوينات التنبؤ.

GET_ForecastPeriodsByForecastConfigurationId

إرجاع كافة فترات التنبؤ لمعرف تكوين التنبؤ النشط، الذي يتم توفيره كجزء من حمولة الطلب.

مثال

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\"
      }"
}
المعلمة النوع الوصف
WebApiName سلسلة‬‬ اسم واجهة برمجة التطبيقات
RequestJson كائن JSON يحتوي ForecastConfigurationIdعلى : معرف تكوين التنبؤ

استجابة

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

قيمة الإرجاع

قائمة فترات التنبؤ.

GET_ForecastInstances

إرجاع قائمة مثيلات التنبؤ التي تمثل سجل كيان صف واحد.

إشعار

يمكن أن تحتوي فترات التنبؤ على العديد من مثيلات التنبؤ. أكثر بكثير مما تريد سحبه في طلب واحد. تؤدي نقاط نهاية واجهة برمجة التطبيقات افتراضيا إلى توفير عدد محدود من العناصر لكل طلب.
ملاحظة: يمكن أن تضر طلبات البحث الكبيرة بالأداء، لذلك يتم تحديد عدد النتائج لكل صفحة ب 4000 سجل. إذا كنت ترغب في استرداد أكثر من 4000 سجل، على سبيل المثال لإنشاء قائمة من جانب العميل لجميع مثيلات التنبؤ المتاحة، فيمكنك تقديم طلبات واجهة برمجة تطبيقات متعددة ودمج النتائج داخل التطبيق الخاص بك.

مثال

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"}"
}
المعلمة النوع الوصف
WebApiName سلسلة‬‬ اسم واجهة برمجة التطبيقات
RequestJson كائن JSON يتكون من
ForecastPeriodIdالمعرف الفريد لفترة التنبؤ:
ForecastConfigurationIdالمعرف الفريد لتكوين التنبؤ:
SortingAttributeالسمة التي تريد القيام بالفرز في ترحيلها بناء عليها:
SortingOrderASC للترتيب الصاعد DSC للترتيب التنازلي:
PageSizeعدد السجلات التي تريد استردادها في صفحة واحدة:
PageNoسجلات الصفحات التي تريد جلبها.:
GetParticipatingRecordsFetchXmlعلامة تشير إلى ما إذا كانت السجلات المشاركة تجلب XML مطلوبة في الاستجابة.:
ParticipatingRecordsViewIdهذا مطلوب عندما GetParticipatingRecordsFetchXml يكون صحيحا.: هذا معرف استعلام (عرض) محفوظ يتم من خلاله إنشاء XML لجلب السجلات المشاركة.

فيما يلي عينة JSON للكائن RequestJson .

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

استجابة

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

قيمة الإرجاع

قائمة مثيلات التنبؤ.

Update_SimpleColumnByEntityId

تحديث قيم الأعمدة المحددة باستخدام قيم المعلمات التي تم تمريرها.

إشعار

يمكن أن يؤدي العدد الكبير من طلبات التحديث في استدعاء واجهة برمجة تطبيقات واحدة إلى الإضرار بالأداء، لذلك يتم تحديد التحديثات لكل طلب عند 50.

مثال

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}]}"
}
المعلمة الاسم الوصف
WebApiName سلسلة‬‬ اسم واجهة برمجة التطبيقات
ForecastConfigurationId معرف Guid معرف تكوين التنبؤ
ForecastRecurranceId معرف Guid معرف تكرار التنبؤ أو معرف فترة التنبؤ قائمة SimpleColumnUpdateRequests مصفوفة
HierarchyEntityRecordId معرف Guid EntityRecordId
ForecastConfigurationColumnId معرف Guid معرف عمود تكوين التنبؤ
ForecastConfigurationColumnValue نوع البيانات الخاص ب ForecastConfigurationColumn القيمة التي تحتاج إلى تحديث إلى
IsRolledUpColumnUpdate (اختياري) قيمة منطقية True إذا تم تحديث القيمة للعمود المجمع، False إذا كانت القيمة هي تحديث للعمود التجميع

استجابة

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

قيمة الإرجاع

قائمة بالسجلات UpdateSimpleColumnByEntityResponse تتكون من HierarchyEntityRecordId، ForecastConfigurationColumnId، Message، StatusCode.

Update_SimpleColumnByFIId

تحديث قيمة العمود المحدد عن طريق تعيين قيم المعلمات التي تم تمريرها.

إشعار

يمكن أن يؤدي العدد الكبير من طلبات التحديث في استدعاء واجهة برمجة تطبيقات واحدة إلى الإضرار بالأداء، لذلك يتم تحديد التحديثات لكل طلب عند 50.

مثال

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}]}"
}
المعلمة النوع الوصف
WebApiName سلسلة‬‬ اسم واجهة برمجة التطبيقات
ForecastConfigurationId معرف Guid معرف تكوين التنبؤ
ForecastRecurranceId GUID معرف تكرار التنبؤ أو معرف فترة التنبؤ
SimpleColumnUpdateRequests Array يتضمن ما يلي
ForecastInstanceId معرف Guid معرف مثيل التنبؤ
ForecastConfigurationColumnId معرف Guid معرف عمود تكوين التنبؤ
ForecastConfigurationColumnValue نوع البيانات الخاص ب ForecastConfigurationColumn القيمة التي تحتاج إلى تحديث إلى
IsRolledUpColumnUpdate (اختياري) قيمة منطقية True إذا تم تحديث القيمة للعمود المجمع، false إذا كانت القيمة هي تحديث للعمود التجميع

استجابة

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

قيمة الإرجاع

قائمة بالسجلات UpdateSimpleColumnByEntityResponse تتكون من ForecastInstanceId، ForecastConfigurationColumnId، Message، StatusCode.

GET_ParticipatingRecordsFetchxml

إرجاع ملف إحضار XML لاسترداد السجلات الأساسية في التنبؤ.

مثال


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"
}
المعلمة النوع الوصف
ForecastConfigurationId معرف Guid معرف تكوين التنبؤ
ForecastPeriodId معرف Guid معرف فترة التنبؤ
HierarchyRecordId معرف Guid معرف السجل في Dataverse الذي يجب استرداد السجل الأساسي له. على سبيل المثال، معرف مستخدم النظام في حالة التنبؤ بالمخطط الهيكلي، أو معرف المنطقة في حالة التنبؤ بالمنطقة.
ForecastInstanceId معرف Guid معرف مثيل التنبؤ
ForecastConfigurationColumnId معرف Guid معرف عمود التنبؤ الذي يجب استرداده. على سبيل المثال، عندما تريد جلب السجلات المشاركة فقط لعمود أفضل حالة في التنبؤ، أدخل معرف العمود في العمود أفضل حالة. يمكنك إدخال معرف عمود واحد فقط لكل طلب. لاسترداد المزيد من الأعمدة، يجب إرسال طلب لكل عمود. تخطي هذه المعلمة إذا كنت تريد جلب XML لجميع أعمدة التنبؤ. يمكنك الحصول على معرف العمود من تعريف تكوين التنبؤ .
معرف RecordViewId معرف Guid معرف عرض السجل للسجلات الأساسية. تعرف على المزيد حول الحصول على معرف طريقة العرض في savedquery EntityType
IsRolledUpNodeRequest قيمة منطقية يحدد ما إذا كان سيتم إرجاع قيم العقدة (المجموعة) أو العقدة الفردية. إذا تم تعيينه إلى صواب، إرجاع كافة السجلات الموجودة ضمن عقدة المجموعة. إذا تم تعيينه إلى خطأ، إرجاع سجل الفرد فقط.

استجابة

{

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

}

قيمة الإرجاع

استعلام جلب XML يقوم بإرجاع السجلات الأساسية في التنبؤ.

الإجراءات المخصصة للتنبؤ

  • Last updated on