Pipelines¶

Fetch List of Pipelines¶

GET /_config/pipelines/_list¶

Description Retrieve details of pipelines for a specific plant or function.

HTTP Method GET

Endpoint /_config/pipelines/_list

Request Header Authorization Basic <token>

Request Parameters

Query Parameters

function_id (string, optional): The unique identifier of the function for which pipeline details are requested.

plant_id (string, optional): The unique identifier of the plant for which pipeline details are requested.

Sample Request

curl --location 'https://app.4pointx.com/_config/pipelines/_list?function_id=3626c23b-2070-48bb-baaa-1170a39c0f88' \
     --header 'Authorization: Basic <token>'

Sample Response

Success

[
  {
    "pipeline_id": "ba635923-028d-4dcb-a745-85bf0a2d71f5",
    "pipeline_name": "test_ut_gateway_2",
    "data_type": "Energy",
    "data_source": "Edge IoT Gateway",
    "data_source_subtype": "Modbus RTU",
    "created_at": 1725424340216,
    "status": "starting",
    "total_events": 0,
    "latest_event": [
      null
    ],
    "heart_beats": {
      "log_parser": null,
      "producer": null,
      "gateway": null,
      "stasher": null
    },
    "last_actions": [
      {
        "completed_at": null,
        "action_id": "25d11002-4f7e-4c8f-81d0-861cc46e8182",
        "action": "start",
        "issued_at": 1732004377935,
        "status": "in_progress"
      }
    ],
    "expired_license_caution": false,
    "plant_name": "test_ut_plant",
    "function_name": "test_ut_plant_function"
  },
  {
    "pipeline_id": "f4459ebf-3468-49e9-a438-a1acd3fc489b",
    "pipeline_name": "test_pdm_gateway",
    "data_type": "Process",
    "data_source": "Edge IoT Gateway",
    "data_source_subtype": "OPC-UA",
    "created_at": 1730267562214,
    "status": "stopping",
    "total_events": 0,
    "latest_event": [
      null
    ],
    "heart_beats": {
      "log_parser": null,
      "producer": null,
      "gateway": null,
      "stasher": null
    },
    "last_actions": [
      {
        "completed_at": null,
        "action_id": "ff088b0a-2a64-4afd-8b0d-9a923a3aca09",
        "action": "stop",
        "issued_at": 1732283889065,
        "status": "in_progress"
      },
      {
        "completed_at": null,
        "action_id": "88e31dc9-b34e-415d-92b9-ecdaa12c09ee",
        "action": "stop",
        "issued_at": 1732279366756,
        "status": "in_progress"
      }
    ],
    "expired_license_caution": true,
    "plant_name": "test_ut_plant",
    "function_name": "test_ut_plant_function"
  }
]

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
    "status": 400,
    "message":  "Insufficient Inputs"
  }
}

Count Pipelines¶

GET /_config/pipelines/_count¶

Description Retrieve the total count of pipelines for a specific function or plant.

HTTP Method GET

Endpoint /_config/pipelines/_count

Request Header Authorization Basic <token>

Request Parameters

Query Parameters

plant_id (string, optional): The ID of the plant for which pipeline count is requested.

function_id (string, optional): The ID of the function for which pipeline count is requested.

status (string, optional): Filter pipelines by status (e.g., start, stop).

Sample Request

curl --location 'https://app.4pointx.com/_config/pipelines/_count?function_id=45c98f40-75e3-49e7-b178-d25ec878db79' \
     --header 'Authorization: Basic <token>'

Sample Response

Success

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
    "status": 400,
    "message":  "Insufficient Inputs"
  }
}

{
  "error": {
    "status": 400,
    "message": "Excess Inputs"
  }
}

Execute Pipeline Action¶

GET /_config/pipelines/_action¶

Description Execute an action (e.g., start or stop) on one or more pipelines.

HTTP Method POST

Endpoint /_config/pipelines/_action

Request Header Authorization Basic <token>

Request Parameters

Body Parameters

pipeline_id (array of strings, optional): A list of pipeline IDs on which the action should be executed.

action (string, optional): The action to perform on the pipelines (e.g., “start” or “stop”).

Sample Request

curl --location 'https://app.4pointx.com/_config/pipelines/_action' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Basic <token>' \
     --data '{
         "id": ["710e6fe9-c6a5-40c6-bcf4-54b6cc26d8ac"],
         "action": "start"
        }'

Sample Response

Success

"Action is being queued"

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
    "status": 400,
    "message":  "Insufficient Inputs"
  }
}

{
  "error": {
    "status": 400,
    "message": "Pipeline Not Found: 123698-287381-78348-2819"
  }
}