This is an archive version of the document. To get the most up-to-date information, see the current version.Get File Share Job
You can get a resource representation 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 a file share job, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/fileShareJobs/{jobUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/fileShareJobs/{jobUid} |
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 |
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 resource representation based on the BackupServerFileShareJob schema.
Example 
The following request returns a representation of a file share job with UID 4077308c-ef31-4cd6-bfe9-5051a26f5f7f.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/fileShareJobs/4077308c-ef31-4cd6-bfe9-5051a26f5f7f
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "4077308c-ef31-4cd6-bfe9-5051a26f5f7f", "targetRepositoryUid": "ae7f8299-a273-4f76-a4e2-c4176a8a5081", "archiveRepositoryUid": "f3a7d0fb-9de7-46c6-999f-a8b228f84893", "retention": 28, "retentionUnit": "days", "isArchiveRetentionEnabled": false, "archiveRetention": 3, "archiveRetentionUnit": "years" } } |