Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully processed

Body ()

Root Schema : IntegrationSyncModel_receive

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "id",
        "status",
        "startTime",
        "startTimeAsString",
        "lastSyncTimeAsString",
        "lastSyncTime"
    ],
    "properties":{
        "lastSyncTime":{
            "description":"Time of last sync",
            "type":"string"
        },
        "startTime":{
            "description":"Start time of last sync",
            "type":"string"
        },
        "links":{
            "description":"Set of API navigation links",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"Relation type",
                        "type":"string",
                        "example":"canonical"
                    },
                    "href":{
                        "description":"The target resource URI",
                        "type":"string",
                        "example":"https://iotserver/iot/api/vX/some/API/path"
                    }
                }
            }
        },
        "id":{
            "description":"ID of sync instance",
            "type":"string"
        },
        "status":{
            "description":"Status of last sync",
            "type":"string"
        },
        "startTimeAsString":{
            "description":"Start time of last sync in format yyyy-MM-dd'T'HH:mm:ss'Z'",
            "type":"string"
        },
        "lastSyncTimeAsString":{
            "description":"Time of last sync in format yyyy-MM-dd'T'HH:mm:ss'Z'",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Set of API navigation links

Show Source

• Array of: object items

{
    "description":"Set of API navigation links",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"Relation type",
                "type":"string",
                "example":"canonical"
            },
            "href":{
                "description":"The target resource URI",
                "type":"string",
                "example":"https://iotserver/iot/api/vX/some/API/path"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
  The target resource URI

  Example: https://iotserver/iot/api/vX/some/API/path
• rel(optional): string
  Relation type

  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"Relation type",
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "description":"The target resource URI",
            "type":"string",
            "example":"https://iotserver/iot/api/vX/some/API/path"
        }
    }
}

Back to Top

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"
      }
   ]
}

Back to Top