Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
import

Import data from CSV file

post/v1/org/{orgId}/import/csv/columnMatch

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

scenarioIdstring

scenario id to import into

skipErrorsboolean required

whether to skip erroneous rows, or reject the entire upload if any are invalid (default)

upsertboolean required

whether to create persons/jobs that are not matched

createGroupsboolean required

whether to create groups that are not matched

disableSyncHireDateboolean required

whether to disable adjusting dates of hires in cases where the start dates differ

useTitleManagerMatcherboolean

whether to fall back to job title and manager for job matching

updateTypesstring

types of updates to apply (default all: title,comp,group,relationship,data,other)

notifyUserIdsstring

comma-separated list of user ids who should be notified when the import is complete

notifyAppNamestring

name of the app that should be listed in the notify

defaultChangeDatestring date

date of the changes - if not presented on the csv file

disableOverwritePersonboolean required

disable overwriting changes to persons' data -- only update data if the person field is null

importDryRunboolean required

import dry run

importAfterDryRunboolean

whether to automatically import if dry run succeeds

parentProcessIdstring

process id of parent process

importSourcestring

self identified source caller into this method

syncImagesboolean

import images from csv

ignoreResumeParentProcessboolean

Ignore resumption of parent process

transformerstring

Data transformer

postProcessorstring

Post processor

useImporterV3boolean

Use importer V3

useImporterV3ScenarioOnlyboolean

Use importer V3 for scenario imports only

performImportPhasesstring

Group import phases to perform

overwriteGroupTypesstring

Group types to overwrite

retainOpenReportingLinesboolean

when the file names a manager that is already a grand-manager with only open jobs in between, keep the existing reporting line instead of reassigning (default: on for the org engine importer, off for the job/person importer)

enrichLinkedFieldsboolean

whether to enrich jobs with job code linked field defaults during import

createJobCodesboolean

whether to create job codes that don't exist when found in import data

reassignDirectReportsOnMoveboolean

when a person moves out of a job, reassign that job's direct and indirect reports to the target job

enableRelaxedModeboolean

loosen strict import validations: backdate early create dates, route jobs with an unresolvable manager to the unassigned-manager job, and shift depart-date deletes to the next day

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent org id

labelstring required

human-readable label that identifies this process

typestring required

process type

status'PENDING' | 'RUNNING' | 'DONE' | 'ERROR' required

current status of process

filePathstring

data file path

logPathstring

data log path

runUserIdstring required

user id who is running the process

parentProcessIdstring

process id of parent process

createIdstring required

created by user id (user who requested the process run)

createBehalfIdstring

created on behalf of user id

createAtstring required

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

startAtstring

started at timestamp

endAtstring

ended at timestamp

messagestring

status or error message

progressnumber double

percent progress so far

internalErrorstring

internal-only error message

optionsobject required

options passed to the process

resultsobject

results summary for the process

stateobject

process-specific state data

summarystring

human-readable, searchable summary of what this process did

appIdstring

app id of the process

uuidstring

unique ID of the process at queue time

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "runUserId": "588f7ee98f138b19220041a7",
  "parentProcessId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "startAt": "2017-01-24T13:57:52Z",
  "endAt": "2017-01-24T13:57:52Z",
  "logDataList": [
    {
      "at": "2017-01-24T13:57:52Z"
    }
  ],
  "appId": "588f7ee98f138b19220041a7",
  "uuid": "84db3c6e-0877-4436-8af1-768c06b29586"
}