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

130 lines
5.9 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",
"wsdl_segment",
"field_reference"
],
"title": "AccountPartner - Data API",
"description": "This object represents a partner relationship between two Account records. An AccountPartner record is created automatically when a Partner record is created for a partner relationship between two accounts. An AccountPartner record is also created automatically between an account and an opportunitys account when a Partner record is created between an account and an opportunity.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AccountFromId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "ID of the main Account in the partner relationship. This is a relationship field.",
"relationship_name": "AccountFrom",
"relationship_type": "Lookup",
"refers_to": "Account"
},
"AccountToId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "ID of the partner Account in the partner relationship. This is a relationship field.",
"relationship_name": "AccountTo",
"relationship_type": "Lookup",
"refers_to": "Account"
},
"IsPrimary": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the AccountPartner is the primary partner of an opportunity (true). When there are no corresponding Opportunity Partner records, the value is false."
},
"OpportunityId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "ID of the opportunity in a partner relationship. This is a relationship field.",
"relationship_name": "Opportunity",
"relationship_type": "Lookup",
"refers_to": "Opportunity"
},
"ReversePartnerId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the reciprocal AccountPartner record in a partner relationship."
},
"Role": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "The UserRole that the partner Account has on the main Account. For example, Consultant or Distributor."
}
},
"special_access_rules": "Customer Portal users can't access this object.",
"wsdl_segment": "```xml\n<complexType name=\"AccountPartner\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"AccountFrom\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n <element name=\"AccountFromId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"AccountTo\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n <element name=\"AccountToId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsPrimary\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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=\"ReversePartnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Role\" 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=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n```",
"field_reference": {
"AccountFromId": {
"field_label": "Account ID",
"type": "reference",
"length": "18"
},
"AccountToId": {
"field_label": "Account ID",
"type": "reference",
"length": "18"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Id": {
"field_label": "Account Partner ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsPrimary": {
"field_label": "Primary",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"OpportunityId": {
"field_label": "Opportunity ID",
"type": "reference",
"length": "18"
},
"ReversePartnerId": {
"field_label": "Reverse Partner ID",
"type": "reference",
"length": "18"
},
"Role": {
"field_label": "Role",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}