Jump to

• Request
• Response

Create a subscription metric insight

post

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/subscriptionProductMetrics

Request

Path Parameters

• SubscriptionProductPuid(required): string
  The public unique identifier of the subscription product.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BalanceUnitofMeasureCode: string
  Title: Balance Unit of Measure Code

  Maximum Length: 3

  The balance unit of measure class code of the subscription balance code.
• CoveredLevelPuid: string
  Title: Covered Level PUID

  The public unique identifier for the product association for the metric.
• Currency: string
  Title: Currency

  Maximum Length: 15

  The currency of the preview subscription.
• MetricAmount: number
  Title: Metric Amount

  The monetary metric values.
• MetricClassification: string
  Title: Metric Classification

  Maximum Length: 120

  Classification assigned to the metric based on its evaluated value.
• MetricCount: integer (int64)
  Title: Metric Count

  The count-based metric values.
• MetricDate: string (date)
  Title: Metric Date

  The effective start date of the metric calculation.
• MetricError: string
  Title: Metric Error

  Maximum Length: 4000

  The error for an metric.
• MetricExplainability: string (byte)
  Title: Metric Explanation

  The explanation that describes how the metric insight or value was derived.
• MetricScore: number
  Title: Metric Score

  The computed score or percentage value.
• MetricTypeCode: string
  Title: Metric Type Code

  Maximum Length: 64

  The metric code for different metric type.
• MetricUnit: string
  Title: Metric Unit

  Maximum Length: 100

  The name of the metric component calculated.
• ObjectVersionNumber: integer (int32)
  The version number of the runtime metric detail record for concurrency control.
• RecordSourceType: string
  Title: Record Source Type

  Maximum Length: 64

  Indicates whether the metric record is system-calculated or externally imported.
• RuntimeMetricDetailId: integer (int64)
  Title: Runtime Metric Detail Id

  The unique identifier for each metric detail result record.
• RuntimeMetricDetailPuid: string
  Title: Runtime Metric Detail PUID

  Maximum Length: 120

  The public unique identifier (PUID) of the associated runtime metric detail.
• RuntimeMetricId: integer (int64)
  Title: Runtime Metric Id

  The metric execution instance in Runtime Metrics.
• RuntimeMetricPuid: string
  Title: Runtime Metric PUID

  Public unique identifier (PUID) for the runtime metric record.
• SubscriptionProductPuid: string
  Title: Subscription Product PUID

  Alternate key or persistent unique identifier of the subscription product on which the metric is computed.

