Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetUploadJob

This API retrieves the details of a specific upload job.

Request Syntax


GET /domains/DomainName/upload-jobs/JobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain containing the upload job.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

JobId

The unique identifier of the upload job to retrieve.

Pattern: [a-f0-9]{32}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CompletedAt": number,
   "CreatedAt": number,
   "DataExpiry": number,
   "DisplayName": "string",
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "JobId": "string",
   "ResultsSummary": { 
      "CreatedRecords": number,
      "FailedRecords": number,
      "UpdatedRecords": number
   },
   "Status": "string",
   "StatusReason": "string",
   "UniqueKey": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CompletedAt

The timestamp when the upload job was completed.

Type: Timestamp

CreatedAt

The timestamp when the upload job was created.

Type: Timestamp

DataExpiry

The expiry duration for the profiles ingested with the upload job.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1098.

DisplayName

The unique name of the upload job. Could be a file name to identify the upload job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Fields

The mapping between CSV Columns and Profile Object attributes for the upload job.

Type: String to ObjectTypeField object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[a-zA-Z0-9_.-]+$

JobId

The unique identifier of the upload job.

Type: String

Pattern: [a-f0-9]{32}

ResultsSummary

The summary of results for the upload job, including the number of updated, created, and failed records.

Type: ResultsSummary object

Status

The status describing the status for the upload job. The following are Valid Values:

CREATED: The upload job has been created, but has not started processing yet.
IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.
PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
FAILED: The upload job has failed to complete.
STOPPED: The upload job has been manually stopped or terminated before completion.

Type: String

StatusReason

The reason for the current status of the upload job. Possible reasons:

VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.
INTERNAL_FAILURE: Failure caused from service side

Type: String

Valid Values: VALIDATION_FAILURE | INTERNAL_FAILURE

UniqueKey

The unique key columns used for de-duping the keys in the upload job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429