Read

GET v1/jobs

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
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
fields	NsCommaSeparatedList
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

HTTP Error Codes

400 401 404 500 503

Detail Error 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