REST API Reference Version 5.2.1.0Search

Read

GET v1/jobs

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
pageSize NsUnsignedInt
id NsObjectID
name NsObjectName
description NsDescription
object_id NsObjectID
op_type NsOperationType
creation_time NsTime
percent_complete NsPercent
total_phases NsUnsignedLong
current_phase NsUnsignedLong
current_phase_description NsDescription
state NsJobStatus
completion_time NsTime
last_modified NsTime

GET v1/jobs/detail

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
fields NsCommaSeparatedList
pageSize NsUnsignedInt
id NsObjectID
name NsObjectName
description NsDescription
object_id NsObjectID
op_type NsOperationType
creation_time NsTime
percent_complete NsPercent
total_phases NsUnsignedLong
current_phase NsUnsignedLong
current_phase_description NsDescription
state NsJobStatus
completion_time NsTime
last_modified NsTime

GET v1/jobs/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

Read a set of jobs or a single job.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Detail Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for job. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsObjectName string Name of the job. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
description NsDescription string Description of the job. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
object_id NsObjectID string Identifier for object being acted upon. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
op_type NsOperationType string enum Type of operation. Possible values: 'edit_vol', 'snap_vol', 'edit_snap', 'add_vol_acl', 'remove_vol_acl', 'create_initiator_grp', 'delete_initiator_grp', 'edit_initiator_grp', 'add_fc_vol_acl', 'add_initiator', 'remove_initiator'.  
creation_time NsTime number Time when this job was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
percent_complete NsPercent number Percentage complete of the job. Percentage as integer from 0 to 100.  
total_phases NsUnsignedLong number Total number of phases of the job. Unsigned 64-bit integer. Example: 1234.  
current_phase NsUnsignedLong number Phase number of the job in progress. Unsigned 64-bit integer. Example: 1234.  
current_phase_description NsDescription string Description of the current phase of the job. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
state NsJobStatus string enum State of the job. Possible values: 'done', 'inprogress'.  
completion_time NsTime number Completion time of the job. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time of the last update from the job. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  

JSON Response 

            

{
   "startRow" : 0,
   "totalRows" : 16,
   "endRow" : 16,
   "data" : [
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776099,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776099,
         "id" : "2800000000000004d3000000000000000000000001"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776099,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776099,
         "id" : "2800000000000004d3000000000000000000000002"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776099,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776099,
         "id" : "2800000000000004d3000000000000000000000003"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776100,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776100,
         "id" : "2800000000000004d3000000000000000000000004"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776100,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776100,
         "id" : "2800000000000004d3000000000000000000000005"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776100,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776100,
         "id" : "2800000000000004d3000000000000000000000006"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776100,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776100,
         "id" : "2800000000000004d3000000000000000000000007"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776101,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776101,
         "id" : "2800000000000004d3000000000000000000000008"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776101,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776101,
         "id" : "2800000000000004d3000000000000000000000009"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776101,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776101,
         "id" : "2800000000000004d300000000000000000000000a"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776101,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776101,
         "id" : "2800000000000004d300000000000000000000000b"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776101,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776101,
         "id" : "2800000000000004d300000000000000000000000c"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776102,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776102,
         "id" : "2800000000000004d300000000000000000000000d"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776102,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776102,
         "id" : "2800000000000004d300000000000000000000000e"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776102,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776102,
         "id" : "2800000000000004d300000000000000000000000f"
      },
      {
         "current_phase" : 0,
         "current_phase_description" : "",
         "percent_complete" : 0,
         "total_phases" : 0,
         "name" : "",
         "last_modified" : 1426776102,
         "description" : "",
         "state" : "inprogress",
         "op_type" : "edit_vol",
         "completion_time" : 0,
         "object_id" : "0600000000000004d300000000000000000000000a",
         "creation_time" : 1426776102,
         "id" : "2800000000000004d3000000000000000000000010"
      }
   ]
}
Parent topic: jobs