This is an archive version of the document. To get the most up-to-date information, see the current version.

Editing Excluded Items

You can edit an excluded item with the specified ID.

Request

PUT https://<hostname>:4443/v5/Jobs/{jobId}/ExcludedItems/{itemId}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be specified in the URL of the request:

Parameter	Type	Description
jobId	string	Specifies the identification number of the backup job. For more information on how to get this parameter, see Getting Backup Jobs.
itemId	string	Specifies the identification number of the item in the backup file. For more information on how to get this parameter, see Getting Excluded Items.

Request Body

The following table lists available request properties:

Property	Type	Description
excludedItem	excludedItem	Specifies the excluded item that you want to edit.

For more information about properties that you must specify for different types of the excluded items, see excludeditemType.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

None.

Examples

Example 1

The example shows how to modify excluded items for a backup job.

Request:

PUT https://abc.tech.local:4443/v5/Jobs/31a66931-b5d3-49f7-bba1-c46db49d3d14/ExcludedItems/2b788f9a-0c3e-4087-be1b-226a8b9f02cb9878f4b0-ec8d-4c58-bc91-277ef992c4cc82aceabf-9192-4049-a6df-1d35c1318714

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"type": "User",

"user": {

"id": "2b788f9a-0c3e-4087-be1b-226a8b9f02cb9878f4b0-ec8d-4c58-bc91-277ef992c4cc",

"displayName": "Admin",

"name": "admin@company.onmicrosoft.com",

"type": "User",

"_links": {

"self": {

"href": "https://localhost:4443/v5/organizations/1ef78585-956d-485a-b70b-7a549f319111/users/2b788f9a-0c3e-4087-be1b-226a8b9f02cb9878f4b0-ec8d-4c58-bc91-277ef992c4cc"

"organization": {

"href": "https://localhost:4443/v5/organizations/1ef78585-956d-485a-b70b-7a549f319111"

"onedrives": {

"href": "https://localhost:4443/v5/organizations/1ef78585-956d-485a-b70b-7a549f319111/users/2b788f9a-0c3e-4087-be1b-226a8b9f02cb9878f4b0-ec8d-4c58-bc91-277ef992c4cc/onedrives"

}

"mailbox": false,

"oneDrive": true,

"archiveMailbox": false,

"site": true,

"id": "2b788f9a-0c3e-4087-be1b-226a8b9f02cb9878f4b0-ec8d-4c58-bc91-277ef992c4cc82aceabf-9192-4049-a6df-1d35c1318714",

"_links": {

"job": {

"href": "https://localhost:4443/v5/jobs/e04edb61-cb76-4b1f-a484-62aceb067a6c"

"self": {

"href": "https://localhost:4443/v5/jobs/e04edb61-cb76-4b1f-a484-62aceb067a6c/ExcludedItems /2b788f9a-0c3e-4087-be1b-226a8b9f02cb9878f4b0-ec8d-4c58-bc91-277ef992c4cc82aceabf-9192-4049-a6df-1d35c1318714"

}

Response:

200 OK