Skip to main content

Schedule A Job

This web service schedules a job for a selected time.

Query String Parameters

NameTypeDescriptionRequired
ActionStringJobScheduleRequired
JobIdIntThe Id of the job.See note.
JobRefStringThe job reference.See note.
ResourceIdIntThe resource Id.Required - see note.
ResourceRefStringThe resource reference.Required - see note.
AssetIdIntThe asset Id.Required - see note.
AssetRefStringThe asset reference.Required - see note.
ScheduleDateDateTimeDate and time that the job should be scheduled, format : yyyy-MM-dd HH:mm:ssRequired
DurationMinsIntDuration time of the job in minutes.Required
note

If the asset Id or asset reference is not populated, resource reference or resource Id must be supplied.


note

Either the JobRef or JobId can be supplied. If both parameters are provided, JobId will take precedence.

Response Codes

CodeMessageInformation
0scheduledJob.JobId
2JobId or JobRef parameter expected
2ResourceId
2Invalid parameter - scheduleDate
2durationMins parameter is missing
2Invalid parameter - durationMins
2Invalid parameter - jobId
2Invalid parameter - resourceId
2Invalid parameter - assetId
2Unable to locate Resource
2Unable to locate Asset
2Job not found

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=jobschedule