mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
176 lines
9.1 KiB
JSON
176 lines
9.1 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "FlowOrchestrationStepInstance - Data API",
|
||
"description": "Represents a run-time instance of a step in a run-time instance of a stage of a run-time instance of an orchestration. This read-only object is available in API version 53.0 and later.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"Description": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The description of the step."
|
||
},
|
||
"Label": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "The label of the step."
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, idLookup, Sort",
|
||
"description": "The API name of the step."
|
||
},
|
||
"OrchestrationInstanceId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "The ID of the FlowOrchestrationInstance associated with the orchestration step instance. This field is a relationship field.",
|
||
"relationship_name": "OrchestrationInstance",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "FlowOrchestrationInstance"
|
||
},
|
||
"OwnerId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Sort, Update",
|
||
"description": "The ID of the automated process user. This field is available in API version 56.0 and later.",
|
||
"relationship_name": "Owner",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "User"
|
||
},
|
||
"StageInstanceId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "The ID of the FlowOrchestrationStageInstance associated with the orchestration step instance. This field is a relationship field.",
|
||
"relationship_name": "StageInstance",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "FlowOrchestrationStageInstance"
|
||
},
|
||
"Status": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Restricted picklist, Sort",
|
||
"description": "The status of the orchestration step instance. Valid values are: Completed—The step instance completed. Discontinued—The step instance was in progress or completed when it’s associated stage instance completed, or the step was in progress or completed when the orchestration instance encountered an error. Error—The step instance encountered an error or the autolaunched flow associated with a step instance encountered an error. InProgress—The step instance is running, the step instance was in progress when its associated stage encountered an error, or the screen flow associated with the step instance encountered an error. NotStarted—The step instance was created, but hasn’t met its entry condition."
|
||
},
|
||
"StepType": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Restricted picklist, Sort",
|
||
"description": "The type of step. Valid values are: InteractiveStep—Interactive Step BackgroundStep—Background Step AynchronousBackgroundStep—Asynchronous Background StepThis value is available in API version 54.0 and later."
|
||
}
|
||
},
|
||
"associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **FlowOrchestrationStepInstanceFeed**: Feed tracking is available for the object.\n- **FlowOrchestrationStepInstanceHistory**: History is available for tracked fields of the object.\n- **FlowOrchestrationStepInstanceOwnerSharingRule**: Sharing rules are available for the object.\n- **FlowOrchestrationStepInstanceShare**: Sharing is available for the object.",
|
||
"wsdl_segment": "```xml\n<complexType name=\"FlowOrchestrationStepInstance\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\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=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Label\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"OrchestrationInstance\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowOrchestrationInstance\"/>\n <element name=\"OrchestrationInstanceId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"StageInstance\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowOrchestrationStageInstance\"/>\n <element name=\"StageInstanceId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"StepType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\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<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"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": "32000"
|
||
},
|
||
"Id": {
|
||
"field_label": "Orchestration Step Run ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"InProgressStepOutputs": {
|
||
"field_label": "In-Progress Step Outputs",
|
||
"type": "textarea",
|
||
"length": "100000"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"Label": {
|
||
"field_label": "Label",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"Name": {
|
||
"field_label": "Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"OrchestrationInstanceId": {
|
||
"field_label": "Orchestration Run ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"OrchestrationName": {
|
||
"field_label": "Orchestration Developer Name",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"OrchestrationStageName": {
|
||
"field_label": "Orchestration Stage Run Name",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"OwnerId": {
|
||
"field_label": "Owner ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"RelatedRecord": {
|
||
"field_label": "Context Record ID",
|
||
"type": "string",
|
||
"length": "40"
|
||
},
|
||
"StageInstanceId": {
|
||
"field_label": "Orchestration Stage Run ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Status": {
|
||
"field_label": "Status",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"StepType": {
|
||
"field_label": "Step Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length"
|
||
]
|
||
} |