Replace configured card fields for a canonical board target definition.

PUT

/api/workspace/admin/boards/boards/{boardId}/target-definitions/{boardTargetDefinitionId}/card-fields

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/admin/boards/boards/example/target-definitions/example/card-fields"),
    Content = new StringContent("{ \"Fields\": [ { \"BoardStatusId\": \"example\", \"SourceKind\": 0, \"FieldKey\": \"example\", \"DisplayNameOverride\": \"example\", \"SortOrder\": 1 } ], \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/boards/boards/example/target-definitions/example/card-fields';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"Fields":[{"BoardStatusId":"example","SourceKind":0,"FieldKey":"example","DisplayNameOverride":"example","SortOrder":1}],"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/admin/boards/boards/example/target-definitions/example/card-fields \
  --header 'Content-Type: application/json' \
  --data '{ "Fields": [ { "BoardStatusId": "example", "SourceKind": 0, "FieldKey": "example", "DisplayNameOverride": "example", "SortOrder": 1 } ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

None

Parameters

Path Parameters

boardId

required

string

boardTargetDefinitionId

required

string

Query Parameters

access_token

string

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

Request Body

Replaces configured card fields on one canonical board target definition.

object

Fields

required

Required full replacement list of card field rows; null is rejected while an empty list removes all configured card fields. Each row must reference a field from the target’s card field catalog, the same field may appear only once per status scope, and each status scope (including the all-statuses scope) may hold at most 8 fields.

Array<object>

One requested board target card field.

object

BoardStatusId

Optional board status scope. When set it must reference an existing status of the board and the field renders only for items in that status; null shows the field for all statuses.

string

nullable

SourceKind

required

integer format: int32

Allowed values: 0 1

FieldKey

required

Required key of the field for the chosen SourceKind. The SourceKind plus FieldKey pair must exist in the target definition’s card field catalog.

string

DisplayNameOverride

Optional display label override for the card field. Null keeps the catalog display name.

string

nullable

SortOrder

Display order of the field within its status scope.

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

200

application/json

object

Data

Configured card fields for one canonical board target definition.

object

BoardId

string

nullable

BoardTargetDefinitionId

string

nullable

RowVersion

string format: uuid

Fields

Array<object>

nullable

One configured card field row.

object

string

nullable

BoardStatusId

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

string

nullable

DisplayName

string

nullable

DisplayNameOverride

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5

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

400

Bad Request

application/json

object

Data

Configured card fields for one canonical board target definition.

object

BoardId

string

nullable

BoardTargetDefinitionId

string

nullable

RowVersion

string format: uuid

Fields

Array<object>

nullable

One configured card field row.

object

string

nullable

BoardStatusId

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

string

nullable

DisplayName

string

nullable

DisplayNameOverride

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5

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

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Configured card fields for one canonical board target definition.

object

BoardId

string

nullable

BoardTargetDefinitionId

string

nullable

RowVersion

string format: uuid

Fields

Array<object>

nullable

One configured card field row.

object

string

nullable

BoardStatusId

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

string

nullable

DisplayName

string

nullable

DisplayNameOverride

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5

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

409

Conflict

application/json

object

Data

Configured card fields for one canonical board target definition.

object

BoardId

string

nullable

BoardTargetDefinitionId

string

nullable

RowVersion

string format: uuid

Fields

Array<object>

nullable

One configured card field row.

object

string

nullable

BoardStatusId

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

string

nullable

DisplayName

string

nullable

DisplayNameOverride

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5

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

Replace configured card fields for a canonical board target definition.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated