Skip to content
MoltaroMoltaroMoltaro Docs

Replace configured initial field mappings for a canonical board target definition.

PUT
/api/workspace/admin/boards/boards/{boardId}/target-definitions/{boardTargetDefinitionId}/initial-field-mappings
curl --request PUT \
  --url https://example.com/api/workspace/admin/boards/boards/example/target-definitions/example/initial-field-mappings \
  --header 'Content-Type: application/json' \
  --data '{ "Mappings": [ { "DestinationKind": 0, "DestinationFieldKey": "example", "SourceFieldKey": "example", "SortOrder": 1 } ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
boardId
required
string
boardTargetDefinitionId
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Section titled “Request Body”

Replaces configured initial field mappings on one canonical board target definition.

object
Mappings
required

Required full replacement list of initial field mapping rows; null is rejected while an empty list removes all configured mappings. Available only for EntityDefinition targets, and each destination field may be mapped at most once.

Array<object>

One requested initial field mapping.

object
DestinationKind
integer format: int32
Allowed values: 0 1 2 3
DestinationFieldKey
required

Required key of the destination field. It must exist in the destination catalog for the DestinationKind; the due-date destination is available only while the board has a date-only due-date policy enabled.

string
SourceFieldKey
required

Required key of a supported field on the primary table of the target Entity Definition. The source field type must be compatible with the destination field type.

string
SortOrder

Ordering of this mapping row within the target definition.

integer format: int32
RowVersion
required

Required expected target definition row version for optimistic concurrency. It must match the current row version or the request fails with a conflict.

string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Configured initial field mappings for one canonical board target definition.

object
BoardId
string
nullable
BoardTargetDefinitionId
string
nullable
RowVersion
string format: uuid
Mappings
Array<object>
nullable

One configured initial field mapping row.

object
Id
string
nullable
DestinationKind
integer format: int32
Allowed values: 0 1 2 3
DestinationFieldKey
string
nullable
DestinationDisplayName
string
nullable
DestinationFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SourceFieldKey
string
nullable
SourceDisplayName
string
nullable
SourceFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder
integer format: int32
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Mappings": [
      {
        "DestinationKind": 0,
        "DestinationFieldType": 0,
        "SourceFieldType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data

Configured initial field mappings for one canonical board target definition.

object
BoardId
string
nullable
BoardTargetDefinitionId
string
nullable
RowVersion
string format: uuid
Mappings
Array<object>
nullable

One configured initial field mapping row.

object
Id
string
nullable
DestinationKind
integer format: int32
Allowed values: 0 1 2 3
DestinationFieldKey
string
nullable
DestinationDisplayName
string
nullable
DestinationFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SourceFieldKey
string
nullable
SourceDisplayName
string
nullable
SourceFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder
integer format: int32
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Mappings": [
      {
        "DestinationKind": 0,
        "DestinationFieldType": 0,
        "SourceFieldType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

Configured initial field mappings for one canonical board target definition.

object
BoardId
string
nullable
BoardTargetDefinitionId
string
nullable
RowVersion
string format: uuid
Mappings
Array<object>
nullable

One configured initial field mapping row.

object
Id
string
nullable
DestinationKind
integer format: int32
Allowed values: 0 1 2 3
DestinationFieldKey
string
nullable
DestinationDisplayName
string
nullable
DestinationFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SourceFieldKey
string
nullable
SourceDisplayName
string
nullable
SourceFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder
integer format: int32
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Mappings": [
      {
        "DestinationKind": 0,
        "DestinationFieldType": 0,
        "SourceFieldType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
Data

Configured initial field mappings for one canonical board target definition.

object
BoardId
string
nullable
BoardTargetDefinitionId
string
nullable
RowVersion
string format: uuid
Mappings
Array<object>
nullable

One configured initial field mapping row.

object
Id
string
nullable
DestinationKind
integer format: int32
Allowed values: 0 1 2 3
DestinationFieldKey
string
nullable
DestinationDisplayName
string
nullable
DestinationFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SourceFieldKey
string
nullable
SourceDisplayName
string
nullable
SourceFieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
SortOrder
integer format: int32
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Mappings": [
      {
        "DestinationKind": 0,
        "DestinationFieldType": 0,
        "SourceFieldType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}