Customer 360 Data Manager Data Jobs API Developer Guide

Quick Start
Resources
Data Sources
File
Files
Job
Job File
Job Files
Jobs
Data Jobs API RAML Spec
Examples
Status Codes and Error Responses
Troubleshooting Error Codes
PDF

Jobs

Run a job or get a list of Customer 360 Data Manager data jobs.
Use the Jobs resource to create and run a Customer 360 Data Manager job. The Jobs resource has these request body types:
  • B2CtoFS: A B2C Commerce to file staging job.
  • GPtoFS: A global profile hub to file staging job.
  • FStoB2C: A file staging to B2C Commerce job.
  • FStoGP: A file staging to global profile hub job.
  • Analytics: A global profile hub to analytics job.
  • Flush: A delete all profiles job.

Syntax

Resource
Availability
v1.0
Formats
REST
HTTP methods

POST

Runs a data job.

GET

Gets a list of data jobs for your environment.
Authentication

OAuth

Request parameters
Parameter Description
baseURI

baseURI for the API gateway. Different regions have different values. Call the Data Job API lists the values.

For example: na.api-salesforce.com/datamanager/

apiVersion

Version of the DJ API to use. The current version is v1.0.

For example: v1.0
jobId

Job ID for the job. The job ID is unique per Customer 360 Data Manager environment. This ID identifies the job if you want to get information about status or files associated with the job.

For example: core%2fstmfpba44ice1%2f00DRM000000D1or2BC
GET Query parameters
resultsPerPage
Optional. Number of results to return per page.
page
Optional. The page to return in the result set. The default value is 1.
status
Optional. Filters jobs to return by status. Multiple values can be specified in an array. Valid status values include:
  • QUEUED—the job is created but not started.
  • START— the job is started but not running.
  • RUNNING—the job is running.
  • UPDATE—the job is being updated.
  • SUCCESS—the job has completed successfully.
  • FAIL—the job has failed.
sortBy
Optional. Sorts the list of jobs by a specified field attribute. The default value is createdTime.
  • id—the job ID.
  • name—the job name. If a custom name is not provided, the job name reflects the jobType, object being exported, and file type of the export.
  • status—the job status.
  • type—the job type: ANALYTICS, EXPORT, FLUSH, IMPORT, LOAD.
  • source—the data source that provides the data for the job, for example Commerce Cloud instance to import data from.
  • target—the data source that is the target of the job. For example, the data source to export to.
  • createdBy—the user that created the job.
  • createdTime—the time when the job was created.
sortDirection
Optional. Sorts the list of jobs alphanumerically in ascending or descending order. Default is desc.
  • asc—ascending
  • desc:—descending
Request headers
x-sfdc-domain
Specifies the instance_url returned in the authentication token.
accept
Specifies the type. For this resource, application/json is required.
authorization
Specifies the authorization token.
Request and Response Bodies
Consult the appropriate version of the Data Jobs RAML Spec.

Example

GET Request
Gets information about the jobs in Customer 360 Data Manager.
GET Response
B2CtoFS POST Request
A B2C Commerce to file staging job. This exports data from the SiteGenesis site for a specific Commerce Cloud instance.
B2CtoFS POST Response
GPtoFS POST Request (Single Data Source)
A global profile hub to file staging job. Exports Accounts for a specific Salesforce org that is a connected data source. To get the value for the global profile hub as a data source, call the data-sources resource and use the value for the cre data source that is returned.
GPtoFS POST Request (All Data Sources)
A global profile hub to file staging job. Exports from all data sources for all objects with a date filter. To get the value for the global profile hub as a data source, call the data-sources resource and use the value for the cre data source that is returned.
GPtoFS POST Response
FStoB2C POST Request
File staging to B2C Commerce job. This job uploads Global Party ID data to a B2C Commerce instance connected data source.
FStoB2C POST Response
FStoGP POST Request (Service Cloud)
File Staging to global profile hub job. Imports Account from a Salesforce org connected data source.
FStoGP POST Response (Service Cloud)
FStoGP POST Request (Commerce Cloud)
File Staging to global profile hub job. Imports Accounts from a B2C Commerce instance connected data source.
FStoGP POST Response (Commerce Cloud)
Analytics POST Request
A global profile hub to analytics job. Sends snapshot A to the analytics dashboard.
Analytics POST Response
Flush POST Request
Deletes all global profiles for Customer 360 Data Manager.
Flush POST Response

Usage

The GPtoFS and FStoGP request bodies for Jobs POST requests must use the external:// namespace prefix for data sources that are not connected to Customer 360 Data Manager. It’s not necessary to add the namespace prefix with a Jobs GET request. Detailed information about the request and response bodies is available in the Data Jobs RAML spec.