Jump to

• Request
• Response

Create a subscription metric type

post

/crmRestApi/resources/11.13.18.05/subscriptionMetricTypes

Request

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

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the metric type is currently active for processing.
• ApplicablePeriod: string
  Maximum Length: 64

  The time granularity at which the metric is calculated.
• MetricTypeCode: string
  Maximum Length: 64

  The metric for different metric type.
• MetricTypeId: integer (int64)
  The unique identifier for the metric type.
• ObjectVersionNumber: integer (int32)
  The version number of the metric type record for concurrency control.
• Period: string
  Maximum Length: 30

  The actual time period for which the metric is calculated.
• RunDate: string (date)
  The date when the metric evaluation process was executed.
• SeedDataSource: string
  Maximum Length: 512

  The seed data from which the metric type definition was derived.
• Status: string
  Maximum Length: 30

  The current execution status of the metric request.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric type is currently active for processing.",
            "nullable":false
        },
        "ApplicablePeriod":{
            "maxLength":64,
            "type":"string",
            "description":"The time granularity at which the metric is calculated.",
            "nullable":true
        },
        "MetricTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"The metric for different metric type.",
            "nullable":true
        },
        "MetricTypeId":{
            "type":"integer",
            "description":"The unique identifier for the metric type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the metric type record for concurrency control.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Period":{
            "maxLength":30,
            "type":"string",
            "description":"The actual time period for which the metric is calculated.",
            "nullable":true
        },
        "RunDate":{
            "type":"string",
            "description":"The date when the metric evaluation process was executed.",
            "format":"date",
            "nullable":true
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"The seed data from which the metric type definition was derived.",
            "nullable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The current execution status of the metric request.",
            "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 : subscriptionMetricTypes-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the metric type is currently active for processing.
• ApplicablePeriod: string
  Maximum Length: 64

  The time granularity at which the metric is calculated.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the metric type was created.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MetricTypeCode: string
  Maximum Length: 64

  The metric for different metric type.
• MetricTypeId: integer (int64)
  The unique identifier for the metric type.
• ObjectVersionNumber: integer (int32)
  The version number of the metric type record for concurrency control.
• Period: string
  Maximum Length: 30

  The actual time period for which the metric is calculated.
• RunDate: string (date)
  The date when the metric evaluation process was executed.
• SeedDataSource: string
  Maximum Length: 512

  The seed data from which the metric type definition was derived.
• Status: string
  Maximum Length: 30

  The current execution status of the metric request.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric type is currently active for processing.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicablePeriod":{
            "maxLength":64,
            "type":"string",
            "description":"The time granularity at which the metric is calculated.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the metric type record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the metric type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the metric type 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 metric type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the metric type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"The metric for different metric type.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricTypeId":{
            "type":"integer",
            "description":"The unique identifier for the metric type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the metric type record for concurrency control.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Period":{
            "maxLength":30,
            "type":"string",
            "description":"The actual time period for which the metric is calculated.",
            "nullable":true,
            "x-queryable":true
        },
        "RunDate":{
            "type":"string",
            "description":"The date when the metric evaluation process was executed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"The seed data from which the metric type definition was derived.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The current execution status of the metric request.",
            "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