{
    "type":"object",
    "properties":{
        "BalanceUnitofMeasureCode":{
            "title":"Balance Unit of Measure Code",
            "maxLength":3,
            "type":"string",
            "description":"The balance unit of measure class code of the subscription balance code.",
            "nullable":true
        },
        "CoveredLevelPuid":{
            "title":"Covered Level PUID",
            "type":"string",
            "description":"The public unique identifier for the product association for the metric.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "Currency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the preview subscription.",
            "nullable":true
        },
        "MetricAmount":{
            "title":"Metric Amount",
            "type":"number",
            "description":"The monetary metric values.",
            "nullable":true
        },
        "MetricClassification":{
            "title":"Metric Classification",
            "maxLength":120,
            "type":"string",
            "description":"Classification assigned to the metric based on its evaluated value.",
            "nullable":true
        },
        "MetricCount":{
            "title":"Metric Count",
            "type":"integer",
            "description":"The count-based metric values.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MetricDate":{
            "title":"Metric Date",
            "type":"string",
            "description":"The effective start date of the metric calculation.",
            "format":"date",
            "nullable":true
        },
        "MetricError":{
            "title":"Metric Error",
            "maxLength":4000,
            "type":"string",
            "description":"The error for an metric.",
            "nullable":true
        },
        "MetricExplainability":{
            "title":"Metric Explanation",
            "type":"string",
            "description":"The explanation that describes how the metric insight or value was derived.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MetricScore":{
            "title":"Metric Score",
            "type":"number",
            "description":"The computed score or percentage value.",
            "nullable":true
        },
        "MetricTypeCode":{
            "title":"Metric Type Code",
            "maxLength":64,
            "type":"string",
            "description":"The metric code for different metric type.",
            "nullable":true
        },
        "MetricUnit":{
            "title":"Metric Unit",
            "maxLength":100,
            "type":"string",
            "description":"The name of the metric component calculated.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the runtime metric detail record for concurrency control.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "RecordSourceType":{
            "title":"Record Source Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates whether the metric record is system-calculated or externally imported.",
            "nullable":true
        },
        "RuntimeMetricDetailId":{
            "title":"Runtime Metric Detail Id",
            "type":"integer",
            "description":"The unique identifier for each metric detail result record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuntimeMetricDetailPuid":{
            "title":"Runtime Metric Detail PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier (PUID) of the associated runtime metric detail.",
            "nullable":false
        },
        "RuntimeMetricId":{
            "title":"Runtime Metric Id",
            "type":"integer",
            "description":"The metric execution instance in Runtime Metrics.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuntimeMetricPuid":{
            "title":"Runtime Metric PUID",
            "type":"string",
            "description":"Public unique identifier (PUID) for the runtime metric record.",
            "nullable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "type":"string",
            "description":"Alternate key or persistent unique identifier of the subscription product on which the metric is computed.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionProducts-subscriptionProductMetrics-item-response

Type: object

Show Source

• BalanceUnitofMeasureCode: string
  Title: Balance Unit of Measure Code

  Maximum Length: 3

  The balance unit of measure class code of the subscription balance code.
• CoveredLevelPuid: string
  Title: Covered Level PUID

  The public unique identifier for the product association for the metric.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the runtime metric detail record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the runtime metric detail was created.
• Currency: string
  Title: Currency

  Maximum Length: 15

  The currency of the preview subscription.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the runtime metric detail was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the runtime metric detail.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login session used to perform the last update on the runtime metric detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricAmount: number
  Title: Metric Amount

  The monetary metric values.
• MetricClassification: string
  Title: Metric Classification

  Maximum Length: 120

  Classification assigned to the metric based on its evaluated value.
• MetricCount: integer (int64)
  Title: Metric Count

  The count-based metric values.
• MetricDate: string (date)
  Title: Metric Date

  The effective start date of the metric calculation.
• MetricError: string
  Title: Metric Error

  Maximum Length: 4000

  The error for an metric.
• MetricExplainability: string (byte)
  Title: Metric Explanation

  The explanation that describes how the metric insight or value was derived.
• MetricScore: number
  Title: Metric Score

  The computed score or percentage value.
• MetricTypeCode: string
  Title: Metric Type Code

  Maximum Length: 64

  The metric code for different metric type.
• MetricUnit: string
  Title: Metric Unit

  Maximum Length: 100

  The name of the metric component calculated.
• ObjectVersionNumber: integer (int32)
  The version number of the runtime metric detail record for concurrency control.
• RecordSourceType: string
  Title: Record Source Type

  Maximum Length: 64

  Indicates whether the metric record is system-calculated or externally imported.
• RuntimeMetricDetailId: integer (int64)
  Title: Runtime Metric Detail Id

  The unique identifier for each metric detail result record.
• RuntimeMetricDetailPuid: string
  Title: Runtime Metric Detail PUID

  Maximum Length: 120

  The public unique identifier (PUID) of the associated runtime metric detail.
• RuntimeMetricId: integer (int64)
  Title: Runtime Metric Id

  The metric execution instance in Runtime Metrics.
• RuntimeMetricPuid: string
  Title: Runtime Metric PUID

  Public unique identifier (PUID) for the runtime metric record.
• SubscriptionNumber: string
  Title: Subscription Number

  Read Only: true

  Maximum Length: 120

  The subscription number on which metric is computed.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  Read Only: true

  Identifier of the subscription product on which the metric is computed.
• SubscriptionProductPuid: string
  Title: Subscription Product PUID

  Alternate key or persistent unique identifier of the subscription product on which the metric is computed.

{
    "type":"object",
    "properties":{
        "BalanceUnitofMeasureCode":{
            "title":"Balance Unit of Measure Code",
            "maxLength":3,
            "type":"string",
            "description":"The balance unit of measure class code of the subscription balance code.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelPuid":{
            "title":"Covered Level PUID",
            "type":"string",
            "description":"The public unique identifier for the product association for the metric.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the runtime metric detail record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the runtime metric detail was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the preview subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the runtime metric detail was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login session used to perform the last update on the runtime metric detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the runtime metric detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricAmount":{
            "title":"Metric Amount",
            "type":"number",
            "description":"The monetary metric values.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricClassification":{
            "title":"Metric Classification",
            "maxLength":120,
            "type":"string",
            "description":"Classification assigned to the metric based on its evaluated value.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricCount":{
            "title":"Metric Count",
            "type":"integer",
            "description":"The count-based metric values.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricDate":{
            "title":"Metric Date",
            "type":"string",
            "description":"The effective start date of the metric calculation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MetricError":{
            "title":"Metric Error",
            "maxLength":4000,
            "type":"string",
            "description":"The error for an metric.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricExplainability":{
            "title":"Metric Explanation",
            "type":"string",
            "description":"The explanation that describes how the metric insight or value was derived.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MetricScore":{
            "title":"Metric Score",
            "type":"number",
            "description":"The computed score or percentage value.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricTypeCode":{
            "title":"Metric Type Code",
            "maxLength":64,
            "type":"string",
            "description":"The metric code for different metric type.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricUnit":{
            "title":"Metric Unit",
            "maxLength":100,
            "type":"string",
            "description":"The name of the metric component calculated.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the runtime metric detail record for concurrency control.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RecordSourceType":{
            "title":"Record Source Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates whether the metric record is system-calculated or externally imported.",
            "nullable":true,
            "x-queryable":true
        },
        "RuntimeMetricDetailId":{
            "title":"Runtime Metric Detail Id",
            "type":"integer",
            "description":"The unique identifier for each metric detail result record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuntimeMetricDetailPuid":{
            "title":"Runtime Metric Detail PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier (PUID) of the associated runtime metric detail.",
            "nullable":false,
            "x-queryable":true
        },
        "RuntimeMetricId":{
            "title":"Runtime Metric Id",
            "type":"integer",
            "description":"The metric execution instance in Runtime Metrics.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuntimeMetricPuid":{
            "title":"Runtime Metric PUID",
            "type":"string",
            "description":"Public unique identifier (PUID) for the runtime metric record.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number on which metric is computed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"Identifier of the subscription product on which the metric is computed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "type":"string",
            "description":"Alternate key or persistent unique identifier of the subscription product on which the metric is computed.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top