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

52 lines
4.0 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"wsdl_segment"
],
"title": "ApexTestQueueItem - Tooling API",
"description": "Represents a single Apex class in the Apex job queue. Available in API version 30.0 and later.",
"supported_soap_calls": "`create()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
"supported_rest_api_http_methods": "`Query`, `GET`, `POST`, `PATCH`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ApexClassId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The Apex class whose tests are to be executed. This field can't be updated."
},
"Status": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort, Update",
"description": "The status of the test. Valid values are: Queued Processing Aborted Completed Failed Preparing Holding To abort a class that is in the Apex job queue, perform an update operation on the ApexTestQueueItem object and set its Status field to Aborted."
},
"ExtendedStatus": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "The pass rate of the test run. For example: “(4/6)”. This means that four out of a total of six tests passed. If the class fails to execute, this field contains the cause of the failure."
},
"ParentJobId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "Read-only. Points to the AsyncApexJob that represents the entire test run. If you insert multiple Apex test queue items in a single bulk operation, the queue items will share the same parent job. This means that a test run can consist of the execution of the tests of several classes if all the test queue items are inserted in the same bulk operation."
},
"ShouldSkipCodeCoverage": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether to opt out of collecting code coverage information during Apex test runs. Available in API version 43.0 and later."
},
"TestRunResultID": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the associated ApexTestRunResult object. Available in API version 37.0 and later."
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"ApexTestQueueItem\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"ApexClass\" minOccurs=\"0\" type=\"ens:ApexClass\" nillable=\"true\"/>\n <xsd:element name=\"ApexClassId\" minOccurs=\"0\" type=\"tns:ID\" 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=\"ExtendedStatus\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"ParentJobId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"ShouldSkipCodeCoverage\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"Status\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"TestRunResultId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\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```"
}