This operation is used to return failed items for a given job ID.
Request
Syntax
GET <webservice>/Job/{{jobId}}/FailedItems
Host: <host name>
Accept: application/json
Authtoken: <authentication token>
where <webservice> is the root path that routes the API requests to the Web Server.
For information on the Web Service URL, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
jobId |
The job ID for the job. If the job ID is not known, use the GET Job API to retrieve it. |
Yes |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
failedItems |
The list off all the failed items in the job that includes the item ID and reason for failure. |
JobFailedItem |
|
isFailedItemsCSV |
If the value is set to true, the FailedItemsCSV is generated. If the value is set to false, the failedItems is generated. |
JobFailedItem |
|
failedItemsCSV |
If the boolean is true, the CSV is generated. It contains a list for all the columns, and matrix of rows. |
JobFailedItem |
Examples
Sample Request
GET <webservice>/Job/45979?FailedItems
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
The sample response when the FailedItemsCSV is set to false.
{
"isFailedItemsCSV": false,
"failedItems": [
{
"failureReason": "Access is denied.",
"entity": "C:\\Users\\Administrator\\Desktop\\BackupFolder\\RestrictedFolder\\"
},
{
"failureReason": "Access is denied.",
"entity": "C:\\Users\\Administrator\\Desktop\\BackupFolder\\RestrictedFolder\\1.txt"
}
]
}
The sample response when the FailedItemsCSV is set to true.
{
"isFailedItemsCSV": true,
"failedItemsCSV": {
"columns": [
"Item Type",
"Item Name",
"Team Name",
"Path",
"Status",
"Reason",
"GUID" ],
"rows": [
{
"row": [
"Channel",
"General",
"WikiTestTeam1",
"\\WikiTestTeam1",
"Failed",
"Error in performing post items web request [https://graph.microsoft.com/beta/teams/a7104bad-3e8b-4db3-af6d-d65de48454f4/channels/19:PuCCSDsnf-BWPq1l1I_ruT52EEX0vAfWwHEkBi6jWDM1@thread.tacv2/messages]. [Error code [Forbidden], Error message [Forbidden], Status code [403] [Forbidden]]",
"19:PuCCSDsnf-BWPq1l1I_ruT52EEX0vAfWwHEkBi6jWDM1@thread.tacv2" ]
}
]
}
}