Net3 API Interface for Customer Portal

<back to all web services

Workflow

Requires Authentication
The following routes are available for this service:
GET/workflowsReturn information about Workflows
GET/workflowReturn detailed information about workflow
POST/workflow/{workflowId}Execute workflow
Workflow Parameters:
NameParameterData TypeRequiredDescription
workflowIdpathstringNo
WorkflowBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
datacenterLocationformstringNo
WorkflowResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseformObjectNo
ReponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /workflow/{workflowId} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	workflowId: String,
	sessionId: String,
	datacenterLocation: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	response: {},
	reponseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}