Net3 API Interface for Customer Portal

<back to all web services

Job

Requires Authentication
The following routes are available for this service:
GET,POST/job/{sessionId}/{jobId}
GET,POST/job/{sessionId}/{jobId}/{datacenterLocation}
Job Parameters:
NameParameterData TypeRequiredDescription
sessionIdpathstringNo
jobIdpathstringNo
datacenterLocationpathstringNo
JobResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeJobNo
ResponseStatusformResponseStatusNo
TypeJob Parameters:
NameParameterData TypeRequiredDescription
progressformintNo
virtualsizeformdoubleNo
queuedateformDateTimeNo
jobnameformstringNo
expirationdateformDateTimeNo
appidformintNo
parentidformintNo
policynameformstringNo
idformintNo
jobcountformintNo
priorityformstringNo
changerequestformstringNo
descriptionformstringNo
isscheduledformboolNo
jobtagformstringNo
jobclassformstringNo
flagsformintNo
relativesizeformintNo
statusformstringNo
hostnameformstringNo
pidformintNo
consistencydateformDateTimeNo
startdateformDateTimeNo
retrycountformintNo
sltnameformstringNo
appnameformstringNo
sourceidformstringNo
targethostformstringNo
errorcodeformstringNo
enddateformDateTimeNo

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 /job/{sessionId}/{jobId} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	result: 
	{
		progress: 0,
		virtualsize: 0,
		queuedate: 0001-01-01,
		jobname: String,
		expirationdate: 0001-01-01,
		appid: 0,
		parentid: 0,
		policyname: String,
		id: 0,
		jobcount: 0,
		priority: String,
		changerequest: String,
		description: String,
		isscheduled: False,
		jobtag: String,
		jobclass: String,
		flags: 0,
		relativesize: 0,
		status: String,
		hostname: String,
		pid: 0,
		consistencydate: 0001-01-01,
		startdate: 0001-01-01,
		retrycount: 0,
		sltname: String,
		appname: String,
		sourceid: String,
		targethost: String,
		errorcode: String,
		enddate: 0001-01-01
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}