afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/PlatformEventMigration.json

37 lines
4.4 KiB
JSON

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"wsdl_segment"
],
"title": "PlatformEventMigration - Tooling API",
"description": "Represents configuration settings for performing a one-time migration of standard volume platform events to high volume platform events. This object is available in API version 67.0 and later.",
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
"supported_rest_api_http_methods": "`DELETE`, `GET`, `PATCH`, `POST`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The unique name for the PlatformEventMigration object. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance can slow down while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"EventObject": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of a standard volume platform event that needs to be migrated to a high volume platform event. You can find the ID by executing this Tooling API SOQL query in the developer console: SELECT Id FROM CustomObject WHERE DeveloperName='YourStandardVolumePlatformEvent' The name to use as the DeveloperName of your SVPE is labeled Object Name in the UI."
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "Label for PlatformEventMigration."
}
},
"wsdl_segment": "```xml\n<xsd:simpleType name=\"ID\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:length value=\"18\"/>\n <xsd:pattern value=\"[a-zA-Z0-9]{18}\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"PlatformEventMigration\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"CreatedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"CreatedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CreatedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"DeveloperName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"EndDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"EventObject\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"HighVolumePosition\" minOccurs=\"0\" type=\"xsd:int\" nillable=\"true\"/>\n <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"Language\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"ManageableState\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"MasterLabel\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"MigrationStatus\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"NamespacePrefix\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"StartDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```"
}