This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Objects of File Share Copy Jobs
You can get a collection resource representation of all file share backup copy job objects.
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 file share backup copy job objects, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/fileShareCopyJobs/objects collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/fileShareCopyJobs/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 |
|---|---|---|---|---|---|
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 BackupServerFileShareCopyJobObject schema.
Example 
The following request returns a representation of all objects of file share copy jobs.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/fileShareCopyJobs/objects
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "jobUid": "c1cb8cdd-52e1-485c-967f-8dd5981ee5fd", "fileServerUid": "b22961d7-b2d8-4f7e-8a82-b7d3df7532d1", "path": "srv04:/NFS", "sources": [ { "path": "srv04:/NFS", "type": "directory", "inclusionMasks": [ "*.*" ], "exclusionMasks": [] } ], "lastSession": { "backupStatus": "success", "totalBackedSize": 0, "sourceSize": 0, "duration": 76, "messages": [] } }, { "jobUid": "85499c03-a306-4754-8f72-95f0e4e91637", "fileServerUid": "c9b6ee13-499c-46ab-80b3-cfb61501568c", "path": "\\\\FILESERV05\\Documents", "sources": [ { "path": "\\\\FILESERV05\\Documents", "type": "directory", "inclusionMasks": [ "*.*" ], "exclusionMasks": [] } ], "lastSession": { "backupStatus": "success", "totalBackedSize": 0, "sourceSize": 0, "duration": 120, "messages": [] } } ] } |