Jump to

• Request
• Response

Get a sales forecast metric source item

get

/crmRestApi/resources/11.13.18.05/salesForecastMetricSourceItems/{salesForecastMetricSourceItemsUniqID}

Request

Path Parameters

• salesForecastMetricSourceItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- MetricSrcPk1, MetricSrcPk2 and MetricSrcPk3 ---for the (salesForecastMetricSourceItems) resource and used to uniquely identify an instance of (salesForecastMetricSourceItems). The client should not generate the hash key value. Instead, the client should query on the (salesForecastMetricSourceItems) collection resource with a filter on the primary key values in order to navigate to a specific instance of (salesForecastMetricSourceItems).
  
  For example: salesForecastMetricSourceItems?q=MetricSrcPk1=<value1>;MetricSrcPk2=<value2>;MetricSrcPk3=<value3>

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:
  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.

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

Type: object

Show Source

• DiagnosticQuery: string
  Read Only: true

  Maximum Length: 10000

  The parameter for gathering internal diagnostics for sales forecast metric source items. The default value is null.
• Dim1Code: string
  Read Only: true

  Maximum Length: 100

  The dimension code of the first registered dimension.
• Dim1Key: integer (int64)
  Read Only: true

  The dimension key of the first registered dimension.
• Dim1Name: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the first registered dimension.
• Dim1ParentKey: integer (int64)
  Read Only: true

  The dimension key of the first registered dimension for the parent.
• Dim1ParentName: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the first registered dimension for the parent.
• Dim2Code: string
  Read Only: true

  Maximum Length: 100

  The dimension code of the second registered dimension.
• Dim2Key: integer (int64)
  Read Only: true

  The dimension key of the second registered dimension.
• Dim2Name: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the second registered dimension.
• Dim2ParentKey: integer (int64)
  Read Only: true

  The dimension key of the second registered dimension for the parent.
• Dim2ParentName: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the second registered dimension for the parent.
• Dim2RootFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sales forecast metric source item is the root value of the second registered dimension. The values accepted are true or false.
• Dim3Code: string
  Read Only: true

  Maximum Length: 100

  The dimension code of the third registered dimension.
• Dim3Key: integer (int64)
  Read Only: true

  The dimension key of the third registered dimension.
• Dim3Name: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the third registered dimension.
• Dim3ParentKey: integer (int64)
  Read Only: true

  The dimension key of the third registered dimension for the parent.
• Dim3ParentName: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the third registered dimension for the parent.
• Dim3RootFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sales forecast metric source item is the root value of the third registered dimension. The values accepted are true or false.
• Dim4Code: string
  Read Only: true

  Maximum Length: 100

  The dimension code of the fourth registered dimension.
• Dim4Key: integer (int64)
  Read Only: true

  The dimension key of the fourth registered dimension.
• Dim4Name: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the fourth registered dimension.
• Dim4ParentKey: integer (int64)
  Read Only: true

  The dimension key of the fourth registered dimension for the parent.
• Dim4ParentName: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the fourth registered dimension for the parent.
• Dim4RootFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sales forecast metric source item is the root value of the fourth registered dimension. The values accepted are true or false.
• Dim5Code: string
  Read Only: true

  Maximum Length: 100

  The dimension code of the fifth registered dimension.
• Dim5Key: integer (int64)
  Read Only: true

  The dimension key of the fifth registered dimension.
• Dim5Name: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the fifth registered dimension.
• Dim5ParentKey: integer (int64)
  Read Only: true

  The dimension key of the fifth registered dimension for the parent.
• Dim5ParentName: string
  Read Only: true

  Maximum Length: 1000

  The dimension name of the fifth registered dimension for the parent.
• Dim5RootFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sales forecast metric source item is the root value of the fifth registered dimension. The values accepted are true or false.
• IsAdjusted: integer (int64)
  Read Only: true

  Indicates whether the sales forecast metric source item is adjusted. The values accepted are true or false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricCode: string
  Read Only: true

  Maximum Length: 100

  The name of the sales forecast metric.
• MetricLevel: string
  Read Only: true

  Maximum Length: 100

  The level of the adjustment of the sales forecast metric source item. Values include TOTAL representing the adjustments made by the current user and-SUB representing adjustments made by subordinates.
• MetricSourceGrain: string
  Read Only: true

  Maximum Length: 100

  The metric source grain of the sales forecast metric source items which identifies whether summary or detail level information is provided. By default summary level information is provided. If the metric source grain value is DETAIL then detail level information is provided.
• MetricSrcPk1: integer
  Read Only: true

  The first unique identifier of the sales forecast metric source item.
• MetricSrcPk2: string
  Read Only: true

  The second unique identifier of the sales forecast metric source item.
• MetricSrcPk3: string
  Read Only: true

  The third unique identifier of the sales forecast metric source item.
• PeriodId: integer (int64)
  Read Only: true

  The unique identifier of the forecast metric source item period.
• RootParticipantId: integer (int64)
  Read Only: true

  The unique identifier of the forecast metric source item root participant.
