Validates Move on Board settings and reads the applicable typed paths, Boards and statuses.

POST

/api/workspace/workflow/configuration/workflow-definitions/{workflowDefinitionId}/move-on-board-authoring

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/workflow/configuration/workflow-definitions/example/move-on-board-authoring"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"SourceKind\": 0, \"BoardId\": \"example\", \"BoardItemId\": \"example\", \"TargetEntityDefinitionId\": \"example\", \"Path\": [ \"example\" ], \"DestinationStatusId\": \"example\", \"SourceStatusId\": \"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/workflow/configuration/workflow-definitions/example/move-on-board-authoring';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"SourceKind":0,"BoardId":"example","BoardItemId":"example","TargetEntityDefinitionId":"example","Path":["example"],"DestinationStatusId":"example","SourceStatusId":"example"}'
};

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

curl --request POST \
  --url https://example.com/api/workspace/workflow/configuration/workflow-definitions/example/move-on-board-authoring \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "SourceKind": 0, "BoardId": "example", "BoardItemId": "example", "TargetEntityDefinitionId": "example", "Path": [ "example" ], "DestinationStatusId": "example", "SourceStatusId": "example" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

workflowDefinitionId

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

HTTP settings for the Move on Board editor; omitted members remain missing in Drafts.

object

SourceKind

integer format: int32

Allowed values: 0 1 2

BoardId

string

nullable

BoardItemId

string

nullable

TargetEntityDefinitionId

string

nullable

Path

Array<string>

nullable

DestinationStatusId

string

nullable

SourceStatusId

string

nullable

Responses

200

application/json

object

Data

object

CanSave

boolean

CanPublish

boolean

Diagnostics

Array<object>

nullable

object

Code

string

nullable

Path

string

nullable

Message

string

nullable

Line

integer format: int32

nullable

Column

integer format: int32

nullable

ExpressionStart

integer format: int32

nullable

ExpressionEnd

integer format: int32

nullable

PublicationDiagnostics

Array<object>

nullable

object

Code

string

nullable

Path

string

nullable

Message

string

nullable

Line

integer format: int32

nullable

Column

integer format: int32

nullable

ExpressionStart

integer format: int32

nullable

ExpressionEnd

integer format: int32

nullable

SourceKinds

Array<integer>

nullable

Allowed values: 0 1 2

TargetEntityDefinitions

Array<object>

nullable

object

string

nullable

DisplayName

string

nullable

Boards

Array<object>

nullable

object

string

nullable

DisplayName

string

nullable

Statuses

Array<object>

nullable

object

string

nullable

DisplayName

string

nullable

NextPaths

Array<object>

nullable

object

DisplayName

string

nullable

Path

Array<string>

nullable

Collection

boolean

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