Skip to content
AcrivaDocs

MapWorkflowImport

POST
/api/v1/t/{tenant}/workflows/imports/{importId}/mapping
curl --request POST \
  --url https://example.com/api/v1/t/example/workflows/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mapping \
  --header 'Content-Type: application/json' \
  --data '{ "mappings": [ { "kind": "DocumentType", "key": "example", "number": "example", "target": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

importId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
mappings
required
Array<object>
object
kind
required
Allowed values: DocumentType Role Member File Tag CostCenter Constant Workflow FileType
key
required
string
number
required
null | string
target
required
null | string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
state
required
Allowed values: NeedsMapping Applied Ready
packageSha256
required
string
commitSha
required
null | string
workflows
required
Array<object>
object
key
required
string
name
required
string
template
required
Allowed values: InvoiceApproval ContractReview MailDistribution HrFileIntake Custom
definitionId
required
null | string format: uuid
new
required
boolean
draftVersion
required
null | integer format: uint32
change
required
Allowed values: New Unchanged Changed
draftChange
required
Allowed values: None Unchanged Changed
workflowDiff
required
One of:
null
draftDiff
required
One of:
null
scripts
required
Array<object>
object
file
required
string
change
required
Allowed values: Added Removed Changed Unchanged
draftChange
required
One of:
null
diff
required
One of:
null
draftDiff
required
One of:
null
checks
required
Array<object>
object
file
required
string
checked
required
boolean
errors
required
integer format: int32
warnings
required
integer format: int32
unmapped
required
Array<object>
object
kind
required
Allowed values: DocumentType Role Member File Tag CostCenter Constant Workflow FileType
key
required
string
number
required
null | string
remembered
required
Array<object>
object
kind
required
Allowed values: DocumentType Role Member File Tag CostCenter Constant Workflow FileType
key
required
string
number
required
null | string
target
required
string format: uuid
expiresAt
required
string format: date-time
Example
{
  "state": "NeedsMapping",
  "workflows": [
    {
      "template": "InvoiceApproval",
      "change": "New",
      "draftChange": "None",
      "scripts": [
        {
          "change": "Added",
          "draftChange": "Added"
        }
      ]
    }
  ],
  "unmapped": [
    {
      "kind": "DocumentType"
    }
  ],
  "remembered": [
    {
      "kind": "DocumentType"
    }
  ]
}

400

Section titled “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

Section titled “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

Section titled “404”

Not Found

409

Section titled “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

Section titled “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"
}