Update a canonical board target definition.
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"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"TargetKind\": 0, \"TargetModelId\": \"example\", \"SortOrder\": 1, \"IsActive\": true, \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"RepeatPolicy\": 0, \"CreateCommentPolicy\": 0, \"ReadCommentPolicy\": 0, \"CreateAttachmentPolicy\": 0, \"ReadAttachmentPolicy\": 0, \"PlacementPolicy\": 0, \"InitialBoardStatusId\": \"example\", \"SecurityPolicyMode\": 0, \"UseExplicitSecurityRefinements\": true, \"SecurityConditions\": [ { \"OperationKey\": \"example\", \"InitialAdmission\": true, \"Rule\": { \"Mode\": 0, \"ResourcePath\": \"example\", \"ResponsibilityKey\": \"example\", \"AnyOf\": [ { \"ResourcePath\": \"example\", \"ResponsibilityKey\": \"example\" } ], \"Match\": 0, \"Permissions\": [ { \"Key\": \"example\", \"Transition\": \"example\" } ], \"Expression\": \"example\" } } ] }") { 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';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"TargetKind":0,"TargetModelId":"example","SortOrder":1,"IsActive":true,"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","RepeatPolicy":0,"CreateCommentPolicy":0,"ReadCommentPolicy":0,"CreateAttachmentPolicy":0,"ReadAttachmentPolicy":0,"PlacementPolicy":0,"InitialBoardStatusId":"example","SecurityPolicyMode":0,"UseExplicitSecurityRefinements":true,"SecurityConditions":[{"OperationKey":"example","InitialAdmission":true,"Rule":{"Mode":0,"ResourcePath":"example","ResponsibilityKey":"example","AnyOf":[{"ResourcePath":"example","ResponsibilityKey":"example"}],"Match":0,"Permissions":[{"Key":"example","Transition":"example"}],"Expression":"example"}}]}'};
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 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "TargetKind": 0, "TargetModelId": "example", "SortOrder": 1, "IsActive": true, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0, "PlacementPolicy": 0, "InitialBoardStatusId": "example", "SecurityPolicyMode": 0, "UseExplicitSecurityRefinements": true, "SecurityConditions": [ { "OperationKey": "example", "InitialAdmission": true, "Rule": { "Mode": 0, "ResourcePath": "example", "ResponsibilityKey": "example", "AnyOf": [ { "ResourcePath": "example", "ResponsibilityKey": "example" } ], "Match": 0, "Permissions": [ { "Key": "example", "Transition": "example" } ], "Expression": "example" } } ] }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Updates a canonical board target definition.
object
Target model id. Required and must reference an existing Entity Definition for EntityDefinition targets; optional for advanced Entitlement targets, where null accepts any Entitlement model; must be null for Itself targets.
Display order of the target definition inside the board target catalog.
Whether the target definition is active for board runtime use, such as adding target objects to the board.
Required expected target definition row version for optimistic concurrency. It must match the current row version or the request fails with a conflict.
Configured Initial status of this board; required for automatic placement.
Explicit opt-in; omission leaves the configured setting unchanged.
Complete operation/purpose conditions; omission leaves the configured collection unchanged.
A condition on the exact target Entity; it cannot replace the required base permissions.
object
Portable authoring value for admission to an operation on its context.
object
The source of a context permission rule.
Resource scope used by Responsible.
Responsibility definition key used by Responsible.
Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.
A responsibility definition in an exact context resource scope.
object
How selected context permissions are combined.
Selections used by InheritPermission.
An existing permission and its optional transition selector.
object
Security DSL source used by Dsl.
Updates a canonical board target definition.
object
Target model id. Required and must reference an existing Entity Definition for EntityDefinition targets; optional for advanced Entitlement targets, where null accepts any Entitlement model; must be null for Itself targets.
Display order of the target definition inside the board target catalog.
Whether the target definition is active for board runtime use, such as adding target objects to the board.
Required expected target definition row version for optimistic concurrency. It must match the current row version or the request fails with a conflict.
Configured Initial status of this board; required for automatic placement.
Explicit opt-in; omission leaves the configured setting unchanged.
Complete operation/purpose conditions; omission leaves the configured collection unchanged.
A condition on the exact target Entity; it cannot replace the required base permissions.
object
Portable authoring value for admission to an operation on its context.
object
The source of a context permission rule.
Resource scope used by Responsible.
Responsibility definition key used by Responsible.
Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.
A responsibility definition in an exact context resource scope.
object
How selected context permissions are combined.
Selections used by InheritPermission.
An existing permission and its optional transition selector.
object
Security DSL source used by Dsl.
Updates a canonical board target definition.
object
Target model id. Required and must reference an existing Entity Definition for EntityDefinition targets; optional for advanced Entitlement targets, where null accepts any Entitlement model; must be null for Itself targets.
Display order of the target definition inside the board target catalog.
Whether the target definition is active for board runtime use, such as adding target objects to the board.
Required expected target definition row version for optimistic concurrency. It must match the current row version or the request fails with a conflict.
Configured Initial status of this board; required for automatic placement.
Explicit opt-in; omission leaves the configured setting unchanged.
Complete operation/purpose conditions; omission leaves the configured collection unchanged.
A condition on the exact target Entity; it cannot replace the required base permissions.
object
Portable authoring value for admission to an operation on its context.
object
The source of a context permission rule.
Resource scope used by Responsible.
Responsibility definition key used by Responsible.
Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.
A responsibility definition in an exact context resource scope.
object
How selected context permissions are combined.
Selections used by InheritPermission.
An existing permission and its optional transition selector.
object
Security DSL source used by Dsl.
Responses
Section titled “Responses”OK
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Configured default Initial status for automatic placement.
Explicit opt-in to saved Board Statements as additional restrictions.
Optional conditions keyed by native operation and initial-admission purpose.
A condition on the exact target Entity; it cannot replace the required base permissions.
object
Portable authoring value for admission to an operation on its context.
object
The source of a context permission rule.
Resource scope used by Responsible.
Responsibility definition key used by Responsible.
Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.
A responsibility definition in an exact context resource scope.
object
How selected context permissions are combined.
Selections used by InheritPermission.
An existing permission and its optional transition selector.
object
Security DSL source used by Dsl.
Invalid persisted settings remain visible to the configuration owner and fail closed at runtime.
A field diagnostic relative to a neutral permission rule.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Saved trusted system automation permission setting.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0, "PlacementPolicy": 0, "SecurityPolicyMode": 0, "SecurityConditions": [ { "Rule": { "Mode": 0, "Match": 0 } } ] } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Configured default Initial status for automatic placement.
Explicit opt-in to saved Board Statements as additional restrictions.
Optional conditions keyed by native operation and initial-admission purpose.
A condition on the exact target Entity; it cannot replace the required base permissions.
object
Portable authoring value for admission to an operation on its context.
object
The source of a context permission rule.
Resource scope used by Responsible.
Responsibility definition key used by Responsible.
Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.
A responsibility definition in an exact context resource scope.
object
How selected context permissions are combined.
Selections used by InheritPermission.
An existing permission and its optional transition selector.
object
Security DSL source used by Dsl.
Invalid persisted settings remain visible to the configuration owner and fail closed at runtime.
A field diagnostic relative to a neutral permission rule.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Saved trusted system automation permission setting.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0, "PlacementPolicy": 0, "SecurityPolicyMode": 0, "SecurityConditions": [ { "Rule": { "Mode": 0, "Match": 0 } } ] } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Configured default Initial status for automatic placement.
Explicit opt-in to saved Board Statements as additional restrictions.
Optional conditions keyed by native operation and initial-admission purpose.
A condition on the exact target Entity; it cannot replace the required base permissions.
object
Portable authoring value for admission to an operation on its context.
object
The source of a context permission rule.
Resource scope used by Responsible.
Responsibility definition key used by Responsible.
Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.
A responsibility definition in an exact context resource scope.
object
How selected context permissions are combined.
Selections used by InheritPermission.
An existing permission and its optional transition selector.
object
Security DSL source used by Dsl.
Invalid persisted settings remain visible to the configuration owner and fail closed at runtime.
A field diagnostic relative to a neutral permission rule.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Saved trusted system automation permission setting.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0, "PlacementPolicy": 0, "SecurityPolicyMode": 0, "SecurityConditions": [ { "Rule": { "Mode": 0, "Match": 0 } } ] } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Configured default Initial status for automatic placement.
Explicit opt-in to saved Board Statements as additional restrictions.
Optional conditions keyed by native operation and initial-admission purpose.
A condition on the exact target Entity; it cannot replace the required base permissions.
object
Portable authoring value for admission to an operation on its context.
object
The source of a context permission rule.
Resource scope used by Responsible.
Responsibility definition key used by Responsible.
Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.
A responsibility definition in an exact context resource scope.
object
How selected context permissions are combined.
Selections used by InheritPermission.
An existing permission and its optional transition selector.
object
Security DSL source used by Dsl.
Invalid persisted settings remain visible to the configuration owner and fail closed at runtime.
A field diagnostic relative to a neutral permission rule.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Saved trusted system automation permission setting.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0, "PlacementPolicy": 0, "SecurityPolicyMode": 0, "SecurityConditions": [ { "Rule": { "Mode": 0, "Match": 0 } } ] } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}