Plan a Blueprint application without mutating workspace configuration.

POST

/api/workspace/admin/blueprints/{blueprintKey}/plan

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/blueprints/example/plan"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Parameters\": { \"additionalProperty\": \"example\" }, \"SelectedOptionalItemIds\": [ \"example\" ], \"RuntimeMenuNavigation\": { \"Enabled\": true, \"RuntimeMenuId\": \"example\" }, \"DependencyResolutions\": [ { \"SlotKey\": \"example\", \"Mode\": 0, \"EntityDefinitionId\": \"example\", \"FieldMappings\": { \"additionalProperty\": \"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/blueprints/example/plan';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Parameters":{"additionalProperty":"example"},"SelectedOptionalItemIds":["example"],"RuntimeMenuNavigation":{"Enabled":true,"RuntimeMenuId":"example"},"DependencyResolutions":[{"SlotKey":"example","Mode":0,"EntityDefinitionId":"example","FieldMappings":{"additionalProperty":"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/admin/blueprints/example/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Parameters": { "additionalProperty": "example" }, "SelectedOptionalItemIds": [ "example" ], "RuntimeMenuNavigation": { "Enabled": true, "RuntimeMenuId": "example" }, "DependencyResolutions": [ { "SlotKey": "example", "Mode": 0, "EntityDefinitionId": "example", "FieldMappings": { "additionalProperty": "example" } } ] }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

blueprintKey

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

Request payload for Blueprint planning.

object

Parameters

object

key

additional properties

SelectedOptionalItemIds

Array<string>

nullable

RuntimeMenuNavigation

Runtime-menu navigation selection for Blueprint plan and apply.

object

Enabled

boolean

nullable

RuntimeMenuId

string

nullable

DependencyResolutions

Array<object>

nullable

Resolution of one Blueprint dependency slot.

object

SlotKey

string

nullable

Mode

integer format: int32

Allowed values: 0

EntityDefinitionId

string

nullable

FieldMappings

object

key

additional properties

string

Responses

200

application/json

object

Data

Plan response for a Blueprint request.

object

Blueprint

Full catalog metadata and wizard schema for one Blueprint.

object

Key

string

nullable

Version

string

nullable

Level

string

nullable

CategoryGroup

string

nullable

Category

string

nullable

Title

string

nullable

Description

string

nullable

Nodes

Array<object>

nullable

One graph node in a Blueprint wizard.

object

string

nullable

BlueprintKey

string

nullable

Title

string

nullable

ParentNodeId

string

nullable

Sections

Array<object>

nullable

One wizard section rendered from metadata.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Parameters

Array<object>

nullable

One metadata-driven wizard parameter.

object

Key

string

nullable

Label

string

nullable

Type

integer format: int32

Allowed values: 0 1 2 3 4 5 6

Required

boolean

DefaultValue

nullable

Options

Array<object>

nullable

One selectable option for metadata-driven Blueprint parameters.

object

Value

string

nullable

Label

string

nullable

Description

string

nullable

Minimum

number format: double

nullable

Maximum

number format: double

nullable

VisibleWhenAll

Array<object>

nullable

Declarative scalar equality condition for Blueprint wizard parameters.

object

ParameterKey

string

nullable

ExpectedValue

EnabledWhenAll

Array<object>

nullable

Declarative scalar equality condition for Blueprint wizard parameters.

object

ParameterKey

string

nullable

ExpectedValue

IncludeEveryoneRole

boolean

PostApplyActions

Array<object>

nullable

Manual action recommended after a Blueprint application is completed.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Required

boolean

RuntimeMenuNavigation

Blueprint runtime-menu navigation capability shown by the generic wizard.

object

Title

string

nullable

Description

string

nullable

EnabledByDefault

boolean

DefaultMenuName

string

nullable

DependencySlots

Array<object>

nullable

One dependency that a Blueprint must resolve before planning.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Kind

integer format: int32

Allowed values: 0

Required

boolean

AllowedModes

Array<integer>

nullable

Allowed values: 0

FieldMappings

Array<object>

nullable

One required semantic field mapping for an Entity Definition dependency.

object

Key

Stable semantic mapping key.

string

nullable

Label

Localized mapping label.

string

nullable

Description

Localized mapping guidance.

string

nullable

AllowedFieldTypes

Allowed source field types.

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

Required

Whether the mapping must be provided.

boolean

SuggestedFieldKeys

Preferred source field keys in matching order.

Array<string>

nullable

TargetStringMaxLength

Maximum string length accepted by the generated target field.

integer format: int32

nullable

TargetDecimalPrecision

Decimal precision of the generated target field.

integer format: int32

nullable

TargetDecimalScale

Decimal scale of the generated target field.

integer format: int32

nullable

EffectiveRequestHash

string

nullable

Sections

Array<object>

nullable

Plan section grouping related plan items.

object

Key

string

nullable

Title

string

nullable

ItemIds

Array<string>

nullable

Items

Array<object>

nullable

One planned artifact action.

object

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

Label

string

nullable

Action

integer format: int32

Allowed values: 0 1 2

Status

integer format: int32

Allowed values: 0 1 2

Required

boolean

Selectable

boolean

SelectedByDefault

boolean

ArtifactKey

string

nullable

ArtifactId

string

nullable

Message

string

nullable

DependsOnItemIds

Array<string>

nullable

OpenTargets

Array<object>

nullable

Post-apply navigation target.

object

Key

string

nullable

Label

string

nullable

Kind

string

nullable

EntityDefinitionId

string

nullable

RecordMatchingProfileId

string

nullable

CatalogDefinitionId

string

nullable

CanApply

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": {
    "Blueprint": {
      "Nodes": [
        {
          "Sections": [
            {
              "Parameters": [
                {
                  "Type": 0
                }
              ]
            }
          ]
        }
      ],
      "DependencySlots": [
        {
          "Kind": 0,
          "AllowedModes": [
            0
          ],
          "FieldMappings": [
            {
              "AllowedFieldTypes": [
                0
              ]
            }
          ]
        }
      ]
    },
    "Items": [
      {
        "Kind": 0,
        "Action": 0,
        "Status": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Plan response for a Blueprint request.

object

Blueprint

Full catalog metadata and wizard schema for one Blueprint.

object

Key

string

nullable

Version

string

nullable

Level

string

nullable

CategoryGroup

string

nullable

Category

string

nullable

Title

string

nullable

Description

string

nullable

Nodes

Array<object>

nullable

One graph node in a Blueprint wizard.

object

string

nullable

BlueprintKey

string

nullable

Title

string

nullable

ParentNodeId

string

nullable

Sections

Array<object>

nullable

One wizard section rendered from metadata.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Parameters

Array<object>

nullable

One metadata-driven wizard parameter.

object

Key

string

nullable

Label

string

nullable

Type

integer format: int32

Allowed values: 0 1 2 3 4 5 6

Required

boolean

DefaultValue

nullable

Options

Array<object>

nullable

One selectable option for metadata-driven Blueprint parameters.

object

Value

string

nullable

Label

string

nullable

Description

string

nullable

Minimum

number format: double

nullable

Maximum

number format: double

nullable

VisibleWhenAll

Array<object>

nullable

Declarative scalar equality condition for Blueprint wizard parameters.

object

ParameterKey

string

nullable

ExpectedValue

EnabledWhenAll

Array<object>

nullable

Declarative scalar equality condition for Blueprint wizard parameters.

object

ParameterKey

string

nullable

ExpectedValue

IncludeEveryoneRole

boolean

PostApplyActions

Array<object>

nullable

Manual action recommended after a Blueprint application is completed.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Required

boolean

RuntimeMenuNavigation

Blueprint runtime-menu navigation capability shown by the generic wizard.

object

Title

string

nullable

Description

string

nullable

EnabledByDefault

boolean

DefaultMenuName

string

nullable

DependencySlots

Array<object>

nullable

One dependency that a Blueprint must resolve before planning.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Kind

integer format: int32

Allowed values: 0

Required

boolean

AllowedModes

Array<integer>

nullable

Allowed values: 0

FieldMappings

Array<object>

nullable

One required semantic field mapping for an Entity Definition dependency.

object

Key

Stable semantic mapping key.

string

nullable

Label

Localized mapping label.

string

nullable

Description

Localized mapping guidance.

string

nullable

AllowedFieldTypes

Allowed source field types.

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

Required

Whether the mapping must be provided.

boolean

SuggestedFieldKeys

Preferred source field keys in matching order.

Array<string>

nullable

TargetStringMaxLength

Maximum string length accepted by the generated target field.

integer format: int32

nullable

TargetDecimalPrecision

Decimal precision of the generated target field.

integer format: int32

nullable

TargetDecimalScale

Decimal scale of the generated target field.

integer format: int32

nullable

EffectiveRequestHash

string

nullable

Sections

Array<object>

nullable

Plan section grouping related plan items.

object

Key

string

nullable

Title

string

nullable

ItemIds

Array<string>

nullable

Items

Array<object>

nullable

One planned artifact action.

object

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

Label

string

nullable

Action

integer format: int32

Allowed values: 0 1 2

Status

integer format: int32

Allowed values: 0 1 2

Required

boolean

Selectable

boolean

SelectedByDefault

boolean

ArtifactKey

string

nullable

ArtifactId

string

nullable

Message

string

nullable

DependsOnItemIds

Array<string>

nullable

OpenTargets

Array<object>

nullable

Post-apply navigation target.

object

Key

string

nullable

Label

string

nullable

Kind

string

nullable

EntityDefinitionId

string

nullable

RecordMatchingProfileId

string

nullable

CatalogDefinitionId

string

nullable

CanApply

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": {
    "Blueprint": {
      "Nodes": [
        {
          "Sections": [
            {
              "Parameters": [
                {
                  "Type": 0
                }
              ]
            }
          ]
        }
      ],
      "DependencySlots": [
        {
          "Kind": 0,
          "AllowedModes": [
            0
          ],
          "FieldMappings": [
            {
              "AllowedFieldTypes": [
                0
              ]
            }
          ]
        }
      ]
    },
    "Items": [
      {
        "Kind": 0,
        "Action": 0,
        "Status": 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

Plan response for a Blueprint request.

object

Blueprint

Full catalog metadata and wizard schema for one Blueprint.

object

Key

string

nullable

Version

string

nullable

Level

string

nullable

CategoryGroup

string

nullable

Category

string

nullable

Title

string

nullable

Description

string

nullable

Nodes

Array<object>

nullable

One graph node in a Blueprint wizard.

object

string

nullable

BlueprintKey

string

nullable

Title

string

nullable

ParentNodeId

string

nullable

Sections

Array<object>

nullable

One wizard section rendered from metadata.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Parameters

Array<object>

nullable

One metadata-driven wizard parameter.

object

Key

string

nullable

Label

string

nullable

Type

integer format: int32

Allowed values: 0 1 2 3 4 5 6

Required

boolean

DefaultValue

nullable

Options

Array<object>

nullable

One selectable option for metadata-driven Blueprint parameters.

object

Value

string

nullable

Label

string

nullable

Description

string

nullable

Minimum

number format: double

nullable

Maximum

number format: double

nullable

VisibleWhenAll

Array<object>

nullable

Declarative scalar equality condition for Blueprint wizard parameters.

object

ParameterKey

string

nullable

ExpectedValue

EnabledWhenAll

Array<object>

nullable

Declarative scalar equality condition for Blueprint wizard parameters.

object

ParameterKey

string

nullable

ExpectedValue

IncludeEveryoneRole

boolean

PostApplyActions

Array<object>

nullable

Manual action recommended after a Blueprint application is completed.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Required

boolean

RuntimeMenuNavigation

Blueprint runtime-menu navigation capability shown by the generic wizard.

object

Title

string

nullable

Description

string

nullable

EnabledByDefault

boolean

DefaultMenuName

string

nullable

DependencySlots

Array<object>

nullable

One dependency that a Blueprint must resolve before planning.

object

Key

string

nullable

Title

string

nullable

Description

string

nullable

Kind

integer format: int32

Allowed values: 0

Required

boolean

AllowedModes

Array<integer>

nullable

Allowed values: 0

FieldMappings

Array<object>

nullable

One required semantic field mapping for an Entity Definition dependency.

object

Key

Stable semantic mapping key.

string

nullable

Label

Localized mapping label.

string

nullable

Description

Localized mapping guidance.

string

nullable

AllowedFieldTypes

Allowed source field types.

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

Required

Whether the mapping must be provided.

boolean

SuggestedFieldKeys

Preferred source field keys in matching order.

Array<string>

nullable

TargetStringMaxLength

Maximum string length accepted by the generated target field.

integer format: int32

nullable

TargetDecimalPrecision

Decimal precision of the generated target field.

integer format: int32

nullable

TargetDecimalScale

Decimal scale of the generated target field.

integer format: int32

nullable

EffectiveRequestHash

string

nullable

Sections

Array<object>

nullable

Plan section grouping related plan items.

object

Key

string

nullable

Title

string

nullable

ItemIds

Array<string>

nullable

Items

Array<object>

nullable

One planned artifact action.

object

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

Label

string

nullable

Action

integer format: int32

Allowed values: 0 1 2

Status

integer format: int32

Allowed values: 0 1 2

Required

boolean

Selectable

boolean

SelectedByDefault

boolean

ArtifactKey

string

nullable

ArtifactId

string

nullable

Message

string

nullable

DependsOnItemIds

Array<string>

nullable

OpenTargets

Array<object>

nullable

Post-apply navigation target.

object

Key

string

nullable

Label

string

nullable

Kind

string

nullable

EntityDefinitionId

string

nullable

RecordMatchingProfileId

string

nullable

CatalogDefinitionId

string

nullable

CanApply

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": {
    "Blueprint": {
      "Nodes": [
        {
          "Sections": [
            {
              "Parameters": [
                {
                  "Type": 0
                }
              ]
            }
          ]
        }
      ],
      "DependencySlots": [
        {
          "Kind": 0,
          "AllowedModes": [
            0
          ],
          "FieldMappings": [
            {
              "AllowedFieldTypes": [
                0
              ]
            }
          ]
        }
      ]
    },
    "Items": [
      {
        "Kind": 0,
        "Action": 0,
        "Status": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Plan a Blueprint application without mutating workspace configuration.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated