Skip to content
Authrim

Preview CSV field mapping.

POST
/api/admin/field-mapping/preview/csv
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/preview/csv \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "rows": [ { "Email": "[email protected]", "Department": "Engineering" } ], "columnToPath": { "Email": "email", "Department": "department" }, "catalog": { "version": "v1" }, "edges": [] }'

Runs a bounded, non-persisted CSV dry-run preview against supplied rows, column mappings, catalog, edges, transforms, and validation rules. Raw source values are not persisted.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
rows
required
Array<object>
<= 100 items
object
key
additional properties
columnToPath
required
object
key
additional properties
string
catalog
required
object
key
additional properties
edges
required
Array<object>
object
key
additional properties
transforms
Array<object>
object
key
additional properties
validationRules
Array<object>
object
key
additional properties
requiredColumns
Array<string>
key
additional properties
Example 
{
  "rows": [
    {
      "Email": "[email protected]",
      "Department": "Engineering"
    }
  ],
  "columnToPath": {
    "Email": "email",
    "Department": "department"
  },
  "catalog": {
    "version": "v1"
  },
  "edges": []
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

CSV field mapping preview response.

Media type application/json
object
preview
required
object
protocol
required
string
Allowed values: csv
persisted
required
boolean
maxRows
required
integer
key
additional properties
key
additional properties
Example 
{
  "preview": {
    "protocol": "csv",
    "persisted": false
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}