We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/personal/deleterequest/read

Get information about delete requests that have been sent using /personal/deleterequest/create.

Request

The request object has the following fields:

Name

Type

Required

Description

siteIds

List of strings

No

One or more identifiers for sites.

siteGroupIds

List of strings

No

One or more identifiers for sitegroups.

datetime

String

No

If non-null, results will only include entries that are registered after datetime. We accept ISO 8601 dateformats.

Or, if you want to track a single request:

Name

Type

Required

Description

id

Integer

Yes

The unique key to identify the request, returned from

/personal/deleterequest/create

or found using the request format above.

Response

Structured JSON object. The response contains deletion requests filtered by the query parameters.

The response object has the following fields:

Name | Type | Description ---|---|---|--- createTime | Integer | When the request was registered with our database. Measured as seconds after epoch. completionTime | Integer | When the request is guaranteed to be completed. The default is 7 days after we receive the request. The deletion process begins earlier than that, but data can reoccur because of network lag and backups, so deletion happens multiple times over one week to ensure complete erasure. customerId | String | The customer id used when registering the delete request id | Integer | The unique identifier for a request. siteId | String | The site id for the delete request, if present. Null otherwise. siteGroupId | String | The site id for the delete request, if present. Null otherwise. userId | String | Deprecated. The Cxense-specific identifier for the user id. userIds | Array of String | The list of Cxense-specific identifiers for the user.

Examples

Bash
# Read all siterequests with given site id
$ python cx.py /personal/deleterequest/read '{"siteIds":["310293812093123"]}'
{
"deleteRequests": [
 {"id":12345,"createTime":1,"completionTime":604801,"customerId":"741297579123","siteId":"310293812093123","userId":"12347882183947276253236523","userIds":["12347882183947276253236523"]},
 {"id":12346,"createTime":2,"completionTime":604802,"customerId":"741297579123","siteId":"310293812093123","userId":"12347882183947276253236523","userIds":["12347882183947276253236523","12347882183947276253236524"]},
 {"id":12347,"createTime":3,"completionTime":604803,"customerId":"741297579123","siteId":"310293812093123","userId":"12347882183947276253236524","userIds":["12347882183947276253236524"]}
]}

# Read all siterequests with given site id that was registered after a given date
$ python cx.py /personal/deleterequest/read '{"siteIds": ["310293812093123"],"datetime":"1500000"}'
{
"deleteRequests": [
 {"id":12347,"createTime":3,"completionTime":604803,"customerId":"741297579123","siteId":"310293812093123","userId":"12347882183947276253236524","userIds":["12347882183947276253236524"]}
]}

# Read a siterequest with given id
$ python cx.py /personal/deleterequest/read '{"id":12345}'
{
 "deleteRequests": {"id":12345,"createTime":1,"completionTime":604801,"customerId":"741297579123","siteId":"310293812093123","userId":"12347882183947276253236523","userIds":["12347882183947276253236523"]},
}

Last updated: