REST API for Oracle Mobile Cloud Service

Delete All

post

/mobile/system/analyticsDataManagement/deletion

Initiates a job to delete rows from the ApiCalls, Events, Sessions, and Users tables for the specified date range. Optionally, you can specify the mobile backends for which data is to be deleted.

Permissions

Only team members with the MobileEnvironment_System role can access the Analytics Data Management API.

Request

Supported Media Types

application/json

Root Schema : Filters

Type: object

Title: Filters

The date range of the data to delete and, optionally, for which mobile 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 mobile backends.
startDate: string

The start of the date range. Format: `YYYY-MM-DDTHH:mm:ss.SSSZ`

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

Nested Schema : mobileBackends

Type: array

(Optional) Only delete analytic data for these mobile backends.

Show Source

Array of: object Mobile Backend

Title: Mobile Backend

Mobile backend identification.

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

Nested Schema : Mobile Backend

Type: object

Title: Mobile Backend

Mobile backend identification.

Show Source

name(optional): string

Mobile backend's name.
version(optional): string

The mobile backend's version.

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

Example Request (application/json)

{
    "startDate":"2017-04-12T07:00:00.000Z",
    "mobileBackends":[
        {
            "name":"FixItFastCustomerMBE1",
            "version":"1.0"
        },
        {
            "name":"FixItFastCustomerMBE1",
            "version":"1.1"
        },
        {
            "name":"FixItFastCustomerMBE2",
            "version":"1.0"
        }
    ],
    "endDate":"2017-04-12T09:00:00.000Z"
}

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

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

Nested Schema : Filters

Type: object

Title: Filters

The date range of the data to delete and, optionally, for which mobile 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 mobile backends.
startDate: string

The start of the date range. Format: `YYYY-MM-DDTHH:mm:ss.SSSZ`

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

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

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

Nested Schema : mobileBackends

Type: array

(Optional) Only delete analytic data for these mobile backends.

Show Source

Array of: object Mobile Backend

Title: Mobile Backend

Mobile backend identification.

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

Nested Schema : Mobile Backend

Type: object

Title: Mobile Backend

Mobile backend identification.

Show Source

name(optional): string

Mobile backend's name.
version(optional): string

The mobile backend's version.

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

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",
    "properties":{
        "rel":{
            "description":"The type of link.",
            "enum":[
                "self",
                "canonical",
                "prev",
                "next"
            ]
        },
        "href":{
            "description":"A relative URL.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "type":"object"
}

Example Response (application/json)

{
    "id":null,
    "createdOn":"2015-09-02T12:34:56.789Z",
    "createdBy":"UserX",
    "status":"PENDING",
    "links":[
        {
            "rel":"canonical",
            "href":"/mobile/system/analytics/dataManagement/jobs/123"
        },
        {
            "rel":"self",
            "href":"/mobile/system/analytics/dataManagement/jobs/123"
        }
    ],
    "type":"DELETION_ALL",
    "filters":{
        "startDate":"2017-04-12T07:00:00.000Z",
        "mobileBackends":[
            {
                "name":"FixItFastCustomerMBE1",
                "version":"1.0"
            },
            {
                "name":"FixItFastCustomerMBE1",
                "version":"1.1"
            },
            {
                "name":"FixItFastCustomerMBE2",
                "version":"1.0"
            }
        ],
        "endDate":"2017-05-12T09:00:00.000Z"
    }
}

400 Response

Bad request.

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud 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

Mobile Cloud Service error code.
o:errorDetails(optional): array o:errorDetails

Minimum Number of Items: 0

List of the issues that cause the error. 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.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "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"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

Array of: object Error Detail

Title: Error Detail

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

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

instance: string

The URI to the link that provides more detailed information about the error.
o:errorCode: string

Mobile Cloud Service 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.

{
    "title":"Error Detail",
    "properties":{
        "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:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Examples

The following example shows how to initiate a job to delete rows from the ApiCalls, Events, Sessions, and Users tables for a specified backend for a specified date range using cURL. For more information about cURL, see Use cURL.

curl -i \
-X POST \ 
-u administrator@example.com:password \
-d @body.json \
-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/deletion

Examples of Request Body

The following shows an example of the request body.

{
    "startDate":"2018-01-12T07:00:00.000Z",
    "mobileBackends":[
        {
            "name":"FixItFastCustomerMBE1",
            "version":"1.0"
        },
        {
            "name":"FixItFastCustomerMBE1",
            "version":"1.1"
        },
        {
            "name":"FixItFastCustomerMBE2",
            "version":"1.0"
        }
    ],
    "endDate":"2018-01-12T09:00:00.000Z"
}

Example of Response Header

The following shows an example of the response header:

200 OK
Content-Type: application/json
Date: Wed, 31 Jan 2018 23:07:01 GMT

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "id": null,
    "status": "PENDING",
    "type": "DELETION_ALL",
    "createdOn": "2018-01-31T23:07:01.909Z",
    "createdBy": "jdoe",
    "filters": {
        "startDate": "2018-01-12T07:00:00.000Z",
        "endDate": "2018-01-12T09:00:00.000Z",
        "mobileBackends": [
            {
                "name": "FixItFastCustomerMBE1",
                "version": "1.1"
            },
            {
                "name": "FixItFastCustomerMBE2",
                "version": "1.0"
            },
            {
                "name": "FixItFastCustomerMBE1",
                "version": "1.0"
            }
        ]
    },
    "links": [
        {
            "rel": "canonical",
            "href": "/mobile/system/analyticsDataManagement/deletion/"
        },
        {
            "rel": "self",
            "href": "/mobile/system/analyticsDataManagement/deletion/"
        }
    ]
}