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

267 lines
15 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "ProcessException - Data API",
"description": "Represents a business exception, such as a processing failure on an order summary. A separate process is required to resolve the failure that caused the process exception before processing can continue. This object is available in API version 50.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AttachedToId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "ID of the object associated with the ProcessException. This field is a polymorphic relationship field.",
"relationship_name": "AttachedTo",
"relationship_type": "Lookup",
"refers_to": "AsyncOpSyndicationFeedFile, AsyncOperationTracker"
},
"CaseId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "ID of the case associated with the ProcessException. This field is a relationship field.",
"relationship_name": "Case",
"relationship_type": "Lookup",
"refers_to": "Case"
},
"Category": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
"description": "ProcessingException type. You can customize the category picklist to represent your business processes. Possible values are: Fulfillment Invoicing Order Activation Order Approval Order To Asset Order Item Summary To Asset Order To Billing Schedule Payment The default value is Order Activation."
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the OrderSummary associated with the ProcessException. Possible values are: DKK—Danish Krone EUR—Euro GBP—British Pound USD—U.S. Dollar The default value is USD."
},
"Description": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "Detailed description of the ProcessException."
},
"ExternalReference": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Description of external entities associated with the ProcessException."
},
"FlowOrchestrationInstRelaObj": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The flow orchestration instance related object associated with this record. This field is a relationship field.",
"relationship_name": "FlowOrchInstRelaObj",
"relationship_type": "Lookup",
"refers_to": "FlowOrchestrationInstRelaObj"
},
"GroupById": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "ID used in the entity to group exceptions, such as the Async Operation Tracker. This field is a polymorphic relationship field.",
"relationship_name": "GroupBy",
"refers_to": "AsyncOperationTracker"
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "Timestamp for when the current user last viewed a record related to this record."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "Timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed."
},
"Message": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "Short description of the ProcessException"
},
"OrderSummaryId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "ID of the OrderSummary associated with the ProcessException. The ProcessException component is displayed on this OrderSummary. This field is a relationship field.",
"relationship_name": "OrderSummary",
"relationship_type": "Lookup",
"refers_to": "OrderSummary"
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "ID of the User who currently owns this ProcessException. Default value is the User who created the record. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
},
"Priority": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
"description": "Resolution priority for the ProcessException. You can customize the priority picklist to represent your business processes. Possible values are: High Low The default value is Low."
},
"ProcessExceptionNumber": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The unique name of the ProcessException, formatted as PE-(00000000)."
},
"Severity": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
"description": "Severity of the ProcessException. Each severity value corresponds to one severity category. You can customize the severity picklist to represent your business processes. If you customize the severity picklist, include at least one severity value for each severity category. Possible values are: High Low The default value is High."
},
"SeverityCategory": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Severity category of the ProcessException. Each severity category corresponds to one or more severity values. The severity category is used to show the severity icon in the ProcessException list view. Possible values are: HIGH LOW MEDIUM"
},
"Status": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Status of the ProcessException. Each status corresponds to one status category, shown here in parentheses. You can customize the status picklist to represent your business processes. If you customize the status picklist, include at least one status value for each status category. Possible values are: Ignored (Inactive) New (Active) Paused (Inactive) Resolved (Resolved) Triaged (Active) Voided (Inactive) The default value is New."
},
"StatusCategory": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "Status category of the ProcessException. Each status category corresponds to one or more statuses. Possible values are: ACTIVE INACTIVE RESOLVED"
}
},
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **ProcessExceptionChangeEvent (API version 62.0)**: Change events are available for the object.\n- **ProcessExceptionOwnerSharingRule**: Sharing rules are available for the object.\n\n- **ProcessExceptionOwnerSharingRule**: Sharing rules are available for the object.",
"wsdl_segment": "```xml\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<complexType name=\"ProcessException\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ActivityHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Asset\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Asset\"/>\n <element name=\"AssetId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"AttachedTo\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"AttachedToId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Case\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Case\"/>\n <element name=\"CaseId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Category\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ExternalReference\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Message\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Priority\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ProcessExceptionNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Severity\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SeverityCategory\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"StatusCategory\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n
"field_reference": {
"AssetId": {
"field_label": "Asset ID",
"type": "reference",
"length": "18"
},
"AttachedToId": {
"field_label": "Attached To ID",
"type": "reference",
"length": "18"
},
"CaseId": {
"field_label": "Case ID",
"type": "reference",
"length": "18"
},
"Category": {
"field_label": "Category",
"type": "picklist",
"length": "40"
},
"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"
},
"Description": {
"field_label": "Description",
"type": "textarea",
"length": "2000"
},
"ExternalReference": {
"field_label": "External Reference",
"type": "string",
"length": "255"
},
"GroupById": {
"field_label": "Group By ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Process Exception 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"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Message": {
"field_label": "Message",
"type": "string",
"length": "255"
},
"OrderSummaryId": {
"field_label": "Order Summary ID",
"type": "reference",
"length": "18"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"Priority": {
"field_label": "Priority",
"type": "picklist",
"length": "40"
},
"ProcessExceptionNumber": {
"field_label": "Process Exception Number",
"type": "string",
"length": "255"
},
"Severity": {
"field_label": "Severity",
"type": "picklist",
"length": "40"
},
"SeverityCategory": {
"field_label": "Severity Category",
"type": "picklist",
"length": "255"
},
"Status": {
"field_label": "Status",
"type": "picklist",
"length": "40"
},
"StatusCategory": {
"field_label": "Status Category",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}