{
"sections": [
"title",
"description",
"fields",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "Idea - Data API",
"description": "Represents an idea on which users are allowed to comment and vote, for example, a suggestion for an enhancement to an existing product or process. This object is available in API version 12 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AttachmentBody": {
"type": "base64",
"properties": "Create, Nillable, Update",
"description": "File data for the attachment. This field is available in API version 28.0 and later."
},
"AttachmentContentType": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Type of the attachment. This field is available in API version 28.0 and later."
},
"AttachmentLength": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Size of the attachment in bytes. This field is available in API version 28.0 and later."
},
"AttachmentName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Name of the attachment. This field is available in API version 28.0 and later."
},
"Body": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "Description of the Idea."
},
"Categories": {
"type": "multipicklist",
"properties": "Create, Filter, Nillable, Update",
"description": "Customizable multi-select picklist used to organize Ideas into logical groupings. Note: This field is only available if your organization has the Categories field enabled. This field is enabled by default in organizations created after API version 14 was released. If the Categories field is enabled, API versions 13 and earlier do not have access to either the Categories or Category fields."
},
"Category": {
"type": "picklist",
"properties": "Create, Filter, Nillable, Update",
"description": "Customizable picklist of values used to organize Ideas into logical groupings. Note: This field is not available if your organization has the multi-select Categories field enabled."
},
"CommunityId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The zone ID associated with the idea. Once you create an idea, you can’t change the zone ID associated with that idea. Note: API version 12 does not support zone ID. If you create an idea in version 12, your idea is automatically posted to the oldest zone that you have permission to access. This is a relationship field.",
"relationship_name": "Community",
"relationship_type": "Lookup",
"refers_to": "Community"
},
"CreatorFullPhotoUrl": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "URL of the user’s profile photo. This field is available in API version 28.0 and later."
},
"CreatorName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Name of the user who posted the idea or commented on the idea. This field is available in API version 28.0 and later."
},
"CreatorSmallPhotoUrl": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "URL of the user’s thumbnail photo. This field is available in API version 28.0 and later."
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
},
"IdeaThemeID": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Identifies the idea theme associated with the idea."
},
"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."
},
"IsHtml": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Read-only. If this value is true, your organization has the Ideas HTML editor enabled, and the Idea Body may contain HTML. If this value is false, the HTML editor is disabled and the Idea Body only contains regular text."
},
"IsMerged": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Read only. Indicates whether the idea has been merged with a parent idea (true) or not (false). You can’t vote for or add comments to a merged idea. Note: In API version 27, IsMerged replaces IsLocked. Existing formula fields that use IsLocked must be edited to use IsMerged."
},
"LastCommentDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time the last comment (child IdeaComment object) was added."
},
"LastCommentId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "Read only. The ID of the last comment (child IdeaComment object). This is a relationship field.",
"relationship_name": "LastComment",
"relationship_type": "Lookup",
"refers_to": "IdeaComment"
},
"LastReferencedDate": {
"type": "date",
"properties": "Filter, Nillable, Sort, Update",
"description": "The timestamp for when the current user last viewed a record related to this record."
},
"LastViewedDate": {
"type": "date",
"properties": "Filter, Nillable, Sort, Update",
"description": "The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed."
},
"NumComments": {
"type": "int",
"properties": "Defaulted on create, Filter, Group, Nillable, Sort",
"description": "The number of comments (child IdeaComment objects) that users have submitted for the given idea."
},
"ParentIdeaId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID associated with this idea's parent idea. When multiple ideas are merged together, one idea becomes the parent (master) of the other ideas. The ParentIdeaId is automatically set when you merge ideas. This is a relationship field.",
"relationship_name": "ParentIdea",
"relationship_type": "Lookup",
"refers_to": "Idea"
},
"RecordTypeId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the record type assigned to this object. This is a relationship field.",
"relationship_name": "RecordType",
"relationship_type": "Lookup",
"refers_to": "RecordType"
},
"Status": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Customizable picklist of values used to specify the status of an idea."
},
"Title": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The descriptive title of the idea."
},
"VoteScore": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The internal score of the Idea, used to sort Ideas on the Popular tab in the application user interface. The internal algorithm that determines the score gives older votes less weight than newer votes, simulating exponential decay. The score itself does not display in the application user interface. Note: Unlike other fields of type double, you can't use a SOQL aggregate function with this field."
},
"VoteTotal": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "An Idea's total number of points. Each vote a user makes is worth ten points, therefore the value of this field is ten times the number of votes an idea has received. Note: Unlike other fields of type double, you can't use a SOQL aggregate function with this field."
}
},
"usage": "Use this object to track ideas, which are written suggestions on which users can vote and comment.",
"wsdl_segment": "```xml\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```",
"field_reference": {
"Body": {
"field_label": "Idea Body",
"type": "textarea",
"length": "32000"
},
"Categories": {
"field_label": "Categories",
"type": "multipicklist",
"length": "4099",
"precision": "7"
},
"CommunityId": {
"field_label": "Zone ID",
"type": "reference",
"length": "18"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CreatorFullPhotoUrl": {
"field_label": "URL of Creator's Profile Photo",
"type": "string",
"length": "255"
},
"CreatorName": {
"field_label": "Name of Creator",
"type": "string",
"length": "121"
},
"CreatorSmallPhotoUrl": {
"field_label": "URL of Creator's Thumbnail Photo",
"type": "string",
"length": "255"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"Id": {
"field_label": "Idea ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsHtml": {
"field_label": "IsHtml",
"type": "boolean"
},
"IsMerged": {
"field_label": "Is Merged",
"type": "boolean"
},
"LastCommentDate": {
"field_label": "Last Idea Comment Date",
"type": "datetime"
},
"LastCommentId": {
"field_label": "Idea Comment ID",
"type": "reference",
"length": "18"
},
"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"
},
"NumComments": {
"field_label": "Number of Comments",
"type": "int",
"digits": "9"
},
"ParentIdeaId": {
"field_label": "Idea ID",
"type": "reference",
"length": "18"
},
"RecordTypeId": {
"field_label": "Record Type ID",
"type": "reference",
"length": "18"
},
"Status": {
"field_label": "Status",
"type": "picklist",
"length": "40"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Title": {
"field_label": "Title",
"type": "string",
"length": "255"
},
"VoteScore": {
"field_label": "Vote Score",
"type": "double",
"precision": "18",
"scale": "4"
},
"VoteTotal": {
"field_label": "Vote Total",
"type": "double",
"precision": "18",
"scale": "0"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"precision",
"digits",
"scale"
]
}