afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ForecastingGroupItem.json

114 lines
3.5 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"usage",
"field_reference"
],
"title": "ForecastingGroupItem - Data API",
"description": "Represents the value within the picklist that is specified as the forecasting group for a forecast type. For example, if you have a forecasting group that identifies the industry an opportunity is part of, this object represents the value in the the industry picklist thats chosen to be part of the group. This object is available in API version 60.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"DisplayPosition": {
"type": "int",
"properties": "Create, Filter, Group, Sort, Update",
"description": "Indicates the order in which the value displays among other values in the group on the forecasts page."
},
"ForecastingGroupId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "This field is a relationship field.",
"relationship_name": "ForecastingGroup",
"relationship_type": "Lookup",
"refers_to": "ForecastingGroup"
},
"SourceValueApiName": {
"type": "string",
"properties": "Create, Filter, Nillable, Sort",
"description": "The API name thats derived from the group value."
},
"SourceValueLabel": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "The label thats derived from the group value."
},
"SourceValueTranslatedLabel": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "If one exists, the translated version of the group value."
}
},
"usage": "New forecast types based on opportunities or opportunity products can include a forecasting group. This group is based on a custom, single-selection picklist thats defined on the Opportunity, OpportunityLineItem, or Product2 objects. The picklist thats chosen for the group can contain more values than are needed for the type.",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"DisplayPosition": {
"field_label": "Display Position",
"type": "int",
"digits": "9"
},
"ForecastingGroupId": {
"field_label": "Forecasting Group ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Forecasting Group Item ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"SourceValueApiName": {
"field_label": "Source Value API Name",
"type": "string",
"length": "765"
},
"SourceValueLabel": {
"field_label": "Source Value Label",
"type": "string",
"length": "765"
},
"SourceValueTranslatedLabel": {
"field_label": "Source Value Translated Label",
"type": "string",
"length": "765"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}