Usage Product Activation

Output representation of a usage product activation response.

JSON Example 

1{
2  "success": true,
3  "errors": null,
4  "activatedProducts": [
5    "01txx0000006i2hAAB"
6  ],
7  "activationResults": {
8    "productActivationResults": [
9      {
10        "productId": "01txx0000006i2hAAA",
11        "errors": [
12          {
13            "productUsageResourceId": "0iUxx000000009",
14            "usageResourceId": "0hUxx000000003",
15            "message": "Usage Resource not found for product",
16            "objectApiName": "ProductUsageResource",
17            "fieldName": "UsageResourceId",
18            "recordId": null,
19            "recordName": null
20          },
21          {
22            "productUsageResourceId": "0iUxx0000000678",
23            "usageResourceId": "0hUxx000000004",
24            "message": "Related Unit of measure records is inactive, activate it first.",
25            "objectApiName": "ProductUsageGrant",
26            "fieldName": "DefaultUnitofMeasure",
27            "recordId": "1BXSM000000404f4AA",
28            "recordName": "PUG-000000001"
29          }
30        ]
31      }
32    ],
33    "productValidationResults": [
34      {
35        "productId": "01txx0000006i2gAAA",
36        "validationResult": {
37          "validationErrors": [
38            {
39              "ruleName": "Usage vs Rating Effectivity",
40              "errors": [
41                {
42                  "errorCode": "EFFECTIVITY_MISMATCH",
43                  "errorMessages": [
44                    {
45                      "errorMessage": "PUR and RCE effective date ranges must overlap for proper rating functionality.",
46                      "errorDetails": [
47                        {
48                          "relatedObjectAPIName": "ProductUsageResource",
49                          "records": [
50                            {
51                              "id": "0Wnxx0000004CDEAA2",
52                              "name": "API Calls PUR"
53                            }
54                          ]
55                        },
56                        {
57                          "relatedObjectAPIName": "RateCardEntry",
58                          "records": [
59                            {
60                              "id": "0Rcxx0000004FGHAA2",
61                              "name": "API Calls Rate Entry"
62                            }
63                          ]
64                        }
65                      ]
66                    }
67                  ]
68                }
69              ]
70            }
71          ],
72          "validationWarnings": []
73        }
74      }
75    ]
76  }
77}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
activated​ProductsString[]ID of the product whose associated usage records were activated. The array contains at most one entry.Big, 67.067.0
activation​ResultsUsage Activation ResultActivation and validation outcome for the product in the request.Big, 67.067.0
errorsGeneric Error[]List of top-level API errors. For example, a guardrail violation or an invalid request.Big, 67.067.0
successBooleanIndicates whether the API request was processed (true) or rejected at the top level (false).Big, 67.067.0