Job deletion

To delete a job, use DELETE method

path : /storiqone-backend/api/v1/job/ 

Parameters

id

: job id

Returns

HTTP status codes :

• 200 Deletion successful
• 400 Job id is required
• 401 Not logged in
• 403 Permission denied
• 404 Job not found
• 500 Query failure

Job information

To get job information, use GET method

path : /storiqone-backend/api/v1/job/ 

Parameters

id

: job id

Returns

HTTP status codes :

• 200 Query successful

  Job information is returned 

• 401 Not logged in
• 403 Permission denied
• 404 Job not found
• 500 Query failure

Jobs ids

To get jobs ids list, use GET method : without reference to specific id or ids

path : /storiqone-backend/api/v1/job/ 

Optional parameters

Name	Type	Description	Constraint
order_by	enum	order by column	single value from : 'id', 'name', 'nextstart', 'status', 'update'
order_asc	boolean	TRUE will perform an ascending order and FALSE will perform an descending order. order_asc is ignored if order_by is missing
limit	integer	specifies the maximum number of rows to return	limit > 0
offset	integer	specifies the number of rows to skip before starting to return rows	offset >= 0

Warning

To get multiple jobs ids list do not pass an id or ids as parameter

Returns

HTTP status codes :

• 200 Query successful

  Jobs ids list is returned 

• 400 Incorrect input
• 401 Not logged in
• 500 Query failure

Job update

To update a job, use PUT method

path : /storiqone-backend/api/v1/job/ 

Parameters

job	: JSON encoded object id (integer) : job id name (string) : job name nextstart (timestamp(0) with time zone) : job nextstart interval (integer) : job interval repetition (integer) : job repetition status (string) : job status metadata (JSON) : job metadata options (JSON) : job options

Returns

HTTP status codes :

• 200 Job updated successfully
• 400 Bad request - Either ; job information is required or incorrect input
• 401 Not logged in
• 403 Permission denied
• 500 Query failure

Note

Date time formats supported