Skip to main content
Nintex Community Menu Bar
Solved

Need Documentation for REST API Swagger

  • October 14, 2019
  • 3 replies
  • 120 views
  • Translate

Is there any available & if possible detailed documentation for Workflow REST API via Swagger?

The one i found is where we executed it using C# but i need to test it directly in swagger.

 

Especially in /tasks/{serialNumber}/actions/{customAction}, for any available custom action also for userDefinedFields

which corresponds to the available customAction.

 

Thanks.

Best answer by Sunrise

Good day andiak

 

Please see the following:

Workflow REST API: https://help.k2.com/onlinehelp/k2five/devref/5.3/default.htm#Runtime/WF-REST-API/WF-REST-API.htm,

How to: Use Microsoft Flow to redirect a K2 task: https://help.k2.com/onlinehelp/k2five/userguide/5.3/default.htm#How-Tos/WorkflowRESTAPI/Workflow-REST-Tasks-with-MS-Flow.htm,

Create a custom connector in Microsoft Flow to call the K2 Workflow REST API: https://help.k2.com/kb002870,

REST Swagger File Reference Format: https://help.k2.com/onlinehelp/k2five/userguide/5.3/default.htm#ServiceBrokers/EndPoints/REST_SwaggerFileReferenceFormat.htm.

 

Best,

Sunrise

 

View original
Did this topic help you find an answer to your question?

3 replies

Forum|alt.badge.img+9
  • 266 replies
  • October 14, 2019

  • 173 replies
  • Answer
  • October 14, 2019

Good day andiak

 

Please see the following:

Workflow REST API: https://help.k2.com/onlinehelp/k2five/devref/5.3/default.htm#Runtime/WF-REST-API/WF-REST-API.htm,

How to: Use Microsoft Flow to redirect a K2 task: https://help.k2.com/onlinehelp/k2five/userguide/5.3/default.htm#How-Tos/WorkflowRESTAPI/Workflow-REST-Tasks-with-MS-Flow.htm,

Create a custom connector in Microsoft Flow to call the K2 Workflow REST API: https://help.k2.com/kb002870,

REST Swagger File Reference Format: https://help.k2.com/onlinehelp/k2five/userguide/5.3/default.htm#ServiceBrokers/EndPoints/REST_SwaggerFileReferenceFormat.htm.

 

Best,

Sunrise

 

Translate

  • 151 replies
  • October 14, 2019

Good day andiak;


Please see the following KB Article that contains several detailed resources available to you for getting up-to-speed on how to use services like swagger from K2 for Working with the REST Service Broker.


https://help.k2.com/kb001786


 


Here is another link that shows you how to configure the workflow rest API with swagger endpoint functions:


https://help.k2.com/onlinehelp/K2Five/UserGuide/5.3/default.htm#K2-Management-Site/Integration/Workflow-REST-API.htm


 


Kindly please also see REST Swagger File Reference Format to familiarize yourself with the JSON file that contains information about the API and its data structure.


https://help.k2.com/onlinehelp/K2Cloud/UserGuide/Update_9/default.htm#ServiceBrokers/EndPoints/REST_SwaggerFileReferenceFormat.htm


Best regards,


Dumisani

Translate

Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie Settings