Represents a versioned definition of a distributed flow, including nodes, transitions, and metadata.
Overview of FlowDefinitionInfo goes here.
Item -> BaseInfo -> FlowDefinitionInfo
| Field | Type | Inherited from | Description |
|---|---|---|---|
| Href | String | Item | Gets or sets the href. |
| CommonName | String | BaseInfo | Common Name of the resource.The common name of the resource. |
| ConcurrencyVersion | Nullable<Int64> | BaseInfo | Gets or Set the Version. |
| InFolderHref | String | BaseInfo | relative path Href value for the containing folderAll objects exist within a folder. Even folders! |
| InFolderKey | String | BaseInfo | Represents the internal ID of the containing folder |
| IsGlobal | Boolean | BaseInfo | If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects. |
| IsReadOnly | Boolean | BaseInfo | Gets or sets a value indicating whether this resource is read-only.Possible Values (true, false) |
| Key | String | BaseInfo | Represents the internal ID of the object. |
| Links | List<Link> | BaseInfo | List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required. |
| Metadata | MetadataItem[] | BaseInfo | The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data. |
| Monikers | MonikerItem[] | BaseInfo | the set of Monikers for this object |
| Notes | NoteInfo[] | BaseInfo | The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted. |
| ObjectLinks | ObjectLinkItem[] | BaseInfo | The set of resources that are related to this resource. Frequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set. |
| Tags | String[] | BaseInfo | the set of tags for this object. Tags are used to group objects together for the purposes of selection and assignment of operation rights. |
| BoundControllerKey (read only) | String | FlowDefinitionInfo | Required for Controller or Hybrid flows. Indicates which controller this flow is bound to. For Controller-scoped flows, all nodes execute on this controller. For Hybrid flows, this indicates the primary controller context for the flow, and nodes can specify execution targets to determine where they run. |
| Description | String | FlowDefinitionInfo | Gets or sets the description of the flow definition. |
| ExecutionScope | FlowExecutionScope | FlowDefinitionInfo | The execution scope for the flow, determining where nodes run (System, Controller, or Hybrid). |
| FlowMetadata | Dictionary<String> | FlowDefinitionInfo | Arbitrary metadata for the flow definition. |
| IsEnabled | Boolean | FlowDefinitionInfo | Gets or sets a value indicating whether this flow definition is enabled.Possible Values (true, false) |
| Nodes | List<FlowNodeDefinitionItem> | FlowDefinitionInfo | The list of node definitions that make up the flow. |
| Priority | Nullable<Int32> | FlowDefinitionInfo | Gets or sets the execution ordering priority for this flow definition. When multiple flows are eligible to run concurrently, flows with lower values are evaluated first. A value ofindicates no explicit priority is set. |
| Transitions | List<FlowTransitionDefinitionItem> | FlowDefinitionInfo | The list of transitions between nodes in the flow. |
{
"Href" : "String",
"CommonName" : "String",
"ConcurrencyVersion" : "Nullable\<Int64\>",
"InFolderHref" : "String",
"InFolderKey" : "String",
"IsGlobal" : "Boolean",
"IsReadOnly" : "Boolean",
"Key" : "String",
"Links" : "List\<[Link](/object-model/link)\>",
"Metadata" : "[MetadataItem](/object-model/metadataitem)[]",
"Monikers" : "[MonikerItem](/object-model/monikeritem)[]",
"Notes" : "[NoteInfo](/object-model/noteinfo)[]",
"ObjectLinks" : "[ObjectLinkItem](/object-model/objectlinkitem)[]",
"Tags" : "String[]",
"BoundControllerKey" : "String",
"Description" : "String",
"ExecutionScope" : "[FlowExecutionScope](/object-model/flowexecutionscope)",
"FlowMetadata" : "Dictionary\<String\>",
"IsEnabled" : "Boolean",
"Nodes" : "List\<[FlowNodeDefinitionItem](/object-model/flownodedefinitionitem)\>",
"Priority" : "Nullable\<Int32\>",
"Transitions" : "List\<[FlowTransitionDefinitionItem](/object-model/flowtransitiondefinitionitem)\>"
}