Jump to

• Request
• Response
• Examples

Sync records

get

/api/v4/admin/sync

This generates the sync data as a text file for the records consumed and updated after consumption.

Versions Supported:

v4

Request

Query Parameters

• format: string
• includehierarchy: string
• jobname: string
• mapname: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

404 Response

Requested resource could not be found.

Body ()

Root Schema : schema

Type: object

500 Response

An unexpected error occurred during the request.

Body ()

Root Schema : schema

Type: object

Back to Top

Examples

Example Request:

/api/v4/admin/sync?mapname=SalesCloudCompanyExport_Release9
/api/v4/admin/sync?mapname=CXCompanyExport&jobname=syncjob

Example Output:

{
  "createdBy": "daas_admin1",
  "createdOn": "2017-04-24 06:14:55.231029",
  "fileName": "SYNC_DATA_MARKETING_CLOUD_2017_04_24_02_14_55.txt",
  "jobDefinition":
  {
      "autoImportEnabled": "N",
      "client": "SYNC",
      "createdBy": "daas_admin1",
      "createdOn": "2017-04-24 06:14:55.108758",
      "description": "Sync Data",
      "includeHierarchy": "N",
      "jobId": "10180",
      "jobMode": "Sync Request",
      "modifiedBy": "daas_admin1",
      "modifiedOn": "2017-04-24 06:14:55.108758",
      "name": "SYNC_DATA_MARKETING_CLOUD_2017_04_24_02_14_55",
      "partyType": "COMPANY",
      "scheduleMode": "IMMEDIATE",
      "scheduleType": "IMMEDIATE",
      "searchType": "COMPANIES",
      "status": "ACTIVE",
      "type": "SYNC"
  },
  "jobInstanceId": "10180",
  "logExist": "false",
  "modifiedBy": "daas_admin1",
  "modifiedOn": "2017-04-24 06:14:55.231029",
  "status": "RUNNING"
}

Back to Top