Retrieve a sync

get

/api/bulk/2.0/syncs/{id}

Retrieves a sync.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : SyncIndividualResponse
Type: object
Title: SyncIndividualResponse
The response body includes information about the synchronization definition.
Show Source
  • Title: callbackUrl
    When a sync completes, Eloqua will make a call to the URL specified in this parameter. The callbackUrl does not support basic authentication. Eloqua signs outgoing calls to apps with OAuth 1.0a, so the receiving system, the app, can validate that the call was sent by Eloqua. See OAuth Signing for more details.
  • Title: createdAt
    The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the entity. This is a read-only property.
  • Title: SyncStatusType
    Default Value: pending
    Allowed Values: [ "pending", "active", "success", "warning", "error" ]
    The status of the synchronization. This is a read-only property.
  • Title: syncedInstanceUri
    This value should be the uri for the export/import definition you wish to sync. When you create an import/export definition, Eloqua will respond with a "uri" parameter, the value of which should be used here.
  • Title: syncEndedAt
    The date and time the sync ended. This is a read-only property.
  • Title: syncStartedAt
    The date and time the sync started. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

The following examples demonstrate how to retrieve a sync using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the sync with ID = 5:


GET /syncs/5
			

Response:


{
    "syncedInstanceUri":"/contacts/exports/5",
    "syncStartedAt":"2014-06-17T21:05:28.6100000Z",
    "syncEndedAt":"2014-06-17T21:05:29.4400000Z",
    "status":"success",
    "createdAt":"2014-06-17T21:05:28.3770000Z",
    "createdBy":"EloquaSystem",
    "uri":"/syncs/5"
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/bulk/2.0/syncs/5
			
Back to Top