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

111 lines
4.1 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",
"special_access_rules",
"associated_objects",
"field_reference"
],
"title": "UsageImpactFactor - Data API",
"description": "Represents a collection of fields to set up the Usage Impact Factors used across jurisdictions and programs.This object is available in API version 58.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"IsActive": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the Usage Impact Factor is active. The default value is false."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of the Usage Impact Factor."
},
"ShortForm": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The acronym of the Usage Impact Factor."
},
"Type": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Specifies the type of Usage Impact Factor Possible values are: AdjustedGrossAnnual—Adjusted Gross Annual AdjustedGrossAnnualMMBTU—Adjusted Gross Annual MMBTU AdjustedGrossAnnualkW—Adjusted Gross Annual kW AdjustedGrossAnnualkWSummer—Adjusted Gross Annual kW Summer AdjustedGrossAnnualkWWinter—Adjusted Gross Annual kW Winter AdjustedGrossAnnualkWh—Adjusted Gross Annual kWh GrossAnnualMMBTU—Gross Annual MMBTU GrossAnnualkW—Gross Annual kW GrossAnnualkWh—Gross Annual kWh NetAnnual—Net Annual NetLifetime—Net Lifetime NetToGross—Net To Gross NetToGrossFR—Net To Gross FR UsefulLife—Useful Life"
}
},
"special_access_rules": "This object is available only with the EAndU Cloud Usage Impact Access permission set.\n\nThis object is available only with the EAndU Cloud\n Usage Impact Access permission set.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **UsageImpactFactorChangeEvent**: Change events are available for the object.\n- **UsageImpactFactorFeed**: Feed tracking is available for the object.\n- **UsageImpactFactorHistory**: History is available for tracked fields of the object.\n- **UsageImpactFactorOwnerSharingRule**: Sharing rules are available for the object.\n- **UsageImpactFactorShare**: Sharing is available for the object.",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Id": {
"field_label": "Usage Impact Factor ID",
"type": "id",
"length": "18"
},
"IsActive": {
"field_label": "Active",
"type": "boolean"
},
"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"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"ShortForm": {
"field_label": "Short Form",
"type": "string",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Type": {
"field_label": "Type",
"type": "picklist",
"length": "255"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}