Jump to

• Request
• Response

Get a sales forecast historic metric

get

/crmRestApi/resources/11.13.18.05/salesForecastHistoricMetrics/{MetricId}

Request

Path Parameters

• MetricId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : salesForecastHistoricMetrics-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  The user who created the sales forecast historic metric.
• CreationDate: string (date-time)
  The date when the sales forecast historic metric was created.
• Dim1RootFlag: boolean
  Maximum Length: 1

  The root flag for the first dimension of the sales forecast historic metric.
• Dim2RootFlag: boolean
  Maximum Length: 1

  The root flag for the second dimension of the sales forecast historic metric.
• Dim3RootFlag: boolean
  Maximum Length: 1

  The root flag for the third dimension of the sales forecast historic metric.
• Dim4RootFlag: boolean
  Maximum Length: 1

  The root flag for the fourth dimension of the sales forecast historic metric.
• Dim5RootFlag: boolean
  Maximum Length: 1

  The root flag for the fifth dimension of the sales forecast historic metric.
• LastUpdateDate: string (date-time)
  The date when the sales forecast historic metric was last updated.
• LastUpdatedBy: string
  Maximum Length: 64

  The user who last updated the sales forecast historic metric.
• LastUpdateLogin: string
  Maximum Length: 32

  The login of the user who last updated the sales forecast historic metric.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricCode: string
  Maximum Length: 100

  The metric code for the sales forecast historic metric.
• MetricDim1Key: integer (int64)
  The metric key for the first dimension of sales forecast historic metric.
• MetricDim2Key: integer (int64)
  The metric key for the second dimension of sales forecast historic metric.
• MetricDim3Key: integer (int64)
  The metric key for the third dimension of sales forecast historic metric.
• MetricDim4Key: integer (int64)
  The metric key for the fourth dimension of sales forecast historic metric.
• MetricDim5Key: integer (int64)
  The metric key for the fifth dimension of sales forecast historic metric.
• MetricId: integer (int64)
  The metric identifier for the sales forecast historic metric.
• MetricLevel: string
  Maximum Length: 30

  The metric level for the sales forecast historic metric.
• MetricSrcCode: string
  Maximum Length: 100

  The metric source code for the sales forecast historic metric.
• MetricValue: number
  The metric value for the sales forecast historic metric.
• ObjectVersionNumber: integer (int32)
  The object version number for the sales forecast historic metric.
• PeriodId: integer (int64)
  The period identifier for the sales forecast historic metric.
• RootMetricDim1Key: integer (int64)
  The metric key of the root element of the first dimension of the sales forecast historic metric.
• SnapshotId: integer (int64)
  The snapshot identifier for the sales forecast historic metric.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales forecast historic metric.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales forecast historic metric was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Dim1RootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The root flag for the first dimension of the sales forecast historic metric.",
            "nullable":true,
            "x-queryable":true
        },
        "Dim2RootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The root flag for the second dimension of the sales forecast historic metric.",
            "nullable":true,
            "x-queryable":true
        },
        "Dim3RootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The root flag for the third dimension of the sales forecast historic metric.",
            "nullable":true,
            "x-queryable":true
        },
        "Dim4RootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The root flag for the fourth dimension of the sales forecast historic metric.",
            "nullable":true,
            "x-queryable":true
        },
        "Dim5RootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The root flag for the fifth dimension of the sales forecast historic metric.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales forecast historic metric was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the sales forecast historic metric.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales forecast historic metric.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the sales forecast historic metric.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricDim1Key":{
            "type":"integer",
            "description":"The metric key for the first dimension of sales forecast historic metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricDim2Key":{
            "type":"integer",
            "description":"The metric key for the second dimension of sales forecast historic metric.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricDim3Key":{
            "type":"integer",
            "description":"The metric key for the third dimension of sales forecast historic metric.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricDim4Key":{
            "type":"integer",
            "description":"The metric key for the fourth dimension of sales forecast historic metric.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricDim5Key":{
            "type":"integer",
            "description":"The metric key for the fifth dimension of sales forecast historic metric.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricId":{
            "type":"integer",
            "description":"The metric identifier for the sales forecast historic metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The metric level for the sales forecast historic metric.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricSrcCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric source code for the sales forecast historic metric.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricValue":{
            "type":"number",
            "description":"The metric value for the sales forecast historic metric.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the sales forecast historic metric.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PeriodId":{
            "type":"integer",
            "description":"The period identifier for the sales forecast historic metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RootMetricDim1Key":{
            "type":"integer",
            "description":"The metric key of the root element of the first dimension of the sales forecast historic metric.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SnapshotId":{
            "type":"integer",
            "description":"The snapshot identifier for the sales forecast historic metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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