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

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "special_access_rules",
    "wsdl_segment"
  ],
  "title": "ContainerAsyncRequest - Tooling API",
  "description": "Allows you to compile and asynchronously deploy a MetadataContainer object to your organization.",
  "supported_soap_calls": "`create()`, `describeSObjects()`, `query()`, `retrieve()`",
  "supported_rest_api_http_methods": "`Query`, `GET`, `POST`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "DeployDetails": {
      "type": "DeployDetails",
      "properties": "Nillable",
      "description": "Provides detailed XML for any compile errors reported during an asynchronous request. Includes componentFailures. Replaces the JSON field CompilerErrors in Tooling API version 31.0 and later."
    },
    "ErrorMsg": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "Errors reported during an asynchronous request."
    },
    "IsCheckOnly": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the asynchronous request compiles the code without making any changes to the organization (true) or compiles and saves the code (false).This field is required. You can compile without saving but you can’t save without compiling."
    },
    "IsRunTests": {
      "type": "boolean",
      "properties": "None",
      "description": "Reserved for future use."
    },
    "MetadataContainerId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of a MetadataContainer object. Specify a MetadataContainerId or a MetadataContainerMemberId, but not both."
    },
    "MetadataContainerMemberId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of an ApexClassMember, ApexTriggerMember, ApexPageMember or ApexComponentMember object.Specify a MetadataContainerId or a MetadataContainerMemberId, but not both."
    },
    "State": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The state of the request. Valid values are: Queued—the job is in the queue. Invalidated—Salesforce canceled the job because the results might not be valid. This state occurs if someone changes the container members while IsCheckOnly=true, or if a newer compile request is added to the queue. Completed—the compilation or deployment finished. The SymbolTable fields for the specified object(s) were successfully updated. If IsCheckOnly is false, the Body for each object was saved and the MetadataContainerId field for each object was reset from the ID of the deployed MetadataContainer to the ID of the corresponding ContainerAsyncRequest object. Failed—the compilation or deployment failed for the reasons stated in the CompilerError field. Error—an unexpected error occurred. The messages in the ErrorMsg field can be provided to Salesforce support if the issue persists. Aborted—use this value to delete a queued deployment. This field is required."
    }
  },
  "special_access_rules": "As of the Spring '20 release, to access ContainerAsyncRequest you must have both the View All Data and Customize Application user permissions.",
  "wsdl_segment": "```xml\n<xsd:complexType name=\"CodeCoverageResult\">\n  <xsd:sequence>\n    <xsd:element name=\"id\" type=\"tns:ID\"/>\n    <xsd:element name=\"locationsNotCovered\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CodeLocation\"/>\n    <xsd:element name=\"name\" type=\"xsd:string\"/>\n    <xsd:element name=\"namespace\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"numLocations\" type=\"xsd:int\"/>\n    <xsd:element name=\"numLocationsNotCovered\" type=\"xsd:int\"/>\n    <xsd:element name=\"type\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"CodeCoverageWarning\">\n  <xsd:sequence>\n    <xsd:element name=\"id\" type=\"tns:ID\"/>\n    <xsd:element name=\"message\" type=\"xsd:string\"/>\n    <xsd:element name=\"name\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"namespace\" type=\"xsd:string\" nillable=\"true\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"CodeLocation\">\n  <xsd:sequence>\n    <xsd:element name=\"column\" type=\"xsd:int\"/>\n    <xsd:element name=\"line\" type=\"xsd:int\"/>\n    <xsd:element name=\"numExecutions\" type=\"xsd:int\"/>\n    <xsd:element name=\"time\" type=\"xsd:double\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ContainerAsyncRequest\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"ApexClassMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"ApexComponentMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"ApexPageMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"ApexTriggerMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"AuraDefinitionChanges\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\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=\"CustomFieldMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"DeployDetails\" minOccurs=\"0\" type=\"tns:DeployDetails\" nillable=\"true\"/>\n        <xsd:element name=\"ErrorMsg\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"IsCheckOnly\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n        <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n        <xsd:element name=\"IsRunTests\" minOccurs=\"0\" type=\"xsd:boolean\" 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=\"MetadataContainer\" minOccurs=\"0\" type=\"ens:MetadataContainer\" nillable=\"true\"/>\n        <xsd:element name=\"MetadataContainerId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"MetadataContainerMember\" minOccurs=\"0\" type=\"ens:sObject\" nillable=\"true\"/>\n        <xsd:element name=\"MetadataContainerMemberId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"State\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n        <xsd:element name=\"ValidationRuleMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"WorkflowAlertMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"WorkflowFieldUpdateMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"WorkflowOutboundMessageMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"WorkflowRuleMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n        <xsd:element name=\"WorkflowTaskMembers\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"DeployDetails\">\n  <xsd:sequence>\n    <xsd:element name=\"componentFailures\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:DeployMessage\"/>\n    <xsd:element name=\"componentSuccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:DeployMessage\"/>\n    <xsd:element name=\"runTestResult\" minOccurs=\"0\" type=\"tns:RunTestsResult\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"DeployMessage\">\n  <xsd:sequence>\n    <xsd:element name=\"changed\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"columnNumber\" minOccurs=\"0\" type=\"xsd:int\"/>\n    <xsd:element name=\"componentType\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"created\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"createdDate\" type=\"xsd:dateTime\"/>\n    <xsd:element name=\"deleted\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"fileName\" type=\"xsd:string\"/>\n    <xsd:element name=\"fullName\" type=\"xsd:string\"/>\n    <xsd:element name=\"id\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"lineNumber\" minOccurs=\"0\" type=\"xsd:int\"/>\n    <xsd:element name=\"problem\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"problemType\" minOccurs=\"0\" type=\"tns:DeployProblemType\"/>\n    <xsd:element name=\"success\" type=\"xsd:boolean\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"DeployProblemType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Warning\"/>\n    <xsd:enumeration value=\"Error\"/>\n    <xsd:enumeration value=\"Info\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"FlowCoverageResult\">\n  <xsd:sequence>\n    <xsd:element name=\"elementsNotCovered\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n    <xsd:element name=\"flowId\" type=\"xsd:string\"/>\n    <xsd:element name=\"flowName\" type=\"xsd:string\"/>\n    <xsd:element name=\"flowNamespace\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"numElements\" type=\"xsd:int\"/>\n    <xsd:element name=\"numElementsNotCovered\" type=\"xsd:int\"/>\n    <xsd:element name=\"processType\" type=\"tns:FlowProcessType\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"FlowCoverageWarning\">\n  <xsd:sequence>\n    <xsd:element name=\"flowId\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"flowName\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"flowNamespace\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"message\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"FlowProcessType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"AutoLaunchedFlow\"/>\n    <xsd:enumeration value=\"Flow\"/>\n    <xsd:enumeration value=\"Workflow\"/>\n    <xsd:enumeration value=\"CustomEvent\"/>\n    <xsd:enumeration value=\"InvocableProcess\"/>\n    <xsd:enumeration value=\"LoginFlow\"/>\n    <xsd:enumeration value=\"ActionPlan\"/>\n    <xsd:enumeration value=\"JourneyBuilderIntegration\"/>\n    <xsd:enumeration value=\"UserProvisioningFlow\"/>\n    <xsd:enumeration value=\"Survey\"/>\n    <xsd:enumeration value=\"SurveyEnrich\"/>\n    <xsd:enumeration value=\"Appointments\"/>\n    <xsd:enumeration value=\"FSCLending\"/>\n    <xsd:enumeration value=\"DigitalForm\"/>\n    <xsd:enumeration value=\"FieldServiceMobile\"/>\n    <xsd:enumeration value=\"OrchestrationFlow\"/>\n    <xsd:enumeration value=\"FieldServiceWeb\"/>\n    <xsd:enumeration value=\"TransactionSecurityFlow\"/>\n    <xsd:enumeration value=\"ContactRequestFlow\"/>\n    <xsd:enumeration value=\"ManagedContentFlow\"/>\n    <xsd:enumeration value=\"CheckoutFlow\"/>\n    <xsd:enumeration value=\"CartAsyncFlow\"/>\n    <xsd:enumeration value=\"DataCaptureFlow\"/>\n    <xsd:enumeration value=\"CustomerLifecycle\"/>\n    <xsd:enumeration value=\"Journey\"/>\n    <xsd:enumeration value=\"RecommendationStrategy\"/>\n    <xsd:enumeration value=\"Orchestrator\"/>\n    <xsd:enumeration value=\"RoutingFlow\"/>\n    <xsd:enumeration value=\"ServiceCatalogItemFlow\"/>\n    <xsd:enumeration value=\"EvaluationFlow\"/>\n    <xsd:enumeration value=\"LoyaltyManagementFlow\"/>\n    <xsd:enumeration value=\"ManagedContentAuthoringWorkflow\"/>\n    <xsd:enumeration value=\"ActionCadenceAutolaunchedFlow\"/>\n    <xsd:enumeration value=\"ActionCadenceStepFlow\"/>\n    <xsd:enumeration value=\"CadenceStepReviewCriteriaFlow\"/>\n    <xsd:enumeration value=\"IndicatorResultFlow\"/>\n    <xsd:enumeration value=\"IndividualObjectLinkingFlow\"/>\n    <xsd:enumeration value=\"PromptFlow\"/>\n    <xsd:enumeration value=\"ApprovalWorkflow\"/>\n    <xsd:enumeration value=\"DcvrFrameworkDataCaptureFlow\"/>\n    <xsd:enumeration value=\"ActivityObjectMatchingFlow\"/>\n    <xsd:enumeration value=\"ActionableEventManagementFlow\"/>\n    <xsd:enumeration value=\"StageManagementEvaluationFlow\"/>\n    <xsd:enumeration value=\"IdentityUserRegistrationFlow\"/>\n    <xsd:enumeration value=\"AgxBackgroundFlow\"/>\n    <xsd:enumeration value=\"AgxDataRetrievalFlow\"/>\n    <xsd:enumeration value=\"AgxScreenFlow\"/>\n    <xsd:enumeration value=\"AgxOrchestrationFlow\"/>\n    <xsd:enumeration value=\"UnifiedSchedulingFlow\"/>\n  </xsd:restriction>\n</xsd:simpleType>\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:simpleType name=\"QueryLocator\">\n  <xsd:restriction base=\"xsd:string\"/>\n</xsd:simpleType>\n<xsd:complexType name=\"QueryResult\">\n  <xsd:sequence>\n    <xsd:element name=\"done\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"entityTypeName\" type=\"xsd:string\"/>\n    <xsd:element name=\"nextRecordsUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"queryLocator\" type=\"tns:QueryLocator\"/>\n    <xsd:element name=\"records\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"ens:sObject\"/>\n    <xsd:element name=\"size\" type=\"xsd:int\"/>\n    <xsd:element name=\"totalSize\" type=\"xsd:int\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RunTestFailure\">\n  <xsd:sequence>\n    <xsd:element name=\"id\" type=\"tns:ID\"/>\n    <xsd:element name=\"message\" type=\"xsd:string\"/>\n    <xsd:element name=\"methodName\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"name\" type=\"xsd:string\"/>\n    <xsd:element name=\"namespace\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"seeAllData\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"stackTrace\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"testCategory\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"time\" type=\"xsd:double\"/>\n    <xsd:element name=\"type\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RunTestSuccess\">\n  <xsd:sequence>\n    <xsd:element name=\"id\" type=\"tns:ID\"/>\n    <xsd:element name=\"methodName\" type=\"xsd:string\"/>\n    <xsd:element name=\"name\" type=\"xsd:string\"/>\n    <xsd:element name=\"namespace\" type=\"xsd:string\" nillable=\"true\"/>\n    <xsd:element name=\"seeAllData\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"testCategory\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"time\" type=\"xsd:double\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RunTestsResult\">\n  <xsd:sequence>\n    <xsd:element name=\"apexLogId\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"codeCoverage\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CodeCoverageResult\"/>\n    <xsd:element name=\"codeCoverageWarnings\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CodeCoverageWarning\"/>\n    <xsd:element name=\"failures\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RunTestFailure\"/>\n    <xsd:element name=\"flowCoverage\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FlowCoverageResult\"/>\n    <xsd:element name=\"flowCoverageWarnings\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FlowCoverageWarning\"/>\n    <xsd:element name=\"numFailures\" type=\"xsd:int\"/>\n    <xsd:element name=\"numTestsRun\" type=\"xsd:int\"/>\n    <xsd:element name=\"successes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RunTestSuccess\"/>\n    <xsd:element name=\"totalTime\" type=\"xsd:double\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```"
}