Projects

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

GET List Projects

This method is used to list all projects associated with a partner, providing information such as their running state, project slug, ID, and more.

Path: /api/nifi/project/list?partnerId=<partnerId>

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

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

Query Parameters

Parameter
In
Description
Required

partnerId

query

Partner identifier

Authentication

header

Auth token for current user

Example Response (200 OK)

  • id : Flow identifier

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

  • name : Project name

  • !projectSlug : Project slug name

  • !projectId : Project ID

     [
         {
             "flowCount": 3, 
             "revision": {
                 "version": 0
             }, 
             "component": {
                 "variables": {
                     "!projectSlug": "project1-slug", 
                     "!projectId": "project-id1", 
                     "!createdDate": "1686261109291"
                 }, 
                 "comments": "", 
                 "parentGroupId": "partner-id", 
                 "name": "Project1", 
                 "id": "project-id1"
             },
             "id": "project-id1", 
             "state": "RUNNING"
         }, 
         {
             "flowCount": 2, 
             "revision": {
                 "version": 0
             }, 
             "component": {
                 "variables": {
                     "!projectSlug": "project2-slug", 
                     "!projectId": "project-id2", 
                     "!createdDate": "1686261109291"
                 }, 
                 "comments": "", 
                 "parentGroupId": "partner-id", 
                 "name": "Project2", 
                 "id": "project-id2"
             },
             "id": "project-id2", 
             "state": "STOPPED"
         }
     ]

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.

Last updated

Was this helpful?