Jump to

• Request
• Response
• Examples

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 MobileEnvironment_System 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).

Back to Top

Response

Supported Media Types

• application/json

200 Response

All analytics data managment jobs successfully retrieved.

Body ()

Root Schema : Jobs

Type: object

Title: Jobs

Analytics data management jobs.

Show Source

• items(optional): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object Job
  Title: Job

  Information about a purge job.

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

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

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

Back to Top

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. For more information about cURL, see Use cURL.

curl -i \
-X GET \
-u [e-mail]: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
}

Back to Top