REST API Reference for Oracle Mobile Hub - Platform APIs

Retrieve Jobs

get

/mobile/system/analyticsDataManagement/jobs

Retrieves all analytics data management jobs in reverse chronological order (most recent first). You can use the offset and limit query parameters to page through the results.

Permissions

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

Request

Query Parameters

limit(optional): integer

Maximum number of items to return (default 10).
offset(optional): integer

Zero-based index of the first item to return (default 0).

Response

Supported Media Types

application/json

200 Response

All analytics data managment jobs successfully retrieved.

Root Schema : Jobs

Type: object

Title: Jobs

Analytics data management jobs.

Show Source

items(optional): array items

{
    "description":"Analytics data management jobs.",
    "title":"Jobs",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/responseJob"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Job

Title: Job

Information about a purge job.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/responseJob"
    }
}

Nested 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)

{
    "totalResults":3,
    "offset":0,
    "limit":10,
    "count":3,
    "hasMore":false,
    "items":[
        {
            "createdBy":"UserX",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/system/analytics/dataManagement/jobs/3"
                },
                {
                    "rel":"self",
                    "href":"/mobile/system/analytics/dataManagement/jobs/3"
                }
            ],
            "id":"3",
            "filters":{
                "mobileBackends":[
                    {
                        "name":"FixItFastCustomerMBE",
                        "version":"1.0"
                    }
                ],
                "endDate":"2018-11-12T17:00:00.000Z",
                "startDate":"2018-11-12T17:00:00.000Z"
            },
            "type":"PURGE",
            "createdOn":"2016-02-02T12:34:56.789Z",
            "status":"RUNNING"
        },
        {
            "createdBy":"UserX",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/system/analytics/dataManagement/jobs/2"
                },
                {
                    "rel":"self",
                    "href":"/mobile/system/analytics/dataManagement/jobs/2"
                }
            ],
            "id":"2",
            "filters":{
                "endDate":"2018-12-31T17:00:00.000Z",
                "startDate":"2018-02-01T17:00:00.000Z"
            },
            "type":"DELETION_ALL",
            "createdOn":"2016-01-12-02T12:34:56.789Z",
            "status":"FAILED"
        },
        {
            "createdBy":"UserX",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/system/analytics/dataManagement/jobs/1"
                },
                {
                    "rel":"self",
                    "href":"/mobile/system/analytics/dataManagement/jobs/1"
                }
            ],
            "id":"1",
            "filters":{
                "mobileBackends":[
                    {
                        "name":"FixItFastCustomerMBE1",
                        "version":"1.0"
                    },
                    {
                        "name":"FixItFastCustomerMBE1",
                        "version":"1.1"
                    },
                    {
                        "name":"FixItFastCustomerMBE2",
                        "version":"1.0"
                    }
                ],
                "endDate":"2018-01-31T17:00:00.000Z",
                "startDate":"2018-01-01T17:00:00.000Z"
            },
            "type":"SHRINK_ALL",
            "createdOn":"2018-09-12-02T12:34:56.789Z",
            "status":"SUCCESSFUL"
        }
    ]
}

Examples

The following example shows how to retrieve all the analytics jobs by submitting a GET request on the REST resource using cURL. This example uses the limit and offset query parameters to request the second earliest job only.

curl -i \
-X GET \
-u administrator@example.com:password \
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \
https://fif.cloud.oracle.com/mobile/system/analyticsDataManagement/jobs?limit=1&offset=1

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:06:36 GMT

Example of Response Body

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

{
    "items": [
        {
            "id": "54",
            "status": "SUCCESSFUL",
            "type": "PURGE",
            "createdOn": "2018-02-01T00:04:56.005Z",
            "createdBy": "jdoe",
            "filters": {
                "startDate": "2018-01-12T07:00:00.000Z",
                "endDate": "2018-01-12T09:00:00.000Z",
                "mobileBackends": [
                    {
                        "name": "FixItFastCustomerMBE1",
                        "version": "1.0"
                    },
                    {
                        "name": "FixItFastCustomerMBE2",
                        "version": "1.0"
                    },
                    {
                        "name": "FixItFastCustomerMBE1",
                        "version": "1.1"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "/mobile/system/analyticsDataManagement/jobs/54"
                },
                {
                    "rel": "self",
                    "href": "/mobile/system/analyticsDataManagement/jobs/54"
                }
            ]
        }
    ],
    "totalResults": 5,
    "offset": 1,
    "limit": 1,
    "count": 1,
    "hasMore": true
}