Skip to content

Return one Blueprint definition with graph-based wizard metadata.

GET
/api/workspace/admin/blueprints/{blueprintKey}
curl --request GET \
--url https://example.com/api/workspace/admin/blueprints/example \
--header 'Authorization: Bearer <token>'
blueprintKey
required
string
access_token
string

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

OK

Media typeapplication/json
object
Data

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

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"
}

Not Found

Media typeapplication/json
object
Data

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