Flows

This page provides comprehensive information and documentation on a set of API methods specifically designed to handle flows in the Integrator.

GET List Flows

This method is used to list all flows associated with a project ID, providing information such as their running state, schedule, flow name, slug, outbound/inbound details, and more.

Path: /api/nifi/flow/list?projectId=<projectId>

• Prod Integrator: https://flow.entegrator.akinon.net:3000/api/nifi/flow/list

• Dev Integrator:https://flow-dev.entegrator.akinon.net:3000/api/nifi/flow/list

Query Parameters

Parameter	In	Description	Required
projectId	query	Project identifier	✓
Authentication	header	Auth token for current user	✓

Example Response (200 OK)

• id, !flowId : Flow identifier

• state : Current state of the flow, possible responses are: RUNNING, STOPPED

• name : Flow name

• !inbound : Inbound flows run automatically based on the !schedulingPeriod parameter. If the value of this parameter is set to true, then the value of !outbound becomes false

• !outbound : Outbound flows do not run automatically and require data to be manually POSTed to the Outbound URL.

• !schedulingPeriod : If the flow is inbound, this is the Cron schedule that works alongside the flow.

  [
    {
      "component": {
        "variables": {
          "!schedulingStrategy": "CRON_DRIVEN",
          "!schedulingPeriod": "0 0,30 * * * ? *",
          "!flowType": "Product",
          "!flowId": "<flowId>",
          "!outbound": "false",
          "!omnitron.param.erp_login_slug": "erp-login",
          "!flowSlug": "product",
          "!inbound": "true"
        },
        "id": "<flowId>",
        "name": "Product",
        "parentGroupId": "<projectId>"
      },
      "id": "<flowId>",
      "state": "RUNNING"
    }
  ]

Response Errors

• Status Code 401: This status code is returned when the token is incorrect or the Authentication header is missing.

• Status Code 400: This status code is returned when the required fields are missing or incorrect.