Backup and Backup Copy Job Sessions

The /JobSessions resource collection represents backup and backup copy job sessions.

Get Job Sessions

Returns a collection of all job sessions created for backup and backup copy jobs or a backup job with the specified ID.

SecurityBearer

Request

query Parameters

jobId	string <uuid> Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.
jobType	string (RESTJobSessionType) Specifies the type of the job session. Enum: "Backup" "Copy"
endTimeLowerBound	string <date-time> Specifies the date and time. The server will return a collection of job sessions that were created after the specified date and time.
endTimeUpperBound	string <date-time> Specifies the date and time. The server will return a collection of job sessions that were created before the specified date and time.
limit	integer <int32> Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.
offset	integer <int32> Excludes from a response page the first N items of a collection resource. The default value is 0.
status	string Specifies a job status to filter job sessions. The default value is null. Enum: "Stopped" "Running" "Succeeded" "Failed" "Warning"

Responses

200

default

Operation failure response.

get/v8/JobSessions

Request samples

curl
Python
JavaScript
C#
Go

Response samples

200
default

application/json

{"offset": 0,
"limit": 0,
"setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
"results": [{"id": "00000000-0000-0000-0000-000000000000",
"jobId": "00000000-0000-0000-0000-000000000000",
"repositoryId": "00000000-0000-0000-0000-000000000000",
"mainSessionId": "00000000-0000-0000-0000-000000000000",
"details": "string",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"jobWillBeRetried": true,
"progress": 0,
"total": 0,
"jobType": "Backup",
"jobSessionConfigType": "Full",
"status": "Stopped",
"statistics": {"processingRateBytesPS": 0,
"processingRateItemsPS": 0,
"readRateBytesPS": 0,
"writeRateBytesPS": 0,
"transferredDataBytes": 0,
"processedObjects": 0,
"bottleneck": "NA"
},
"eTag": 0,
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"proxyId": "00000000-0000-0000-0000-000000000000",
"proxyPoolId": "00000000-0000-0000-0000-000000000000"
}
],
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}

Get Job Session by Session ID

Returns a resource representation of a job session with the specified ID.

SecurityBearer

Request

path Parameters

jobSessionsId

required

string <uuid>

Specifies the identification number of the job session. For more information on how to get this parameter, see Get Job Sessions.