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

184 lines
8.8 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "FlowInterviewLog - Data API",
"description": "Represents the logs of a screen flow interview. An interview is an instance of a running or previously run flow.This object is available in API version 49.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"FlowDeveloperName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The flow's API name."
},
"FlowInterviewGuid": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "Globally unique identifier for the interview."
},
"FlowLabel": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The flows label. Only shows up in API results when users query FlowInterviewLog, or when they include this field in a report."
},
"FlowNamespace": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Namespace of the flow interview logged in the FlowInterviewLog."
},
"FlowVersionNumber": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The number of the flow version for a flow definition. Flow versions are counted sequentially from 1."
},
"InterviewDurationInMinutes": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "Total number of minutes between InterviewStartTimestamp and InterviewEndTimestamp, even if flow interview is paused."
},
"InterviewEndTimestamp": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the interview ended."
},
"InterviewStartTimestamp": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the interview started."
},
"InterviewStatus": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "Status of the interview. Valid values are: Autosaved—This value is available in API version 62.0 and later. Completed Error Expired—This value is available in API version 62.0 and later. Paused Running VersionPaused—This value is available in API version 60.0 and later."
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "Autogenerated name of the flow interview log record."
},
"OwnerId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The user who owns the FlowInterviewLog record. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
}
},
"special_access_rules": "By default, only users with the View All Data permission can access the logs for flows that are run by other users. To let users access other users flow logs, set up sharing settings with the FlowInterviewLogOwnerSharingRule object.",
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **FlowInterviewOwnerSharingRule**: Sharing rules are available for the object.",
"wsdl_segment": "```xml\n<complexType name=\"FlowInterviewLog\">\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=\"FlowDeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowInterviewGuid\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowInterviewLogs\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FlowLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowNamespace\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowVersionNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"InterviewDurationInMinutes\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"InterviewEndTimestamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"InterviewStartTimestamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"InterviewStatus\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"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"
},
"FlowDeveloperName": {
"field_label": "Flow API Name",
"type": "string",
"length": "255"
},
"FlowInterviewGuid": {
"field_label": "Flow Interview GUID",
"type": "string",
"length": "255"
},
"FlowLabel": {
"field_label": "Flow Label",
"type": "string",
"length": "255"
},
"FlowNamespace": {
"field_label": "Flow Namespace",
"type": "string",
"length": "15"
},
"FlowVersionNumber": {
"field_label": "Flow Version Number",
"type": "int",
"digits": "9"
},
"Id": {
"field_label": "Flow Interview Log ID",
"type": "id",
"length": "18"
},
"InterviewDurationInMinutes": {
"field_label": "Interview Duration In Minutes",
"type": "double",
"precision": "18",
"scale": "2"
},
"InterviewEndTimestamp": {
"field_label": "Interview End Timestamp",
"type": "datetime"
},
"InterviewStartTimestamp": {
"field_label": "Interview Start Timestamp",
"type": "datetime"
},
"InterviewStatus": {
"field_label": "Interview Status",
"type": "picklist",
"length": "255"
},
"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"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits",
"precision",
"scale"
]
}