API

This section covers the following topics:

CWM API Overview

Cisco developed the Cisco Crosswork Workflow Manager API based on Representational State Transfer (REST) design principles. You can access the API using HTTP and data files formatted using JSON. The API indicates the success or failure of a given request using relevant HTTP response codes. Data retrieval methods require a GET request, while methods for adding, changing, or deleting data require POST, PUT, PATCH, or DELETE methods, as appropriate. The API returns errors if you send requests using the wrong request type.

You can use the CWM API using a CWM 2.0 Postman collection in Postman.

For a full API reference, see the dedicated DevNet space: https://devnetapps.cisco.com/docs/crosswork/workflow-manager/introduction/.

Use the CNC Workflow Automation Postman collection

Follow these steps to import the collection to the Postman application and set the development environmentn.

Before you begin

Be sure that you have access to a Postman web application account or have installed the Postman desktop app. For details, see https://www.postman.com/downloads/.

You must also download the CNC Workflow Automation Postman collection in JSON format by clicking this link and then unzip the archive to an accessible storage resource.

Procedure

Step 1

Launch Postman and go to Collections.

Step 2

Click Import, select folders from the Drop anywhere to import screen, and point to the folder that you unzipped from the CNC Workflow Automation Postman collection archive.

Step 3

Go to Environments and select the newly imported test environment.

Step 4

Provide current values for the baseUrl and endPoint variables to match the IP address and port of your CNC Workflow Automation instance. Save save the changes.

To get access to the CNC Workflow Automation API, use the baseurl/crosswork/cnc/v71/, where baseurl is the IP address and port number of your Crosswork Network Controller (CNC) instance with CNC Workflow Automation installed. For example: https://172.22.141.178:30603