v1

latestOpenAPI 3.0.42026-08-064075233.0 KB

FlowDeployment

Get all flow deployments by flow definition id

Returns a list of all flow deployments that have the specified flow definition id.

get/api/edgenodes/flowdeployments

Query parameters

flowDefinitionIdstring uuid required

The id of the flow definition that we want to find flow deployments that have.

offsetinteger

The offset of the first item to return.

limitinteger

The maximum number of items to return.

propertyNamestring nullable

propertyValuestring nullable

operatorstring nullable

List of conditions of the items to return. Alternative to using offset and limit to define what items to return. Configuration describing from what condition we should start searching for items. Typically the value of a property returned as the last element of a previous search will be used as the condition for the next search when fetching new items. The orderBy property is typically set to the same property. <PropertyName><summary> propertyName: Name of the property to check. </summary><example>(Example: Name)</example></PropertyName><PropertyValue><summary> propertyValue: Value of the property to check. </summary><example>(Example: MyName)</example></PropertyValue><Operator><summary> operator: Operator to use when checking the property value. Available values are GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual. </summary><example>(Example: GreaterThan)</example></Operator>

includeCountboolean

Include total number of items matching the specified filter in the response.

compactboolean

If true the response will be compacted and only contain the most important information about the flow deployments.

Response

A collection of flow deployments for the specified node are returned. Note: Depending on the compact flag the items in the response will contain flow deployments with varying levels of detail.

offsetinteger

The offset of the collection.

limitinteger

The limit of the collection.

countinteger nullable

The total number of items in the collection.

Example response

{
  "limit": 10,
  "count": 100,
  "items": [
    {
      "id": "2896e0bd-ef25-4315-9e61-4bebfb53612b",
      "flowId": "0bb6b120-468a-4c7b-b121-65e88e990c9d",
      "flowDefinitionId": "3099806f-8041-417f-9136-d2587a07c226",
      "organizationId": "8b3d1b78-00c8-4b4a-8874-d5771048d750",
      "edgeNodeId": "7b66484a-ce4f-4f4b-abd9-6c7d27cdbe94",
      "parametersInSync": true,
      "lastReceivedMessage": "Some message",
      "reportedState": "Stopped",
      "wantedState": "Started",
      "flowDefinitionName": "My flow",
      "edgeNodeName": "My_node",
      "edgeNodeType": "Production",
      "flowDescription": "Flow that does something",
      "flowVersion": 1,
      "status": "Ok",
      "reviewedAt": "2024-09-25T09:33:38.013347Z",
      "reviewedBy": {
        "type": "User",
        "id": "256f791c-fbc0-4435-9429-d291227f6577",
        "name": "My User"
      },
      "statistics": {
        "flowDeploymentId": "2896e0bd-ef25-4315-9e61-4bebfb53612b",
        "uptime": [
          6625.1123
        ],
        "cpu": [
          0.5
        ],
        "messagesReceived": [
          561231
        ],
        "messagesSent": [
          8345
        ],
        "bytesReceived": [
          458920
        ],
        "bytesSent": [
          41231
        ],
        "workingSet": [
          85912140
        ],
        "warnings": [
          5123
        ],
        "errors": [
          42
        ],
        "timestamp": [
          "2024-09-30T09:02:02.36Z"
        ]
      },
      "parameters": [
        {
          "id": "My parameter",
          "type": "String",
          "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
          "createdAt": "2024-09-24T09:33:38.013347Z",
          "createdBy": "256f791c-fbc0-4435-9429-d291227f6577",
          "updatedAt": "2024-09-24T09:33:38.013347Z",
          "updatedBy": "256f791c-fbc0-4435-9429-d291227f6577",
          "flowDeploymentId": "2896e0bd-ef25-4315-9e61-4bebfb53612b"
        }
      ]
    }
  ]
}