msdyn_ForecastApi δράση

Ως προγραμματιστής, διαβάστε αυτήν την τεκμηρίωση αναφοράς για να χρησιμοποιήσετε την msdyn_ForecastApi προσαρμοσμένη ενέργεια για την ανάκτηση και την ενημέρωση δεδομένων πρόβλεψης. Μπορείτε επίσης να χρησιμοποιήσετε αυτήν την ενέργεια για να αποθηκεύετε δεδομένα πρόβλεψης από καιρό σε καιρό, ως στιγμιότυπο. Στη συνέχεια, μπορείτε να χρησιμοποιήσετε το στιγμιότυπο για να συγκρίνετε τα δεδομένα πρόβλεψης με την πάροδο του χρόνου. Χρησιμοποιήστε το δείγμα κώδικα API πρόβλεψης για να ξεκινήσετε με την msdyn_ForecastApi προσαρμοσμένη ενέργεια.

Παράμετροι

Όνομα παραμέτρου Απαιτείται Περιγραφή
WebApiName Ναι Περιέχει το όνομα του API που θα εκτελεστεί.
RequestJson Ναι Περιέχει τις παραμέτρους και τα ορίσματα για την κλήση API.

Λίστα API

Παρακάτω δίνεται το σύνολο των API που μπορείτε να καλέσετε χρησιμοποιώντας την 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 Συμβλοσειρά Όνομα του API
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 Συμβλοσειρά Όνομα του API
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 Συμβλοσειρά Όνομα του API
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

Επιστρέφει τη λίστα των παρουσιών πρόβλεψης που αποτελούν εγγραφή οντότητας μίας γραμμής.

Σημείωμα

Οι περίοδοι πρόβλεψης μπορούν να έχουν πολλές περιπτώσεις πρόβλεψης. Πολύ περισσότερο από ό, τι θα θέλατε να τραβήξετε κάτω σε ένα μόνο αίτημα. Τα τελικά σημεία API παρέχουν από προεπιλογή έναν περιορισμένο αριθμό στοιχείων ανά αίτημα.
Σημείωση: Τα μεγάλα ερωτήματα μπορεί να βλάψουν την απόδοση, επομένως ο αριθμός των αποτελεσμάτων ανά σελίδα περιορίζεται σε 4000 εγγραφές. Εάν θέλετε να ανακτήσετε περισσότερες από 4000 εγγραφές, για παράδειγμα για να δημιουργήσετε μια λίστα από την πλευρά του πελάτη με όλες τις διαθέσιμες παρουσίες πρόβλεψης, μπορείτε να κάνετε πολλαπλά αιτήματα API και να συνδυάσετε τα αποτελέσματα εντός της εφαρμογής σας.

Παράδειγμα

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 Συμβλοσειρά Όνομα του API
RequestJson Αντικείμενο JSON Αποτελείται από
ForecastPeriodId: Μοναδικός αναγνωριστικός κωδικός της περιόδου πρόβλεψης
ForecastConfigurationId: Μοναδικός αναγνωριστικός κωδικός της διαμόρφωσης πρόβλεψης
SortingAttribute: Το χαρακτηριστικό βάσει του οποίου θέλετε να κάνετε Ταξινόμηση στη σελιδοποίηση
SortingOrder: ASC για αύξουσα σειρά 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

Ενημερώνει τις συγκεκριμένες τιμές στηλών χρησιμοποιώντας τις τιμές των παραμέτρων που έχουν περάσει.

Σημείωμα

Ο μεγάλος αριθμός αιτημάτων ενημέρωσης σε μία κλήση API μπορεί να βλάψει την απόδοση, επομένως οι ενημερώσεις ανά αίτημα περιορίζονται στις 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 Συμβλοσειρά Όνομα του API
ForecastConfigurationId GUID Αναγνωριστικό ρύθμισης παραμέτρων πρόβλεψης
ForecastRecurranceId GUID Αναγνωριστικό περιοδικότητας πρόβλεψης ή αναγνωριστικό περιόδου πρόβλεψης Μια λίστα είναι SimpleColumnUpdateRequests ένας πίνακας
HierarchyEntityRecordId GUID EntityRecordId
ForecastConfigurationColumnId GUID Αναγνωριστικό στήλης ρύθμισης παραμέτρων πρόβλεψης
ForecastConfigurationColumnValue Τύπος δεδομένων του ForecastConfigurationColumn Τιμή που πρέπει να ενημερωθεί σε
IsRolledUpColumnUpdate(προαιρετικό) Δυαδική τιμή True Εάν η τιμή ενημερωθεί για τη στήλη Rollup, 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

Ενημερώνει τη συγκεκριμένη τιμή στήλης ορίζοντας τις τιμές των παραμέτρων που πέρασαν.

Σημείωμα

Ο μεγάλος αριθμός αιτημάτων ενημέρωσης σε μία κλήση API μπορεί να βλάψει την απόδοση, επομένως οι ενημερώσεις ανά αίτημα περιορίζονται στις 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 Συμβλοσειρά Όνομα του API
ForecastConfigurationId GUID Αναγνωριστικό ρύθμισης παραμέτρων πρόβλεψης
ForecastRecurranceId Guid Αναγνωριστικό περιοδικότητας πρόβλεψης ή αναγνωριστικό περιόδου πρόβλεψης
SimpleColumnUpdateRequests Παράταξη Περιλαμβάνει τα ακόλουθα
ForecastInstanceId GUID Αναγνωριστικό παρουσίας πρόβλεψης
ForecastConfigurationColumnId GUID Αναγνωριστικό στήλης ρύθμισης παραμέτρων πρόβλεψης
ForecastConfigurationColumnValue Τύπος δεδομένων του ForecastConfigurationColumn Τιμή που πρέπει να ενημερωθεί σε
IsRolledUpColumnUpdate(προαιρετικό) Δυαδική τιμή True Εάν η τιμή ενημερωθεί για τη στήλη Rollup, 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 Αναγνωριστικό προβολής εγγραφών των υποκείμενων καρτελών. Μάθετε περισσότερα σχετικά με τη λήψη του αναγνωριστικού αναλυτικής προβολής στο αποθηκευμένο ερώτημα EntityType
IsRolledUpNodeRequested Δυαδική τιμή Καθορίζει εάν θα επιστραφούν οι τιμές για τον συγκεντρωτικό κόμβο (ομάδα) ή τον μεμονωμένο κόμβο. Εάν οριστεί σε true, επιστρέφονται όλες οι εγγραφές κάτω από τον κόμβο ομάδας. Εάν οριστεί σε false, επιστρέφεται μόνο η εγγραφή του ατόμου.

Απάντηση

{

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