Qodex.ai

VFC API

Number of APIs: 8

The Visual Flow Creator (VFC) API service can be used to create, update, retrieve and delete projects and nodes which belong to projects. It also supports triggering nodes of type inject which means that users can directly start flows using the API.

Generic Errors

The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with 'mdsp.core.generic.'.

  • missingParameter (400)
  • invalidParameter (400)
  • missingRequestBodyProperty (400)
  • invalidRequestBodyProperty (400)
  • unauthorized (401)
  • forbidden (403)
  • noMatch (412)
  • unsupportedMediaType (415)
  • tooManyRequests (429)
  • internalServerError (500)

See the MindSphere Developer Documentation generic errors page for more information on these errors.

VFC API Errors

The following error codes (with status codes) may occur when executing API requests. These error codes are prefixed with 'mdsp.core.vfc.'.

  • bodyShouldBeAnArray (400)
  • validationError (400)
  • noUserGiven (400)
  • noBodyGiven (400)
  • noNodeIdGiven (400)
  • tabsLimitExceeded (400)
  • nodesLimitExceeded (400)
  • forbiddenToReadFlows (403)
  • forbiddenToSaveFlows (403)
  • forbiddenToTriggerFlows (403)
  • projectNotFound (404)
  • nodeNotFound (404)
  • nodeNotTypeOfInject (404)
  • notAllowed (405)
  • foundDuplicatedEndpoint (409)

See the MindSphere Visual Flow Creator Documentation for more information on these errors.

Visual Flow Create Documentation is available here: https://documentation.mindsphere.io/MindSphere/apps/Visual-Flow-Creator/introduction.html

  1. projects-{id}-nodes - Read project's nodes GET {{baseUrl}}/projects/:id/nodes?userId=<string>

  2. projects-{id}-nodes - Starts a flow POST {{baseUrl}}/projects/:id/nodes/:nodeId/trigger?userId=<string>

  3. projects-{id} - Read the project GET {{baseUrl}}/projects/:id?userId=<string>

  4. projects-{id} - Rename a project PATCH {{baseUrl}}/projects/:id?userId=<string>

  5. projects-{id} - Delete a project DELETE {{baseUrl}}/projects/:id?userId=<string>

  6. projects - Create new project POST {{baseUrl}}/projects?userId=<string>

  7. projects - Reads all projects of the specified user GET {{baseUrl}}/projects?userId=<string>

  8. projects-{id}-nodes - Create or replace flow nodes PUT {{baseUrl}}/projects/:id/nodes?userId=<string>