Jump to

• Request
• Response

Get a sales forecast metric source

get

/crmRestApi/resources/11.13.18.05/salesForecastMetricSources/{MetricSrcCode}

Request

Path Parameters

• MetricSrcCode(required): string
  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 : salesForecastMetricSources-item-response

Type: object

Show Source

• ActivePeriods: integer (int32)
  The number of active periods of the sales forecast metric source.
• ChildMetricDefinitions: array Sales Forecast Metric Definitions
  Title: Sales Forecast Metric Definitions

  The sales forecast metric definition is used to view and manage the definitions of sales forecast metrics such as Best Case and Commit metric sources.
• ChildMetricSourceDimensionMappings: array Sales Forecast Metric Source Dimension Mappings
  Title: Sales Forecast Metric Source Dimension Mappings

  The sales forecast metric source dimension mappings resource captures a dimension mapping for a given metric source. It indicates the list of dimensions that are supported for a metric source.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the sales forecast metric source.
• CreationDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric source was created.
• CustomSourceCriteriaExpr: string
  Maximum Length: 4000

  The custom source criteria expression of the sales forecast metric source.
• FilterDimList: string
  Maximum Length: 1000

  The list of filter dimensions for the sales forecast metric source.
• ItemAdjustmentAllowed: string
  Maximum Length: 1

  Indicates whether the metric source allows item adjustments. The values accepted are Y or null.
• JobRequestId: integer
  The submitted process identifier of the sales forecast metric source.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric source was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the sales forecast metric source.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  The code of metric dimension 1 of the sales forecast metric source.
• MetricDim1FilterFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether metric dimension 1 is used for filtering forecasts. The values accepted are true or false.
• MetricDim1MultiSelectFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the metric dimension 1 filter allows selecting multiple values.The values accepted are true or false.
• MetricDim1Name: string
  Read Only: true

  The name of metric dimension 1 of the sales forecast metric source.
• MetricDim1Type: string
  Read Only: true

  Maximum Length: 255

  The type of metric dimension 1 of the sales forecast metric source.
• MetricDim2Code: string
  Maximum Length: 100

  The code of metric dimension 2 of the sales forecast metric source.
• MetricDim2FilterFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether metric dimension 2 is used for filtering forecasts. The values accepted are true or false.
• MetricDim2MultiSelectFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the metric dimension 2 filter allows selecting multiple values.The values accepted are true or false.
• MetricDim2Name: string
  Read Only: true

  The name of metric dimension 2 of the sales forecast metric source.
• MetricDim2Type: string
  Read Only: true

  Maximum Length: 255

  The type of metric dimension 2 of the sales forecast metric source.
• MetricDim3Code: string
  Maximum Length: 100

  The code of metric dimension 3 of the sales forecast metric source.
• MetricDim3FilterFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether metric dimension 3 is used for filtering forecasts. The values accepted are true or false.
• MetricDim3MultiSelectFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the metric dimension 3 filter allows selecting multiple values.The values accepted are true or false.
• MetricDim3Name: string
  Read Only: true

  The name of metric dimension 3 of the sales forecast metric source.
• MetricDim3Type: string
  Read Only: true

  Maximum Length: 255

  The type of metric dimension 3 of the sales forecast metric source.
• MetricDim4Code: string
  Maximum Length: 100

  The code of metric dimension 4 of the sales forecast metric source.
• MetricDim4FilterFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether metric dimension 4 is used for filtering forecasts. The values accepted are true or false.
• MetricDim4MultiSelectFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the metric dimension 4 filter allows selecting multiple values.The values accepted are true or false.
• MetricDim4Name: string
  Read Only: true

  The name of metric dimension 4 of the sales forecast metric source.
• MetricDim4Type: string
  Read Only: true

  Maximum Length: 255

  The type of metric dimension 4 of the sales forecast metric source.
• MetricDim5Code: string
  Maximum Length: 100

  The code of metric dimension 5 of the sales forecast metric source.
