Retrieve Job
get
/mobile/system/analyticsDataManagement/jobs/{id}
Retrieves the analytics data management job that matches the ID.
Permissions
Only team members with the MobileEnvironment_System
role can access the Analytics Data Management API.
Request
Path Parameters
-
id: integer
The ID of the job. This ID must be an existing job ID.
Response
Supported Media Types
- application/json
200 Response
Job successfully retrieved.
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.
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`
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 mobile backends.
Show Source
-
Array of:
object Mobile Backend
Title:
Mobile Backend
Mobile backend identification.
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.
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)
{
"id":"123",
"createdOn":"2015-09-02T12:34:56.789Z",
"createdBy":"UserX",
"status":"SUCCESSFUL",
"links":[
{
"rel":"canonical",
"href":"/mobile/system/analytics/dataManagement/jobs/123"
},
{
"rel":"self",
"href":"/mobile/system/analytics/dataManagement/jobs/123"
}
],
"type":"PURGE",
"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.
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
Nested Schema : Error Detail
Type:
object
Title:
Show Source
Error Detail
-
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.
404 Response
Job ID not found.
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.
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
Nested Schema : Error Detail
Type:
object
Title:
Show Source
Error Detail
-
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.
Examples
The following example shows how to retrieve an analytics job by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
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/52
Example of Response Header
The following shows an example of the response header:
200 OK Content-Type: application/json Date: Mon, 29 Jan 2018 01:16:19 GMT
Example of Response Body
The following example shows, in JSON format, the contents of the response body:
{
"id": "52",
"status": "SUCCESSFUL",
"type": "PURGE",
"createdOn": "2018-01-31T23:41:32.472Z",
"createdBy": "jdoe",
"filters": {
"startDate": "2018-01-12T07:00:00.000Z",
"endDate": "2018-01-12T09:00:00.000Z",
"mobileBackends": [
{
"name": "FixItFastCustomerMBE1",
"version": "1.0"
},
{
"name": "FixItFastCustomerMBE1",
"version": "1.1"
},
{
"name": "FixItFastCustomerMBE2",
"version": "1.0"
}
]
},
"links": [
{
"rel": "canonical",
"href": "/mobile/system/analyticsDataManagement/jobs/52"
},
{
"rel": "self",
"href": "/mobile/system/analyticsDataManagement/jobs/52"
}
]
}