• SrcItemAccount: string
  Read Only: true

  Maximum Length: 900

  The account for the forecast metric source item.
• SrcItemCloseDate: string (date)
  Read Only: true

  The close date for the forecast metric source item.
• SrcItemMetricValue: number
  Read Only: true

  The item metric value for the source item.
• SrcItemName: string
  Read Only: true

  Maximum Length: 275

  The item metric name for the source item.
• SrcItemNumber: string
  Read Only: true

  Maximum Length: 30

  The item metric number for the source item.
• SrcMetricCode: string
  Read Only: true

  Maximum Length: 100

  The item metric code for the source item.
• UnadjItemMetricValue: number
  Read Only: true

  The sales forecast metric source item value prior to adjustments such as the value of the opportunity.

{
    "type":"object",
    "properties":{
        "Dim3Name":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the third registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrcItemCloseDate":{
            "type":"string",
            "description":"The close date for the forecast metric source item.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim1Code":{
            "maxLength":"100",
            "type":"string",
            "description":"The dimension code of the first registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim2Code":{
            "maxLength":"100",
            "type":"string",
            "description":"The dimension code of the second registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsAdjusted":{
            "type":"integer",
            "description":"Indicates whether the sales forecast metric source item is adjusted. The values accepted are true or false.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrcMetricCode":{
            "maxLength":"100",
            "type":"string",
            "description":"The item metric code for the source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiagnosticQuery":{
            "maxLength":"10000",
            "type":"string",
            "description":"The parameter for gathering internal diagnostics for sales forecast metric source items. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim3ParentKey":{
            "type":"integer",
            "description":"The dimension key of the third registered dimension for the parent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Dim2ParentKey":{
            "type":"integer",
            "description":"The dimension key of the second registered dimension for the parent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Dim2ParentName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the second registered dimension for the parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim4RootFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales forecast metric source item is the root value of the fourth registered dimension. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnadjItemMetricValue":{
            "type":"number",
            "description":"The sales forecast metric source item value prior to adjustments such as the value of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim3ParentName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the third registered dimension for the parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim5Code":{
            "maxLength":"100",
            "type":"string",
            "description":"The dimension code of the fifth registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim5RootFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales forecast metric source item is the root value of the fifth registered dimension. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim2Name":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the second registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim2Key":{
            "type":"integer",
            "description":"The dimension key of the second registered dimension.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Dim2RootFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales forecast metric source item is the root value of the second registered dimension. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricLevel":{
            "maxLength":"100",
            "type":"string",
            "description":"The level of the adjustment of the sales forecast metric source item. Values include TOTAL representing the adjustments made by the current user and-SUB representing adjustments made by subordinates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim4Key":{
            "type":"integer",
            "description":"The dimension key of the fourth registered dimension.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Dim3RootFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales forecast metric source item is the root value of the third registered dimension. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim5ParentKey":{
            "type":"integer",
            "description":"The dimension key of the fifth registered dimension for the parent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Dim5ParentName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the fifth registered dimension for the parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricSrcPk3":{
            "type":"string",
            "description":"The third unique identifier of the sales forecast metric source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim1Name":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the first registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim4Code":{
            "maxLength":"100",
            "type":"string",
            "description":"The dimension code of the fourth registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the forecast metric source item root participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MetricSrcPk2":{
            "type":"string",
            "description":"The second unique identifier of the sales forecast metric source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricSrcPk1":{
            "type":"integer",
            "description":"The first unique identifier of the sales forecast metric source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim4ParentKey":{
            "type":"integer",
            "description":"The dimension key of the fourth registered dimension for the parent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrcItemAccount":{
            "maxLength":"900",
            "type":"string",
            "description":"The account for the forecast metric source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodId":{
            "type":"integer",
            "description":"The unique identifier of the forecast metric source item period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Dim1ParentName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the first registered dimension for the parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim3Code":{
            "maxLength":"100",
            "type":"string",
            "description":"The dimension code of the third registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim5Name":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the fifth registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrcItemNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The item metric number for the source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim4Name":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the fourth registered dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim3Key":{
            "type":"integer",
            "description":"The dimension key of the third registered dimension.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MetricCode":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the sales forecast metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrcItemMetricValue":{
            "type":"number",
            "description":"The item metric value for the source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim4ParentName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension name of the fourth registered dimension for the parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrcItemName":{
            "maxLength":"275",
            "type":"string",
            "description":"The item metric name for the source item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dim1Key":{
            "type":"integer",
            "description":"The dimension key of the first registered dimension.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Dim1ParentKey":{
            "type":"integer",
            "description":"The dimension key of the first registered dimension for the parent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Dim5Key":{
            "type":"integer",
            "description":"The dimension key of the fifth registered dimension.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MetricSourceGrain":{
            "maxLength":"100",
            "type":"string",
            "description":"The metric source grain of the sales forecast metric source items which identifies whether summary or detail level information is provided. By default summary level information is provided. If the metric source grain value is DETAIL then detail level information is provided.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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