Skip to content

Delete Multiple Objects

Note

This section is applicable only for region Europe 2.

To delete multiple objects from the specified path, create an asynchronous jobs. Jobs which are completed with or without errors will be deleted periodically. Once the data is deleted, it cannot be recovered. Create asynchronous job to delete multiple objects for the specified paths. Jobs which are completed with or without errors would be deleted periodically. Oce the data is deleted, it cannot be recovered.

Provide delete permission

The tenantAdmin can access this API and provide delete permission on folder or path, on the subtenants folder and on the root folder, except for the Time Series Import (TSI) folder.

1
POST /deleteObjectsJobs

Content-Type: application/json

Request Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "objects": [
    {
    "path": "/IntegrationTest/IntegrationTestFile1"
    },
    {
    "path": "/IntegrationTest/IntegrationTestFile2"
    }
  ]
}

Response Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "id": "63527e00-f4f6-4566-82bd-2f3ec81450fc",
    "status": "IN_PROGRESS",
    "progressDetails": {
        "totalObjects": 2,
        "inProgressObjects": 0,
        "deletedObjects": 0,
        "failedObjects": 0
    }
}

Get a list of deleted objects for the given ID

1
GET /deleteObjectsJobs/{id}

Content-Type: application/json

Response Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "id": "63527e00-f4f6-4566-82bd-2f3ec81450fc",
    "status": "COMPLETED",
    "progressDetails": {
        "totalObjects": 2,
        "inProgressObjects": 0,
        "deletedObjects": 2,
        "failedObjects": 0
    }
}

Get list of all deleted objects

1
GET /deleteObjectsJobs/

Content-Type: application/json

Response Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
    "id": "63527e00-f4f6-4566-82bd-2f3ec81450fc",
    "status": "COMPLETED",
    "progressDetails": {
        "totalObjects": 2,
        "inProgressObjects": 0,
        "deletedObjects": 2,
        "failedObjects": 0
    }
    },
    {
    "id": "63527e00-f4f6-5677-82bd-2f3ec81458gb",
    "status": "COMPLETED",
    "progressDetails": {
        "totalObjects": 2,
        "inProgressObjects": 0,
        "deletedObjects": 2,
        "failedObjects": 0
    }
}

Get list of error details of the deleted objects

1
GET /deleteObjectsJobs/{id}/errorDetails

Content-Type: application/json

Response Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "id": "3b8aded7-d19c-4dff-af58-4a2840c3fe55",
  "subtenantId": "204a896c-a23a-11e9-a2a3-2a2ae2dbcce4",
  "progressDetails": {
    "totalObjects": 0,
    "inProgressObjects": 0,
    "deletedObjects": 0,
    "failedObjects": 0
  },
  "status": "COMPLETED",
  "objects": [
    {
      "path": "string",
      "status": "FAILED"
    }
  ]
}

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.