INintheloop
Profile

Start a bulk profile import job from a CSV file.

post/api/v1/profile/import/csv

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Query parameters

dryRunboolean

Headers

Loop-Workspace-Idstring
Authorizationstring
X-Impersonate-Userstring

Request body multipart/form-data

filestring binary

Response

OK

importTaskIdstring

Unique identifier of the import task.

userIdstring

User ID of the user who started the import task.

dryRunboolean required

Indicates whether the import task was a dry run (no actual import performed).

source'Json' | 'Csv' required

Format the profiles of an import task were submitted in. Used to translate a zero based profile index into the row number of the original document - a CSV document has a header row.

status'Pending' | 'InProgress' | 'Completed' | 'Failed' required

Current status of a profile import task.

totalRequestedinteger required

Total number of profiles submitted for import.

totalProceddedinteger required

Total number of profiles are allready procedded.

importedCountinteger required

Number of profiles successfully imported.

conflictCountinteger required

Number of profiles that already existed (conflict).

failedCountinteger required

Number of profiles that failed for reasons other than conflict.

warningCountinteger required

Number of profiles that were imported but carry at least one warning.

conflictIndexIdsobject

Index of profiles that caused a conflict, mapped to the conflict message.

failedIndexIdsobject

Index of profiles that failed, mapped to the exception message.

rowResultsTruncatedboolean required

True when RowResults hit the cap and does not list every affected row.

createdAtstring date-time required

When the import task was created.

completedAtstring date-time

When the import task finished processing, or null if still in progress.

importDataUrlLinkstring

Request import data link

errorReportUrlLinkstring

Time limited link to a CSV document holding every row that carries an issue, with the original columns plus Row, Status, ErrorCode, ErrorMessage, ErrorField and ErrorValue. Null while the task is still running and when no row had an issue.

Changes

No recorded changes to this operation across all 1 revision of this API.