• MetricDim5FilterFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether metric dimension 5 is used for filtering forecasts. The values accepted are true or false.
• MetricDim5MultiSelectFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the metric dimension 5 filter allows selecting multiple values.The values accepted are true or false.
• MetricDim5Name: string
  Read Only: true

  The name of metric dimension 5 of the sales forecast metric source.
• MetricDim5Type: string
  Read Only: true

  Maximum Length: 255

  The type of metric dimension 5 of the sales forecast metric source.
• MetricSourceReferenceColumns: array Metric Source Reference Columns
  Title: Metric Source Reference Columns

  The metric source reference columns resource is used to manage the reference columns for a metric source. These attributes for opportunity or revenue are compared with the current version of the attributes to identify the changes.
• MetricSrcCode: string
  Maximum Length: 100

  The metric source code of the sales forecast metric source.
• MetricSrcObject: string
  Maximum Length: 100

  The object of the sales forecast metric source. Sample values are OPPORTUNITY and REVENUE.
• MultiSelectDimList: string
  Maximum Length: 1000

  The list of multiple select filter dimensions for the sales forecast metric source.
• Name: string
  Maximum Length: 300

  The name of the sales forecast metric source.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the sales forecast metric source.
• StatusCode: string
  Maximum Length: 20

  The status code of the sales forecast metric source. The values accepted are ACTIVE, DISABLED and DRAFT.
• SummaryAdjustmentAllowedLevel: string
  Maximum Length: 20

  The level of summary adjustments allowed for the sales forecast metric source.
• SummaryAdjustmentDimensionList: string
  Maximum Length: 1000

  The list of summary adjustment dimensions for the sales forecast metric source.

