--- title: "Get flow definitions using a specific credential" method: GET path: "/api/credentials/{id}/flowdefinitions" tags: ["Credentials"] --- # Get flow definitions using a specific credential `GET /api/credentials/{id}/flowdefinitions` Returns a list of all flow definitions that have a flow version or draft that is using the credential with the specified id. ## Path parameters - `id` string, uuid, required ## Query parameters - `offset` integer - `limit` integer - `conditions` Condition[] - `propertyName` string, nullable - `propertyValue` string, nullable - `operator` string, nullable - `includeCount` boolean - `descending` boolean - `orderBy` string - `filters` Filter[] - `propertyName` string, nullable - `propertyValue` string[], nullable - `filtertype` string, nullable - `ignoreCase` boolean ## Response `200` Collection of flow definitions using the specified credential matching the query. - CollectionViewModel2FlowDefinitionViewModelFlowDefinitionDto — Collection of items. - `offset` integer — The offset of the collection. - `limit` integer — The limit of the collection. - `count` integer, nullable — The total number of items in the collection. - `items` FlowDefinition[], nullable — Array of items. - `id` string, uuid — Unique identifier for the flow definition. - `organizationId` string, uuid — Unique identifier for the organization that owns the flow definition. - `name` string, nullable — Name of the flow definition. - `description` string, nullable — Description of the flow definition. - `favorite` boolean — If the flow definition is marked as a favorite for the current user. - `nextFlowVersion` integer — The number the next flow version will have. - `category` string, nullable — Category of the flow definition. - `permission` string, nullable — Permission the user has for the flow definition. Can be `Private`, `Shared` or `Organization`. - `actions` string[], nullable — Array of actions that the current user can be perform on the flow definition. - `flowDrafts` FlowDraft[], nullable — Array of flow drafts for the flow definition. - `name` string, nullable — The name of the flow. - `description` string, nullable — The description of the flow. - `notes` string, nullable — Notes about the flow. - `disabled` boolean — Whether the flow is disabled. - `autoStart` boolean — Whether the flow should start automatically. - `noOfModules` integer — The number of modules in the flow. - `updatedAt` string, date-time — The time the flow was last updated. - `haltOnError` boolean — Whether the flow should halt whenever any of the modules in the flow reports an error or if the flow itself gets an error. - `disableQueues` boolean — Whether the queues should be disabled when the flow is running on a node. - `id` string, uuid — The identifier of the flow. - `flowDefinitionId` string, uuid — The identifier of the flow definition. - `updatedBy` string, uuid — The user that last updated the flow. - `flowState` 0 | 1 | 2 | 3 | 4 | 5 - `modules` FlowModuleDto[], nullable — The modules in the flow. - `id` string, uuid — The identifier of the flow module. - `version` string, nullable — The version of the flow module. Currently always `1.0`. - `status` string, nullable — The status of the flow module. Available values are `Unknown`, `Ok`, `Warning` and `Error`. - `organization` string, nullable — The organization of the flow module. - `moduleType` string, nullable — The type of the module. Available values are `Input`, `Output` and `Function`. - `name` string, nullable — The name of the module. - `categories` string[], nullable — The categories of the module. - `haltOnError` boolean — Whether the flow should halt whenever the module reports an error. - `updateStatistics` boolean — Obsolete. Whether the module should update statistics. - `debug` boolean — Whether the module should produce debug data to be displayed when running the flow in a remote session on a node. - `disabled` boolean — Whether the module is disabled. A disabled module will not get initialized when the flow is started and not receive any messages. - `flowDraftId` string, uuid, nullable — If the module is located in a flow draft, this is the identifier of the flow draft. - `flowId` string, uuid, nullable — If the module is located in a flow, this is the identifier of the flow. - `type` string, nullable — The fully qualifying type of the module. - `maxNrOfOutputs` integer — The maximum number of outputs the module can have. - `hasInput` boolean — Whether the module has an input. - `hasOutput` boolean — Whether the module has an output. - `userFriendlyName` string, nullable — The user friendly name of the module. - `packageName` string, nullable — The package name of the module. - `metadata` object, nullable — Metadata for the module. - `settings` object, nullable — The settings of the module. - `outputs` array[], nullable — The outputs of the module. Each output of the module will get a list with it's outputs. - string[] - `nrOfOutputs` integer — The number of outputs the module has. - `moduleId` string, uuid, nullable — The identifier of the module. - `module` ModuleDto — Represents a module. - `id` string, uuid — The identifier of the module. - `organizationId` string, uuid — The identifier of the organization. - `name` string, nullable — The name of the module. - `unsafe` boolean — Whether the module is flagged as unsafe. - `iiot` boolean — Whether the module is an IIoT module. - `ipa` boolean — Whether the module is an IPA module. - `packageId` string, nullable — The package id of the module. - `moduleType` string, nullable — The type of the module. Available values are `Input`, `Output` and `Function`. - `permissionType` 0 | 1 | 2 | 3 - `moduleDisplayType` 0 | 1 | 2 - `metadata` object, nullable — Metadata for the module. - `categories` string[], nullable — The categories of the module. - `versions` ModuleVersionDto[], nullable — The versions of the module. - `name` SemVer - … - `moduleName` string, nullable — The name of the module version. - `moduleId` string, uuid — The identifier of the module. - `archived` boolean — Whether the module version is archived. An archived version works if already added in a flow but it cannot be added to flows. - `nrOfInputs` integer — The number of inputs the module version has. - `maxNrOfInputs` integer — The maximum number of inputs the module version can have. - `nrOfOutputs` integer — The number of outputs the module version has. - `maxNrOfOutputs` integer — The maximum number of outputs the module version can have. - `jsonSchema` object, nullable — The JSON schema of the module version. Describes what settings the module have and how they are specified. - `variables` object, nullable — The variables of the module version. Used for Universal Connector modules. - `metadata` object, nullable — Metadata for the module version. Will contain documentation and other information of the module version. - `uiVersion` string, nullable — Obsolete. Used in previous versions of the UI. The version of the UI component the module version settings should be presented with. - `sdkVersion` SemVer - … - `hasInteractiveSupport` boolean — Whether the module version has interactive support. - `createdAt` string, date-time — The time the module version was created. - `createdBy` string, uuid — The user that created the module version. - `updatedAt` string, date-time — The time the module version was last updated. - `updatedBy` string, uuid — The user that last updated the module version. - `createdAt` string, date-time — The time the module was created. - `createdBy` string, uuid — The user that created the module. - `updatedAt` string, date-time — The time the module was last updated. - `updatedBy` string, uuid — The user that last updated the module. - `teaser` string, nullable — The teaser of the module in markdown. - `icon` string, nullable — The icon of the module. - `currentActiveVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `changelog` string, nullable — The changelog of the module in markdown. - `moduleVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `sdkVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `unsafe` boolean — Whether the module is flagged as unsafe. - `resources` FlowResourceDto[], nullable — The resources used by the flow. - `id` string, uuid — The identifier of the flow resource. Will have the same value as `ContentId`. - `versionId` string, uuid — The identifier of the version of the flow resource. - `resourceId` string, uuid — The identifier of the resource. - `contentId` string, uuid — The identifier of the content. - `version` integer — The version of the resource used. - `organizationId` string, uuid — The identifier of the organization. - `flowModuleId` string, uuid, nullable — Optional. The identifier of the flow module if there is a module connected to the flow resource. - `setting` string, nullable - `access` 0 | 1 | 2 - `credentials` FlowCredentialDto[], nullable — The credentials used by the flow. - `id` string, uuid — The identifier of the flow credential. - `setting` string, nullable - `flowModuleId` string, uuid, nullable - `access` 0 | 1 | 2 - `flowVersion` integer — The version of the flow. - `sdkVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `metadata` object, nullable — Metadata for the flow. - `access` 0 | 1 | 2 - `warnings` string[], nullable — Validation warnings of the flow draft. - `flows` Flow[], nullable — Array of flow versions for the flow definition. - `name` string, nullable — The name of the flow. - `description` string, nullable — The description of the flow. - `notes` string, nullable — Notes about the flow. - `disabled` boolean — Whether the flow is disabled. - `autoStart` boolean — Whether the flow should start automatically. - `noOfModules` integer — The number of modules in the flow. - `updatedAt` string, date-time — The time the flow was last updated. - `haltOnError` boolean — Whether the flow should halt whenever any of the modules in the flow reports an error or if the flow itself gets an error. - `disableQueues` boolean — Whether the queues should be disabled when the flow is running on a node. - `id` string, uuid — The identifier of the flow. - `flowDefinitionId` string, uuid — The identifier of the flow definition. - `updatedBy` string, uuid — The user that last updated the flow. - `flowState` 0 | 1 | 2 | 3 | 4 | 5 - `modules` FlowModuleDto[], nullable — The modules in the flow. - `id` string, uuid — The identifier of the flow module. - `version` string, nullable — The version of the flow module. Currently always `1.0`. - `status` string, nullable — The status of the flow module. Available values are `Unknown`, `Ok`, `Warning` and `Error`. - `organization` string, nullable — The organization of the flow module. - `moduleType` string, nullable — The type of the module. Available values are `Input`, `Output` and `Function`. - `name` string, nullable — The name of the module. - `categories` string[], nullable — The categories of the module. - `haltOnError` boolean — Whether the flow should halt whenever the module reports an error. - `updateStatistics` boolean — Obsolete. Whether the module should update statistics. - `debug` boolean — Whether the module should produce debug data to be displayed when running the flow in a remote session on a node. - `disabled` boolean — Whether the module is disabled. A disabled module will not get initialized when the flow is started and not receive any messages. - `flowDraftId` string, uuid, nullable — If the module is located in a flow draft, this is the identifier of the flow draft. - `flowId` string, uuid, nullable — If the module is located in a flow, this is the identifier of the flow. - `type` string, nullable — The fully qualifying type of the module. - `maxNrOfOutputs` integer — The maximum number of outputs the module can have. - `hasInput` boolean — Whether the module has an input. - `hasOutput` boolean — Whether the module has an output. - `userFriendlyName` string, nullable — The user friendly name of the module. - `packageName` string, nullable — The package name of the module. - `metadata` object, nullable — Metadata for the module. - `settings` object, nullable — The settings of the module. - `outputs` array[], nullable — The outputs of the module. Each output of the module will get a list with it's outputs. - string[] - `nrOfOutputs` integer — The number of outputs the module has. - `moduleId` string, uuid, nullable — The identifier of the module. - `module` ModuleDto — Represents a module. - `id` string, uuid — The identifier of the module. - `organizationId` string, uuid — The identifier of the organization. - `name` string, nullable — The name of the module. - `unsafe` boolean — Whether the module is flagged as unsafe. - `iiot` boolean — Whether the module is an IIoT module. - `ipa` boolean — Whether the module is an IPA module. - `packageId` string, nullable — The package id of the module. - `moduleType` string, nullable — The type of the module. Available values are `Input`, `Output` and `Function`. - `permissionType` 0 | 1 | 2 | 3 - `moduleDisplayType` 0 | 1 | 2 - `metadata` object, nullable — Metadata for the module. - `categories` string[], nullable — The categories of the module. - `versions` ModuleVersionDto[], nullable — The versions of the module. - `name` SemVer - … - `moduleName` string, nullable — The name of the module version. - `moduleId` string, uuid — The identifier of the module. - `archived` boolean — Whether the module version is archived. An archived version works if already added in a flow but it cannot be added to flows. - `nrOfInputs` integer — The number of inputs the module version has. - `maxNrOfInputs` integer — The maximum number of inputs the module version can have. - `nrOfOutputs` integer — The number of outputs the module version has. - `maxNrOfOutputs` integer — The maximum number of outputs the module version can have. - `jsonSchema` object, nullable — The JSON schema of the module version. Describes what settings the module have and how they are specified. - `variables` object, nullable — The variables of the module version. Used for Universal Connector modules. - `metadata` object, nullable — Metadata for the module version. Will contain documentation and other information of the module version. - `uiVersion` string, nullable — Obsolete. Used in previous versions of the UI. The version of the UI component the module version settings should be presented with. - `sdkVersion` SemVer - … - `hasInteractiveSupport` boolean — Whether the module version has interactive support. - `createdAt` string, date-time — The time the module version was created. - `createdBy` string, uuid — The user that created the module version. - `updatedAt` string, date-time — The time the module version was last updated. - `updatedBy` string, uuid — The user that last updated the module version. - `createdAt` string, date-time — The time the module was created. - `createdBy` string, uuid — The user that created the module. - `updatedAt` string, date-time — The time the module was last updated. - `updatedBy` string, uuid — The user that last updated the module. - `teaser` string, nullable — The teaser of the module in markdown. - `icon` string, nullable — The icon of the module. - `currentActiveVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `changelog` string, nullable — The changelog of the module in markdown. - `moduleVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `sdkVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `unsafe` boolean — Whether the module is flagged as unsafe. - `resources` FlowResourceDto[], nullable — The resources used by the flow. - `id` string, uuid — The identifier of the flow resource. Will have the same value as `ContentId`. - `versionId` string, uuid — The identifier of the version of the flow resource. - `resourceId` string, uuid — The identifier of the resource. - `contentId` string, uuid — The identifier of the content. - `version` integer — The version of the resource used. - `organizationId` string, uuid — The identifier of the organization. - `flowModuleId` string, uuid, nullable — Optional. The identifier of the flow module if there is a module connected to the flow resource. - `setting` string, nullable - `access` 0 | 1 | 2 - `credentials` FlowCredentialDto[], nullable — The credentials used by the flow. - `id` string, uuid — The identifier of the flow credential. - `setting` string, nullable - `flowModuleId` string, uuid, nullable - `access` 0 | 1 | 2 - `flowVersion` integer — The version of the flow. - `sdkVersion` SemVer - `major` integer - `minor` integer - `patch` integer - `preReleaseVersion` string, nullable - `buildMetadata` string, nullable - `metadata` object, nullable — Metadata for the flow. - `access` 0 | 1 | 2 - `crn` Crn - `reserved1` ReadOnlySpan1Char - `length` integer - `isEmpty` boolean - `service` ReadOnlySpan1Char - `length` integer - `isEmpty` boolean - `reserved2` ReadOnlySpan1Char - `length` integer - `isEmpty` boolean - `organizationId` ReadOnlySpan1Char - `length` integer - `isEmpty` boolean - `type` ReadOnlySpan1Char - `length` integer - `isEmpty` boolean - `id` ReadOnlySpan1Char - `length` integer - `isEmpty` boolean - `path` ReadOnlySpan1Char - `length` integer - `isEmpty` boolean - `userId` string, uuid, nullable ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `503` — Service Unavailable --- [API](https://skmtc.net/crosser/apis/edge-director-api.md) · [All operations](https://skmtc.net/crosser/apis/edge-director-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crosser/edge-director-api/revisions/746b3f44e69d/schema)