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

137 lines
5.7 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "DatacloudPurchaseUsage - Data API",
"description": "Represents an object used to identify and track Data.com record purchases. This object is available in API version 30.0 or later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"DatacloudEntityType": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The type of Data.com record you want to purchase. 0—indicates contact entity type. 1—indicates company entity type."
},
"Description": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "An optional field. You can add a description for your purchase."
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, Sort",
"description": "An optional field used to name your record."
},
"PurchaseType": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "A read only field set by the API to identify the purchase type. Added Export API"
},
"Usage": {
"type": "double",
"properties": "Filter, Sort",
"description": "A read only field set by the API. It is used to track the points used to purchase records."
},
"UserId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "A read only field set by the API that identifies the user purchasing the records."
},
"UserType": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "A read only field set by the API with 2 user types. Monthly Usage List Pool User"
}
},
"usage": "The DatacloudPurchaseUsage object allows you to track Data.com record purchases for CRM users.",
"wsdl_segment": "```xml\n<complexType name=\"DatacloudPurchaseUsage\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\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=\"DatacloudEntityType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" 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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"PurchaseType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Usage\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"User\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"UserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n <element name=\"UserType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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": {
"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"
},
"DatacloudEntityType": {
"field_label": "Data.com Object Type",
"type": "picklist",
"length": "255"
},
"Description": {
"field_label": "Description",
"type": "string",
"length": "255"
},
"Id": {
"field_label": "Data.com Usage 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"
},
"Name": {
"field_label": "Sequence ID",
"type": "string",
"length": "255"
},
"PurchaseType": {
"field_label": "Data.com Purchase Type",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Usage": {
"field_label": "Purchase Count",
"type": "double",
"precision": "18",
"scale": "0"
},
"UserId": {
"field_label": "User ID",
"type": "reference",
"length": "18"
},
"UserType": {
"field_label": "Data.com Usage Type",
"type": "picklist",
"length": "255"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"precision",
"scale"
]
}