{
    "type":"object",
    "properties":{
        "MetricDim3Name":{
            "type":"string",
            "description":"The name of metric dimension 3 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales forecast metric source was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricSrcObject":{
            "maxLength":100,
            "type":"string",
            "description":"The object of the sales forecast metric source. Sample values are OPPORTUNITY and REVENUE.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricSourceReferenceColumns":{
            "title":"Metric Source Reference Columns",
            "type":"array",
            "description":"The metric source reference columns resource is used to manage the reference columns for a metric source. These attributes for opportunity or revenue are compared with the current version of the attributes to identify the changes.",
            "items":{
                "$ref":"#/components/schemas/salesForecastMetricSources-MetricSourceReferenceColumns-item-response"
            }
        },
        "JobRequestId":{
            "type":"integer",
            "description":"The submitted process identifier of the sales forecast metric source.",
            "nullable":true,
            "x-queryable":false
        },
        "MetricDim1Code":{
            "maxLength":100,
            "type":"string",
            "description":"The code of metric dimension 1 of the sales forecast metric source.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricDim2MultiSelectFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric dimension 2 filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim4FilterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether metric dimension 4 is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":20,
            "type":"string",
            "description":"The status code of the sales forecast metric source. The values accepted are ACTIVE, DISABLED and DRAFT.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDim2Type":{
            "maxLength":255,
            "type":"string",
            "description":"The type of metric dimension 2 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":300,
            "type":"string",
            "description":"The name of the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomSourceCriteriaExpr":{
            "maxLength":4000,
            "type":"string",
            "description":"The custom source criteria expression of the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivePeriods":{
            "type":"integer",
            "description":"The number of active periods of the sales forecast metric source.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "MetricDim5Type":{
            "maxLength":255,
            "type":"string",
            "description":"The type of metric dimension 5 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim1MultiSelectFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric dimension 1 filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim4Name":{
            "type":"string",
            "description":"The name of metric dimension 4 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim2Code":{
            "maxLength":100,
            "type":"string",
            "description":"The code of metric dimension 2 of the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the sales forecast metric source.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MetricDim3FilterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether metric dimension 3 is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MetricDim1Type":{
            "maxLength":255,
            "type":"string",
            "description":"The type of metric dimension 1 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim1FilterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether metric dimension 1 is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales forecast metric source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim4Type":{
            "maxLength":255,
            "type":"string",
            "description":"The type of metric dimension 4 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales forecast metric source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChildMetricSourceDimensionMappings":{
            "title":"Sales Forecast Metric Source Dimension Mappings",
            "type":"array",
            "description":"The sales forecast metric source dimension mappings resource captures a dimension mapping for a given metric source. It indicates the list of dimensions that are supported for a metric source.",
            "items":{
                "$ref":"#/components/schemas/salesForecastMetricSources-ChildMetricSourceDimensionMappings-item-response"
            }
        },
        "MetricDim5MultiSelectFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric dimension 5 filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim4Code":{
            "maxLength":100,
            "type":"string",
            "description":"The code of metric dimension 4 of the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDim3Code":{
            "maxLength":100,
            "type":"string",
            "description":"The code of metric dimension 3 of the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDim5Name":{
            "type":"string",
            "description":"The name of metric dimension 5 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim1Name":{
            "type":"string",
            "description":"The name of metric dimension 1 of the sales forecast metric source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemAdjustmentAllowed":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the metric source allows item adjustments. The values accepted are Y or null.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDim5FilterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether metric dimension 5 is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SummaryAdjustmentAllowedLevel":{
            "maxLength":20,
            "type":"string",
            "description":"The level of summary adjustments allowed for the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "SummaryAdjustmentDimensionList":{
            "maxLength":1000,
            "type":"string",
            "description":"The list of summary adjustment dimensions for the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDim4MultiSelectFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric dimension 4 filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim5Code":{
            "maxLength":100,
            "type":"string",
            "description":"The code of metric dimension 5 of the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDim3MultiSelectFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric dimension 3 filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricSrcCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric source code of the sales forecast metric source.",
            "nullable":false,
            "x-queryable":true
        },
        "ChildMetricDefinitions":{
            "title":"Sales Forecast Metric Definitions",
            "type":"array",
            "description":"The sales forecast metric definition is used to view and manage the definitions of sales forecast metrics such as Best Case and Commit metric sources.",
            "items":{
                "$ref":"#/components/schemas/salesForecastMetricSources-ChildMetricDefinitions-item-response"
            }
        },
        "MetricDim2FilterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether metric dimension 2 is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim3Type":{
            "maxLength":255,
            "type":"string",
            "description":"The type of metric dimension 3 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDim2Name":{
            "type":"string",
            "description":"The name of metric dimension 2 of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultiSelectDimList":{
            "maxLength":1000,
            "type":"string",
            "description":"The list of multiple select filter dimensions for the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales forecast metric source was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last updated login of the sales forecast metric source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FilterDimList":{
            "maxLength":1000,
            "type":"string",
            "description":"The list of filter dimensions for the sales forecast metric source.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Sales Forecast Metric Definitions

Type: array

Title: Sales Forecast Metric Definitions

The sales forecast metric definition is used to view and manage the definitions of sales forecast metrics such as Best Case and Commit metric sources.

Show Source

• Array of: object salesForecastMetricSources-ChildMetricDefinitions-item-response

{
    "title":"Sales Forecast Metric Definitions",
    "type":"array",
    "description":"The sales forecast metric definition is used to view and manage the definitions of sales forecast metrics such as Best Case and Commit metric sources.",
    "items":{
        "$ref":"#/components/schemas/salesForecastMetricSources-ChildMetricDefinitions-item-response"
    }
}

Nested Schema : Sales Forecast Metric Source Dimension Mappings

Type: array

Title: Sales Forecast Metric Source Dimension Mappings

The sales forecast metric source dimension mappings resource captures a dimension mapping for a given metric source. It indicates the list of dimensions that are supported for a metric source.

Show Source

• Array of: object salesForecastMetricSources-ChildMetricSourceDimensionMappings-item-response

{
    "title":"Sales Forecast Metric Source Dimension Mappings",
    "type":"array",
    "description":"The sales forecast metric source dimension mappings resource captures a dimension mapping for a given metric source. It indicates the list of dimensions that are supported for a metric source.",
    "items":{
        "$ref":"#/components/schemas/salesForecastMetricSources-ChildMetricSourceDimensionMappings-item-response"
    }
}

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 : Metric Source Reference Columns

Type: array

Title: Metric Source Reference Columns

The metric source reference columns resource is used to manage the reference columns for a metric source. These attributes for opportunity or revenue are compared with the current version of the attributes to identify the changes.

Show Source

• Array of: object salesForecastMetricSources-MetricSourceReferenceColumns-item-response

{
    "title":"Metric Source Reference Columns",
    "type":"array",
    "description":"The metric source reference columns resource is used to manage the reference columns for a metric source. These attributes for opportunity or revenue are compared with the current version of the attributes to identify the changes.",
    "items":{
        "$ref":"#/components/schemas/salesForecastMetricSources-MetricSourceReferenceColumns-item-response"
    }
}

Nested Schema : salesForecastMetricSources-ChildMetricDefinitions-item-response

Type: object

Show Source

• AdjustableFlag: boolean
  Maximum Length: 1

  Indicates whether the sales forecast metric such as Best Case or Committed Forecast allows adjustments. The accepted values are Y or N.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the sales forecast metric definition.
• CreationDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric definition was created.
• CustomMetricCriteriaExpr: string
  Maximum Length: 4000

  The custom metric criteria expression of the sales forecast metric definition.
• CustomMetricSrcColumnExpr: string
  Maximum Length: 4000

  The custom metric source column expression of the sales forecast metric definition.
• DepndMetricCodeList: string
  Maximum Length: 300

  The list of dependent metric codes of the sales forecast metric definition.
• JobRequestId: integer
  The submitted process identifier of the sales forecast metric definition.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric definition was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the sales forecast metric definition.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  The metric code of the sales forecast metric definition.
• MetricDefnId: integer (int64)
  The metric definition identifier of the sales forecast metric definition.
• MetricName: string
  Read Only: true

  The metric name of the sales forecast metric definition.
• MetricSrcCode: string
  Maximum Length: 255

  The metric source code of the sales forecast metric definition.
• ObjectVersionNumber: integer (int32)
  The object version number of the sales forecast metric definition.
• StatusCode: string
  Maximum Length: 20

  The status code of the sales forecast metric definition.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales forecast metric definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales forecast metric definition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobRequestId":{
            "type":"integer",
            "description":"The submitted process identifier of the sales forecast metric definition.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales forecast metric definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDefnId":{
            "type":"integer",
            "description":"The metric definition identifier of the sales forecast metric definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomMetricSrcColumnExpr":{
            "maxLength":4000,
            "type":"string",
            "description":"The custom metric source column expression of the sales forecast metric definition.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomMetricCriteriaExpr":{
            "maxLength":4000,
            "type":"string",
            "description":"The custom metric criteria expression of the sales forecast metric definition.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":20,
            "type":"string",
            "description":"The status code of the sales forecast metric definition.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricName":{
            "type":"string",
            "description":"The metric name of the sales forecast metric definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepndMetricCodeList":{
            "maxLength":300,
            "type":"string",
            "description":"The list of dependent metric codes of the sales forecast metric definition.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the sales forecast metric definition.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AdjustableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sales forecast metric such as Best Case or Committed Forecast allows adjustments. The accepted values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric code of the sales forecast metric definition.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MetricSrcCode":{
            "maxLength":255,
            "type":"string",
            "description":"The metric source code of the sales forecast metric definition.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales forecast metric definition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last updated login of the sales forecast metric definition.",
            "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."
        }
    }
}

Nested Schema : salesForecastMetricSources-ChildMetricSourceDimensionMappings-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the sales forecast metric source dimension mapping.
• CreationDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric source dimension mapping was created.
• DimType: string
  Read Only: true

  Maximum Length: 30

  The dimension type of a metric source dimension mapping.
• FilterFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether metric source dimension mapping is used for filtering forecasts. The values accepted are true or false.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric source dimension mapping was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the sales forecast metric source dimension mapping.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MetricDimAttr: string
  Maximum Length: 1000

  The metric dimension attribute of the sales forecast metric source dimension mapping.
• MetricDimCode: string
  Maximum Length: 100

  The code that uniquely identifies a sales forecast metric source dimension mapping such as TERRITORY and PRODUCT.
• MetricSrcCode: string
  Maximum Length: 100

  The metric source code of the sales forecast metric source dimension mapping.
• MetricSrcDimMapId: integer (int64)
  The metric source dimension mapping identifier for the sales forecast metric source dimension mapping.
• MultiSelectFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the metric source dimension mapping filter allows selecting multiple values.The values accepted are true or false.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number for the sales forecast metric source dimension mapping.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales forecast metric source dimension mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales forecast metric source dimension mapping was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales forecast metric source dimension mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimAttr":{
            "maxLength":1000,
            "type":"string",
            "description":"The metric dimension attribute of the sales forecast metric source dimension mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "MultiSelectFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the metric source dimension mapping filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MetricDimCode":{
            "maxLength":100,
            "type":"string",
            "description":"The code that uniquely identifies a sales forecast metric source dimension mapping such as TERRITORY and PRODUCT.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the sales forecast metric source dimension mapping.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MetricSrcCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric source code of the sales forecast metric source dimension mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricSrcDimMapId":{
            "type":"integer",
            "description":"The metric source dimension mapping identifier for the sales forecast metric source dimension mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FilterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether metric source dimension mapping is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DimType":{
            "maxLength":30,
            "type":"string",
            "description":"The dimension type of a metric source dimension mapping.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales forecast metric source dimension mapping was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the sales forecast metric source dimension mapping.",
            "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 : salesForecastMetricSources-MetricSourceReferenceColumns-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the metric source reference column.
• CreationDate: string (date-time)
  Read Only: true

  The date when the metric source reference column was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the metric source reference column was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the metric source reference column.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the metric source reference column.
• links: array Links
  Title: Links

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

  The metric source code of the metric source reference column.
• MetricSrcReferenceColumnId: integer (int64)
  The unique identifier of the metric source reference column.
• ReferenceColumn: string
  Maximum Length: 4000

  The reference column for the metric source reference column.
• ReferenceColumnAlias: string
  Maximum Length: 4000

  The alias for the metric source reference column.
• ReferenceColumnDataType: string
  Maximum Length: 30

  The data type for the metric source reference column.
• ReferenceColumnTypeCode: string
  Maximum Length: 100

  The type code for the metric source reference column.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the metric source reference column.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceColumnTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The type code for the metric source reference column.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the metric source reference column was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricSrcReferenceColumnId":{
            "type":"integer",
            "description":"The unique identifier of the metric source reference column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the metric source reference column.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceColumnDataType":{
            "maxLength":30,
            "type":"string",
            "description":"The data type for the metric source reference column.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceColumn":{
            "maxLength":4000,
            "type":"string",
            "description":"The reference column for the metric source reference column.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceColumnAlias":{
            "maxLength":4000,
            "type":"string",
            "description":"The alias for the metric source reference column.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MetricSrcCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric source code of the metric source reference column.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the metric source reference column was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the metric source reference column.",
            "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"
    }
}

Links

ChildMetricDefinitions

Operation: /crmRestApi/resources/11.13.18.05/salesForecastMetricSources/{MetricSrcCode}/child/ChildMetricDefinitions

Parameters:

• MetricSrcCode: $request.path.MetricSrcCode

The sales forecast metric definition is used to view and manage the definitions of sales forecast metrics such as Best Case and Commit metric sources.

ChildMetricSourceDimensionMappings

Operation: /crmRestApi/resources/11.13.18.05/salesForecastMetricSources/{MetricSrcCode}/child/ChildMetricSourceDimensionMappings

Parameters:

• MetricSrcCode: $request.path.MetricSrcCode

The sales forecast metric source dimension mappings resource captures a dimension mapping for a given metric source. It indicates the list of dimensions that are supported for a metric source.

MetricSourceReferenceColumns

Operation: /crmRestApi/resources/11.13.18.05/salesForecastMetricSources/{MetricSrcCode}/child/MetricSourceReferenceColumns

Parameters:

• MetricSrcCode: $request.path.MetricSrcCode

The metric source reference columns resource is used to manage the reference columns for a metric source. These attributes for opportunity or revenue are compared with the current version of the attributes to identify the changes.

Back to Top