mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-05 23:41:31 +08:00
109 lines
8.1 KiB
JSON
109 lines
8.1 KiB
JSON
|
{
|
|||
|
|
"sections": [
|
|||
|
|
"title",
|
|||
|
|
"description",
|
|||
|
|
"supported_soap_calls",
|
|||
|
|
"supported_rest_api_http_methods",
|
|||
|
|
"fields",
|
|||
|
|
"changeownpassword",
|
|||
|
|
"sub_types",
|
|||
|
|
"special_access_rules",
|
|||
|
|
"wsdl_segment"
|
|||
|
|
],
|
|||
|
|
"title": "OperationLog - Tooling API",
|
|||
|
|
"description": "Represents long-running or asynchronous operations triggered and tracked through Tooling API. This object is available in API version 37.0 and later.",
|
|||
|
|
"supported_soap_calls": "`create()`, `describeSObjects()`",
|
|||
|
|
"supported_rest_api_http_methods": "`Query`, `GET`, `POST`",
|
|||
|
|
"fields_columns": [
|
|||
|
|
"type",
|
|||
|
|
"properties",
|
|||
|
|
"description"
|
|||
|
|
],
|
|||
|
|
"fields": {
|
|||
|
|
"DetailedStatus": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "Complements the Status field with an operation processor-specific status code."
|
|||
|
|
},
|
|||
|
|
"Message": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "Complements the Status field with information helpful to the user. For example, if Status=FAILED, state the reason in this field."
|
|||
|
|
},
|
|||
|
|
"Parameters": {
|
|||
|
|
"type": "OperationParameters",
|
|||
|
|
"properties": "Create, Nillable",
|
|||
|
|
"description": "A complex type that represents a set of parameters passed to the operation processor. Specify the parameters by using the OperationPayload value that corresponds to your operation type."
|
|||
|
|
},
|
|||
|
|
"Status": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Filter, Group, Restricted picklist, Sort",
|
|||
|
|
"description": "Indicates the status of an operation triggered through Tooling API. Valid values are: NEW RUNNING COMPLETED FAILED ABORTED Only records with Status=NEW can be created through the API."
|
|||
|
|
},
|
|||
|
|
"Type": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Create, Filter, Group, Restricted picklist, Sort",
|
|||
|
|
"description": "The type of operation submitted through Tooling API. For each operation type, use the corresponding payload of input parameters. Valid operation types are: RunTerritoryRules Runs account assignment rules for any territory that has rules defined and belongs to a territory model in Planning or Active state. When you run rules from Setup, accounts are assigned to territories according to your rules if your territory model is in Active or Planning state. Accounts are assigned to territories according to your rules automatically on account creation or update only if your territory model is in Active state.When you choose this operation type, use the payload Territory2RunTerritoryRulesPayload in the Parameters field. RunOppTerrAssignmentApex Uses filter-based opportunity territory assignment to assign territories to opportunities using a simple job. We provide code for an Apex class that you can use as-is or modify as needed based on our guidelines. After you create and deploy the class, run the job to complete the assignment process. Job options include making assignments within date ranges and assigning territories to open opportunities only. When you choose this operation type, use the payload Territory2RunOppTerrAssignmentApexPayload in the Parameters field."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"changeownpassword": {
|
|||
|
|
"oldPassword": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The user’s previous password that is being replaced."
|
|||
|
|
},
|
|||
|
|
"newPassword": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The user’s new password."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"sub_types": {
|
|||
|
|
"OperationParameters": {
|
|||
|
|
"payload": {
|
|||
|
|
"type": "OperationPayload",
|
|||
|
|
"description": "Use the payload that corresponds to the type of operation you want to trigger through Tooling API. Valid values are: Territory2RunTerritoryRulesPayload Territory2RunOppTerrAssignmentApexPayload"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"Territory2RunTerritoryRulesPayload": {
|
|||
|
|
"keyPrefix": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The key prefix of the entity on which the territory assignment rules should be run. The Account key prefix (001) is currently supported."
|
|||
|
|
},
|
|||
|
|
"territoryId": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The TerritoryID of the Planning or Active territory model you want to run rules for."
|
|||
|
|
},
|
|||
|
|
"territoryModelId": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The ID for the territory model the territory belongs to. You can run assignment rules on territory models in a Planning or Active state."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"Territory2RunOppTerrAssignmentApexPayload": {
|
|||
|
|
"excludeClosedOpportunities": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "If true, excludes from the operation all opportunities that are already closed."
|
|||
|
|
},
|
|||
|
|
"opportunityCloseDateFrom": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "Use to filter opportunities based on a range of close dates. The operation applies to opportunities with close dates within the specified range. Use this field to specify a starting date for the range using the format ddmmyyyy."
|
|||
|
|
},
|
|||
|
|
"opportunityCloseDateTo": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "Use to filter opportunities based a range of close dates. The operation applies to opportunities with close dates within the specified range. Use this field to specify an ending date for the range using the format ddmmyyyy."
|
|||
|
|
},
|
|||
|
|
"opportunityLastModifiedDateFrom": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "Use to filter opportunities based a range of last-modified dates. The operation applies to opportunities with last-modified dates within the specified range. Use this field to specify a starting date for the range using the format ddmmyyyy."
|
|||
|
|
},
|
|||
|
|
"opportunityLastModifiedDateTo": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "Use to filter opportunities based a range of last-modified dates. The operation applies to opportunities with last-modified dates within the specified range. Use this field to specify an ending date for the range using the format ddmmyyyy."
|
|||
|
|
},
|
|||
|
|
"territoryModelId": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The ID for the active territory model. Opportunities can be assigned to an active territory model only."
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"special_access_rules": "As of the Spring '20 release, to access OperationLog you must have the View Setup user permission.",
|
|||
|
|
"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=\"OperationLog\">\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=\"DetailedStatus\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"IsDeleted\" 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=\"Message\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"Parameters\" minOccurs=\"0\" type=\"tns:OperationParameters\" 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=\"Type\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"OperationParameters\">\n <xsd:sequence>\n <xsd:element name=\"payload\" type=\"tns:OperationPayload\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"OperationPayload\">\n <xsd:sequence/>\n</xsd:complexType>\n```"
|
|||
|
|
}
|