Jump to

• Request
• Response
• Examples

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

Body ()

Root Schema : schema

Example Request (application/json)

{
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Job initiated successfully.

Body ()

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.

{
    "description":"Information about a purge job.",
    "title":"Job",
    "type":"object",
    "required":[
        "id",
        "status",
        "filters",
        "createdOn",
        "createdBy",
        "links"
    ],
    "properties":{
        "createdBy":{
            "description":"The user name of the job creator.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "id":{
            "description":"The job ID.",
            "type":"string"
        },
        "filters":{
            "$ref":"#/definitions/filters"
        },
        "type":{
            "description":"The job type.",
            "type":"string",
            "enum":[
                "PURGE",
                "DELETION_ALL",
                "DELETION_API_CALLS",
                "DELETION_EVENTS",
                "DELETION_SESSIONS",
                "DELETION_USERS",
                "SHRINK_ALL",
                "SHRINK_API_CALLS",
                "SHRINK_EVENTS",
                "SHRINK_SESSIONS",
                "SHRINK_USERS"
            ]
        },
        "createdOn":{
            "description":"When the job was initiated.",
            "type":"string"
        },
        "status":{
            "description":"The job status.",
            "type":"string",
            "enum":[
                "PENDING",
                "RUNNING",
                "SUCCESSFUL",
                "FAILED"
            ]
        }
    }
}

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

{
    "description":"The date range of the data to delete and, optionally, for which backends.",
    "title":"Filters",
    "type":"object",
    "required":[
        "startDate",
        "endDate"
    ],
    "properties":{
        "mobileBackends":{
            "description":"(Optional) Only delete analytic data for these backends.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/mobileBackend"
            }
        },
        "endDate":{
            "description":"The end of the date range. Format: <code>YYYY-MM-DDTHH:mm:ss.SSSZ</code>",
            "type":"string"
        },
        "startDate":{
            "description":"The start of the date range. Format: <code>YYYY-MM-DDTHH:mm:ss.SSSZ</code>",
            "type":"string"
        }
    }
}

Nested Schema : Relationship links

Type: array

Title: Relationship links

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• Array of: object Link
  Title: Link

{
    "minItems":1,
    "uniqueItems":true,
    "title":"Relationship links",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : mobileBackends

Type: array

(Optional) Only delete analytic data for these backends.

Show Source

• Array of: object Backend
  Title: Backend

  Backend identification.

{
    "description":"(Optional) Only delete analytic data for these backends.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/mobileBackend"
    }
}

Nested Schema : Backend

Type: object

Title: Backend

Backend identification.

Show Source

• name(optional): string
  Backend's name.
• version(optional): string
  The backend's version.

{
    "description":"Backend identification.",
    "title":"Backend",
    "type":"object",
    "properties":{
        "name":{
            "description":"Backend's name.",
            "type":"string"
        },
        "version":{
            "description":"The backend's version.",
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Title: Link

Show Source

• href: string
  A relative URL.
• rel:
  Allowed Values: [ "self", "canonical", "prev", "next" ]

  The type of link.

{
    "title":"Link",
    "type":"object",
    "required":[
        "rel",
        "href"
    ],
    "properties":{
        "rel":{
            "description":"The type of link.",
            "enum":[
                "self",
                "canonical",
                "prev",
                "next"
            ]
        },
        "href":{
            "description":"A relative URL.",
            "type":"string"
        }
    }
}

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.

Body ()

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.

{
    "description":"The error JSON object returned by the service.",
    "title":"Error",
    "type":"object",
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "minItems":0,
            "description":"Included when the error is caused by multiple issues.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/errorDetail"
            }
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    }
}

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

{
    "minItems":0,
    "description":"Included when the error is caused by multiple issues.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/errorDetail"
    }
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• 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.

{
    "description":"",
    "title":"Error Detail",
    "type":"object",
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "properties":{
        "instance":{
            "description":"URI to the link that provides more detailed information about the error.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        }
    }
}

Back to Top

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 [e-mail]: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/"
        }
    ]
}

Back to Top