Skip to Main Content
Status Completed
Categories Workflow Designer
Created by Guest
Created on Jun 27, 2017

REST endpoints for external system to query Nintex Workflow Cloud

e.g.
REST endpoint to get list of workflow task
REST api to approve or update a workflow task
support of REST api is important when external systems needs to integrates with NWC.

e.g. external system calls external start workflow, returning the workflow instance id. External system calls api with instance id to get the workflow status, etc.
  • ADMIN RESPONSE
    Sep 7, 2022
    This is now available. please visit https://developer.nintex.com for details on how to access the endpoints.
  • Attach files
  • Guest
    Reply
    |
    Sep 7, 2022
    Hi KK, what external hosts systems are you planning to integrate with?

    In addition, what are your expectations around authorization and authentication when it comes to consuming these REST endpoints if we were to make them available?

    Thanks.
  • Guest
    Reply
    |
    Sep 7, 2022
    Hi Joshua,

    There have been many discussion with partners and customers around the topic on why they should integrate Nintex Workflow Cloud as the "Workflow Engine" for their custom built applications such as one in .NET or JAVA. Looking at the solution blocks/architecture, workflow in usually a required module/building block.

    If one would like to bundle Nintex Workflow Cloud into their solution, Nintex Workflow Cloud's endpoints for requesting resources/content/functions becoming very important. Here I will try to highlights a few example:

    A record created in DB of the external system fires a event to trigger a workflow in NWC, which returns the status of 202 saying workflow is started. The solution would like to show the refreshed/updated status of the workflow, will need to query the Nintex Workflow Cloud endpoint (e,g, getWorkflowStatus(WF-instanceID)) to query the status of a workflow instance.

    The custom developed solution will also need to have a page or portlet/webpart on a page for users to know if there is any workflow task assigned to them. The solution will include a page with content queried at Nintex Workflow Cloud's endpoint (e.g. getTaskList(userid, filteroptions)) to get a task list in xml/json returns. The page can format that content with their own format of how they want to show the list of task to the users (i.e. with link to the task).

    When user click on the task link, the external solution may want to query Nintex Workflow Cloud for additional details of the task, action done to the task could be updated via Nintex Workflow Cloud endpoint as well.

    The way i look at it is OAuth 2.0 is the standard today, or access token as presented at how the External Workflow is good too for the authentication.

    Integrating Nintex Workflow Cloud into Sharepoint Online will be quite different approach, but the proposed Nintex Workflow Cloud web service endpoints will be a solution to it by default. For Sharepoint Online, we will need to have Sharepoint Remote App to query required endpoint and present the result in supported content type such as Sharepoint List, Web Part content, pages, etc.

    Hope that clarifies.
  • Guest
    Reply
    |
    Sep 7, 2022
    I agree with KK. The one immediate example I can think of is User Dashboard, which can be a One Stop Shop for the user to access his workflow tasks from Nintex O365 and Nintex Workflow Cloud on Web App hosted on Azure.

    I can fetch anything from Nintex O365 using Microsoft Graph API but unable to fetch the relevant tasks from NWC because of this very reason.

    Can you please prioritize this feature. Thanks.
  • Guest
    Reply
    |
    Sep 7, 2022
    These endpoints look good. With respect to the Task API is there any plans to be able to re-assign a task?

    The classic use-case of ParticipantX has gone on holidays or taken another job elsewhere would come to mind. On-Prem we used to have a Workflow Task SOAP endpoint that we could call to reassign these tasks, but now we're wondering how we would do the same scenario in NWC?