Retrieve the Last Synchronization Details
get
/iot/api/v2/apps/{app-id}/integrations/{id}/sync/
Gets the status and start time of the last sync process. This API is only applicable to BICS Integrations and OSCS Integrations.
Request
Path Parameters
-
app-id: string
ID of application
-
id: string
ID of the sync instance
Response
Supported Media Types
- application/json
200 Response
Successfully processed
Root Schema : IntegrationSyncModel_receive
Type:
Show Source
object
-
id:
string
ID of sync instance
-
lastSyncTime:
string
Time of last sync
-
lastSyncTimeAsString:
string
Time of last sync in format yyyy-MM-dd'T'HH:mm:ss'Z'
-
links(optional):
array links
Set of API navigation links
-
startTime:
string
Start time of last sync
-
startTimeAsString:
string
Start time of last sync in format yyyy-MM-dd'T'HH:mm:ss'Z'
-
status:
string
Status of last sync
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Examples
The following example shows how to get the synchronization details of JDE Integration 0-U4JQ under Application 0-RYJQ by submitting a GET request on the REST resource using cURL. For more information about cURL, see
Use cURL.
Note:
In the request and response,iotserver
will be replaced by name and port of your assigned Oracle IoT Cloud Service instance. The format of the Cloud Service instance is
myinstance-myidentitydomain.iot.us.oraclecloud.com
and the default port is
443.
curl -X GET -H 'Accept:application/json' -H 'Authorization:Basic aW90OndlbGNvbWUx' "http://iotserver/iot/api/v2/apps/0-RYJQ/integrations/0-U4JQ/sync
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body containing the synchronization details for the retrieved Integration instance in JSON format.
{ "id":"0-BQ", "startTime":1468972227912, "startTimeAsString":"2016-07-19T23:50:27Z", "status":"COMPLETED", "streams":[ "id":"", "lastSyncTime":"" ], "links":[ { "rel":"canonical", "href":"http://iotserver/iot/api/v2/apps/0-RYJQ/integrations/0-U4JQ/sync" } ] }