Zum Inhalt springen
AcrivaDocs

SaveImportMapping

PUT
/api/v1/t/{tenant}/ingestion/imports/{importId}/mapping
curl --request PUT \
  --url https://example.com/api/v1/t/example/ingestion/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mapping \
  --header 'Content-Type: application/json' \
  --data '{ "rules": [ { "folder": "example", "documentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "filingMode": "None", "fileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "fileTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "confidential": true, "aiOff": true } ], "csvColumns": [ { "column": "example", "target": "Ignore", "fieldKey": "example" } ], "version": 1 }'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

importId
required
string format: uuid

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
object
rules
required
Array<object> | null
object
folder
required
string
documentTypeId
required
null | string format: uuid
filingMode
required
Allowed values: None Fixed FromSubfolder
fileId
required
null | string format: uuid
fileTypeId
required
null | string format: uuid
tagIds
required
Array<string>
confidential
required
boolean
aiOff
required
boolean
csvColumns
required
Array<object> | null
object
column
required
string
target
required
Allowed values: Ignore FileName Field File
fieldKey
required
null | string
version
required
integer format: uint32

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
object
mappingVersion
required
integer format: int32
rules
required
Array<object>
object
folder
required
string
documentTypeId
required
null | string format: uuid
filingMode
required
Allowed values: None Fixed FromSubfolder
fileId
required
null | string format: uuid
fileTypeId
required
null | string format: uuid
tagIds
required
Array<string>
confidential
required
boolean
aiOff
required
boolean
csv
required
One of:
null
csvColumns
required
Array<object>
object
column
required
string
target
required
Allowed values: Ignore FileName Field File
fieldKey
required
null | string
version
required
integer format: uint32
Example
{
  "rules": [
    {
      "filingMode": "None"
    }
  ],
  "csvColumns": [
    {
      "target": "Ignore"
    }
  ]
}

400

Abschnitt betitelt „400“

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Abschnitt betitelt „403“

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Abschnitt betitelt „404“

Not Found

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Abschnitt betitelt „409“

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Abschnitt betitelt „429“

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}