Shrink Tables
post
/mobile/system/analyticsDataManagement/shrink
Initiates a job to shrink the ApiCalls, Events, Sessions, and Users tables. Shrink requests are not filtered by startDate
, endDate
, or mobileBackends
. Therefore, it takes an empty body.
Permissions
Only team members with the Administrator
role can access the Analytics Data Management API.
Request
Supported Media Types
- application/json
Root Schema : schema
Example Request (application/json)
{
}
Response
Supported Media Types
- application/json
202 Response
Job initiated successfully.
Root Schema : Job
Type:
object
Title:
Job
Information about a purge job.
Show Source
-
createdBy:
string
The user name of the job creator.
-
createdOn:
string
When the job was initiated.
-
filters:
object Filters
Title:
Filters
The date range of the data to delete and, optionally, for which backends. -
id:
string
The job ID.
-
links:
array Relationship links
Title:
Relationship links
Minimum Number of Items:1
Unique Items Required:true
-
status:
string
Allowed Values:
[ "PENDING", "RUNNING", "SUCCESSFUL", "FAILED" ]
The job status. -
type(optional):
string
Allowed Values:
[ "PURGE", "DELETION_ALL", "DELETION_API_CALLS", "DELETION_EVENTS", "DELETION_SESSIONS", "DELETION_USERS", "SHRINK_ALL", "SHRINK_API_CALLS", "SHRINK_EVENTS", "SHRINK_SESSIONS", "SHRINK_USERS" ]
The job type.
Nested Schema : Filters
Type:
object
Title:
Filters
The date range of the data to delete and, optionally, for which backends.
Show Source
-
endDate:
string
The end of the date range. Format:
YYYY-MM-DDTHH:mm:ss.SSSZ
-
mobileBackends(optional):
array mobileBackends
(Optional) Only delete analytic data for these backends.
-
startDate:
string
The start of the date range. Format:
YYYY-MM-DDTHH:mm:ss.SSSZ
Nested Schema : Relationship links
Type:
array
Title:
Relationship links
Minimum Number of Items:
1
Unique Items Required:
Show Source
true
-
Array of:
object Link
Title:
Link
Nested Schema : mobileBackends
Type:
array
(Optional) Only delete analytic data for these backends.
Show Source
-
Array of:
object Backend
Title:
Backend
Backend identification.
Nested Schema : Backend
Type:
object
Title:
Backend
Backend identification.
Show Source
-
name(optional):
string
Backend's name.
-
version(optional):
string
The backend's version.
Nested Schema : Link
Type:
object
Title:
Show Source
Link
-
href:
string
A relative URL.
-
rel:
Allowed Values:
[ "self", "canonical", "prev", "next" ]
The type of link.
Example Response (application/json)
{
"createdBy":"UserX",
"links":[
{
"rel":"canonical",
"href":"/mobile/system/analytics/dataManagement/jobs/116"
},
{
"rel":"self",
"href":"/mobile/system/analytics/dataManagement/jobs/116"
}
],
"id":null,
"type":"SHRINK_ALL",
"createdOn":"2018-09-02T12:34:56.789Z",
"status":"PENDING"
}
400 Response
Bad request.
Root Schema : Error
Type:
object
Title:
Error
The error JSON object returned by the service.
Show Source
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : o:errorDetails
Type:
array
Minimum Number of Items:
0
Included when the error is caused by multiple issues.
Show Source
-
Array of:
object Error Detail
Title:
Error Detail
Nested Schema : Error Detail
Type:
object
Title:
Show Source
Error Detail
-
instance:
string
URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
The service's error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Examples
The following example shows how initiate a job to shrink the ApiCalls, Events, Sessions, and Users tables using cURL.
curl -i \ -X POST \ -u administrator@example.com:password \ -d '{}' \ -H "Content-Type: application/json; charset=utf-8" \ -H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \ https://fif.cloud.oracle.com/mobile/system/analyticsDataManagement/shrink
Example of Response Header
The following shows an example of the response header:
200 OK Content-Type: application/json Date: Thu, 01 Feb 2018 00:20:26 GMT
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": null,
"status": "PENDING",
"type": "SHRINK_ALL",
"createdOn": "2018-02-01T00:20:25.028Z",
"createdBy": "uimcs",
"links": [
{
"rel": "canonical",
"href": "/mobile/system/analyticsDataManagement/shrink/"
},
{
"rel": "self",
"href": "/mobile/system/analyticsDataManagement/shrink/"
}
]
}