Get All Objects of File Share Job
You can get a collection resource representation of all objects of a file share job with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of all objects of a file share job, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/fileShareJobs/{jobUid}/objects collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/fileShareJobs/{jobUid}/objects |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
jobUid | Path | String (uuid) | Yes | — | Job UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the BackupServerFileShareJobObject schema.
Example 
The following request returns a representation of all objects of a file share job with UID c4bcc07b-1817-4730-a626-2655cac93771.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/fileShareJobs/c4bcc07b-1817-4730-a626-2655cac93771/objects
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "jobUid": "c4bcc07b-1817-4730-a626-2655cac93771", "fileServerUid": "b2c261d7-b2d8-4f7e-8a82-b7d3df7532d1", "name": "qa04:/NFS", "sources": [ { "path": "qa04:/NFS", "type": "directory", "inclusionMasks": [ "*.*" ], "exclusionMasks": [] } ], "lastSession": { "backupStatus": "failed", "sourceFilesCount": null, "changedFilesCount": null, "skippedFilesCount": null, "backedUpFilesCount": null, "transferredSize": null, "sourceSize": 0, "duration": 80, "messages": [ "Error: Agent: Failed to process method {MetaExtent.OpenBackup}: There is not enough space on the disk.", "Backup location [C:\\Backups] is getting low on free disk space (0 B free of 119.7 GB)." ] } }, { "jobUid": "c4bcc07b-1817-4730-a626-2655cac93771", "fileServerUid": "bdc8f634-93ca-4a80-89f0-72de1a011c81", "name": "\\\\FILESERV05\\Documents", "sources": [ { "path": "\\\\FILESERV05\\Documents", "type": "directory", "inclusionMasks": [ "*.*" ], "exclusionMasks": [ "\\\\FILESERV05\\Documents\\.snapshot", "\\\\FILESERV05\\Documents\\~snapshot" ] } ], "lastSession": { "backupStatus": "success", "sourceFilesCount": 4, "changedFilesCount": 0, "skippedFilesCount": 4, "backedUpFilesCount": 0, "transferredSize": 0, "sourceSize": 7084544, "duration": 69, "messages": [] } } ] } |
