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

77 lines
4.0 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",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"wsdl_segment"
],
"title": "FlowDefinition - Tooling API",
"description": "The parent of a set of flow versions.",
"supported_soap_calls": "`query()`, `retrieve()`, `update()`",
"supported_rest_api_http_methods": "`GET`, `HEAD`, `PATCH`, `POST`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ActiveVersion": {
"type": "Flow",
"properties": "Filter, Group, Nillable, Sort",
"description": "The active flow version object."
},
"ActiveVersionId": {
"type": "ID",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the active flow version."
},
"Description": {
"type": "string",
"properties": "Nillable",
"description": "Flow definition information, specified by the orgs admin."
},
"DeveloperName": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "Developer name of this flow definition. In the UI, the label is Flow API Name."
},
"FullName": {
"type": "string",
"properties": "Create, Group, Nillable",
"description": "The full name of the flow definition in the Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
},
"LatestVersion": {
"type": "Flow",
"properties": "Filter, Group, Nillable, Sort",
"description": "The latest flow version object, regardless of the status."
},
"LatestVersionId": {
"type": "ID",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the latest flow version, regardless of the flows status."
},
"ManageableState": {
"type": "ManageableState enumerated list",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
},
"MasterLabel": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Label for the flow definition. In the UI, this fields label is Flow Label."
},
"Metadata": {
"type": "mns:FlowDefinition",
"properties": "Create, Nillable, Update",
"description": "The flow definitions metadata object, containing information about which flow version is active and the flow definitions description. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace associated with this flow definition."
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"FlowDefinition\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:FlowDefinition\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"FlowDefinition\">\n <xsd:complexContent>\n <xsd:extension base=\"mns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"activeVersionNumber\" minOccurs=\"0\" type=\"xsd:int\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"masterLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```"
}