Skip to content
MoltaroMoltaroMoltaro Docs

Plan a primary field type change in the board-owned Part entity definition.

POST
/api/workspace/admin/boards/boards/{boardId}/data-model/fields/{fieldId}/type/schema-change-plan
curl --request POST \
  --url https://example.com/api/workspace/admin/boards/boards/example/data-model/fields/example/type/schema-change-plan \
  --header 'Content-Type: application/json' \
  --data '{ "FieldType": 0, "VisibleWhen": "example", "RequiredWhen": "example", "EditableWhen": "example", "DecimalPrecision": 1, "DecimalScale": 1, "StringMaxLength": 1, "AllowMultiple": true, "ReferenceToEntityDefinitionId": "example", "PairedReferenceFieldId": "example", "AllowSort": true, "ReferenceDeleteBehavior": 0, "Options": [ { "Key": "example", "Value": "example" } ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "AddressCoordinatesRequired": true, "IsReadOnly": true, "SchemaChangeConfirmationToken": "example", "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "BaseCurrencyCode": "example", "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0, "SemanticRoleScopeFieldId": "example", "ClassifierCatalogDefinitionId": "example", "DefaultValue": { "Kind": 0, "Value": {} } }'

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
boardId
required
string
fieldId
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”

Request payload to change a field type.

object
FieldType
required
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
VisibleWhen

Visibility condition expression after the change.

string
nullable
RequiredWhen

Requiredness condition expression after the change.

string
nullable
EditableWhen

Editability condition expression after the change.

string
nullable
DecimalPrecision

Decimal precision when applicable.

integer format: int32
nullable
DecimalScale

Decimal scale when applicable.

integer format: int32
nullable
StringMaxLength

String max length when applicable.

integer format: int32
nullable
AllowMultiple

Whether multiple values are allowed.

boolean
ReferenceToEntityDefinitionId

Target entity definition identifier for reference-style fields.

string
nullable
PairedReferenceFieldId

Paired reference field identifier for inverse reference fields.

string
nullable
AllowSort

Whether root-list sorting by linked display value is allowed.

boolean
ReferenceDeleteBehavior
integer format: int32
Allowed values: 0 1 2
Options

Select options when applicable.

Array<object>
nullable

Option payload for select fields.

object
Key
required

Option key.

string
Value
required

Option display value.

string
RowVersion
required

Expected row version.

string format: uuid
AddressCoordinatesRequired

Whether address values must carry latitude and longitude.

boolean
IsReadOnly

Whether runtime writes should skip this field. Null preserves the current value.

boolean
nullable
SchemaChangeConfirmationToken

Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.

string
nullable
VisibleWhenOperationMode
integer format: int32
Allowed values: 0 1 2
RequiredWhenOperationMode
integer format: int32
Allowed values: 0 1 2
EditableWhenOperationMode
integer format: int32
Allowed values: 0 1 2
BaseCurrencyCode

Base currency code for Money fields.

string
nullable
ReferenceArchiveBehavior
integer format: int32
Allowed values: 0 1
ReferenceAuditRollupBehavior
integer format: int32
Allowed values: 0 1
SemanticRole
integer format: int32
Allowed values: 0 1 2 3
SemanticRoleScopeFieldId

Field identifier used as semantic scope, when the selected role requires one.

string
nullable
ClassifierCatalogDefinitionId

Classifier Catalog Definition identifier for Classifier fields.

string
nullable
DefaultValue

Default value configuration for an entity field.

object
Kind
integer format: int32
Allowed values: 0 1 2
Value

Constant JSON value. A scalar Reference uses one entity-instance id string. Must be null for dynamic defaults.

object

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Schema change awareness result for a planned entity schema mutation.

object
Warnings

Warnings produced by the planned schema mutation.

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
RequiresConfirmation

Whether the mutation must be explicitly confirmed before it can be applied.

boolean
ConfirmationToken

Stateless confirmation token accepted by the matching apply endpoint.

string
nullable
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": {
    "Warnings": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data

Schema change awareness result for a planned entity schema mutation.

object
Warnings

Warnings produced by the planned schema mutation.

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
RequiresConfirmation

Whether the mutation must be explicitly confirmed before it can be applied.

boolean
ConfirmationToken

Stateless confirmation token accepted by the matching apply endpoint.

string
nullable
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": {
    "Warnings": [
      {
        "Type": 0,
        "Severity": 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

Schema change awareness result for a planned entity schema mutation.

object
Warnings

Warnings produced by the planned schema mutation.

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
RequiresConfirmation

Whether the mutation must be explicitly confirmed before it can be applied.

boolean
ConfirmationToken

Stateless confirmation token accepted by the matching apply endpoint.

string
nullable
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": {
    "Warnings": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}