mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
160 lines
8.9 KiB
JSON
160 lines
8.9 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"usage",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "OpportunityHistory - Data API",
|
||
"description": "Represents the stage history of an opportunity.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"Amount": {
|
||
"type": "currency",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "Estimated total sale amount."
|
||
},
|
||
"CloseDate": {
|
||
"type": "date",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "Date when the opportunity is expected to close."
|
||
},
|
||
"ExpectedRevenue": {
|
||
"type": "currency",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "Calculated revenue based on the Amount and Probability fields."
|
||
},
|
||
"ForecastCategory": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
||
"description": "Category that determines the column in which an opportunity is totaled in a forecast. Label is To ForecastCategory. BestCase Closed Forecast MostLikely Omitted Pipeline"
|
||
},
|
||
"IsDeleted": {
|
||
"type": "boolean",
|
||
"properties": "Defaulted on create, Filter",
|
||
"description": "Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted."
|
||
},
|
||
"OpportunityId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "ID of the associated Opportunity. This is a relationship field.",
|
||
"relationship_name": "Opportunity",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Opportunity"
|
||
},
|
||
"PrevAmount": {
|
||
"type": "currency",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The value in the opportunity’s Amount field before the update of the opportunity. In OpportunityHistory records created before Winter ’21, the value is null.Available in API version 50.0 and later."
|
||
},
|
||
"PrevCloseDate": {
|
||
"type": "date",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The value in the opportunity’s Close Date field before the update of the opportunity. In OpportunityHistory records created before Winter ’21, the value is null.Available in API version 50.0 and later."
|
||
},
|
||
"Probability": {
|
||
"type": "percent",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "Percentage of estimated confidence in closing the opportunity."
|
||
},
|
||
"StageName": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "Name of the current stage of the opportunity (for example, Prospect or Proposal)."
|
||
}
|
||
},
|
||
"usage": "This object represents the history of a change to the Amount, Probability, Stage, or Close Date fields of an Opportunity. The OpportunityFieldHistory object represents the history of a change to any of the fields of an Opportunity. To obtain information about how a particular opportunity is progressing, query the OpportunityHistory records associated with a given Opportunity. Please note that if an opportunity's Amount, Probability, Stage, or Close Date fields have not changed, nothing will be returned in the OpportunityHistory objects. In this case, query the OpportunityFieldHistory records associated with a given Opportunity to get more information about changes to the opportunity. This object is read-only. The system generates a new record whenever a user or client application changes the value of any of the above fields; the then-current values of all of these major fields are saved in the newly-generated object. This object respects field-level security on the parent object.\n\nThis object represents the history of a change to the Amount, Probability, Stage, or Close Date fields of an Opportunity. The OpportunityFieldHistory object represents the history of a change to any of the fields of an Opportunity. To obtain information about how a particular opportunity is progressing, query the OpportunityHistory records associated with a given Opportunity. Please note that if an opportunity's Amount, Probability, Stage, or Close Date fields have not changed, nothing will be returned in the OpportunityHistory objects. In this case, query the OpportunityFieldHistory records associated with a given Opportunity to get more information about changes to the opportunity.\n\nThis object is read-only. The system generates a new record whenever a user or client application changes the value of any of the above fields; the then-current values of all of these major fields are saved in the newly-generated object.\n\nThis object respects field-level security on the parent object.",
|
||
"wsdl_segment": "```xml\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<complexType name=\"OpportunityHistory\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Amount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"CloseDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"ExpectedRevenue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"ForecastCategory\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"OpportunitiesAmountChanged\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OpportunitiesCloseDateChanged\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Opportunity\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Opportunity\"/>\n <element name=\"OpportunityId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"PrevAmount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"PrevCloseDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"Probability\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"StageName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"Amount": {
|
||
"field_label": "Amount",
|
||
"type": "currency",
|
||
"precision": "18",
|
||
"scale": "2"
|
||
},
|
||
"CloseDate": {
|
||
"field_label": "Close Date",
|
||
"type": "date"
|
||
},
|
||
"CreatedById": {
|
||
"field_label": "Created By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"CreatedDate": {
|
||
"field_label": "Created Date",
|
||
"type": "datetime"
|
||
},
|
||
"CurrencyIsoCode": {
|
||
"field_label": "Currency ISO Code",
|
||
"type": "picklist",
|
||
"length": "3"
|
||
},
|
||
"ExpectedRevenue": {
|
||
"field_label": "Expected Revenue",
|
||
"type": "currency",
|
||
"precision": "18",
|
||
"scale": "2"
|
||
},
|
||
"ForecastCategory": {
|
||
"field_label": "To Forecast Category",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"Id": {
|
||
"field_label": "Opportunity History ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"OpportunityId": {
|
||
"field_label": "Opportunity ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"PrevAmount": {
|
||
"field_label": "Previous Amount",
|
||
"type": "currency",
|
||
"precision": "18",
|
||
"scale": "2"
|
||
},
|
||
"PrevCloseDate": {
|
||
"field_label": "Previous Close Date",
|
||
"type": "date"
|
||
},
|
||
"Probability": {
|
||
"field_label": "Probability",
|
||
"type": "percent",
|
||
"precision": "3",
|
||
"scale": "0"
|
||
},
|
||
"StageName": {
|
||
"field_label": "Stage Name",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"precision",
|
||
"scale",
|
||
"length"
|
||
]
|
||
} |