Return Blueprint application operation progress and final result when completed.

GET

/api/workspace/admin/blueprints/operations/{applicationId}

curl --request GET \
  --url https://example.com/api/workspace/admin/blueprints/operations/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

applicationId

required

string

Query Parameters

access_token

string

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

Responses

200

OK

Media typeapplication/json

object

Data

Status of a queued, running, or completed Blueprint application operation.

object

ApplicationId

string

nullable

BlueprintKey

string

nullable

BlueprintVersion

string

nullable

Status

integer format: int32

Allowed values: 0 1 2 3

ProgressPercent

integer format: int32

StageMessage

string

nullable

WorkerId

string

nullable

HeartbeatAt

string format: date-time

nullable

AttemptCount

integer format: int32

StartedAt

string format: date-time

nullable

CompletedAt

string format: date-time

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

Result

Result returned after Blueprint apply or idempotent replay.

object

ApplicationId

string

nullable

BlueprintKey

string

nullable

BlueprintVersion

string

nullable

IdempotentReplay

boolean

PrimaryArtifactKind

string

nullable

PrimaryArtifactId

string

nullable

Artifacts

Array<object>

nullable

Artifact persisted in a Blueprint application record.

object

Kind

string

nullable

Id

string

nullable

Key

string

nullable

Name

string

nullable

Action

integer format: int32

Allowed values: 0 1 2

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

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

DemoDataRecords

Array<object>

nullable

Runtime demo record created by a Blueprint application.

object

SeedSetId

string

nullable

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

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

403

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

Example^generated

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

404

Not Found

Media typeapplication/json

object

Data

Status of a queued, running, or completed Blueprint application operation.

object

ApplicationId

string

nullable

BlueprintKey

string

nullable

BlueprintVersion

string

nullable

Status

integer format: int32

Allowed values: 0 1 2 3

ProgressPercent

integer format: int32

StageMessage

string

nullable

WorkerId

string

nullable

HeartbeatAt

string format: date-time

nullable

AttemptCount

integer format: int32

StartedAt

string format: date-time

nullable

CompletedAt

string format: date-time

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

Result

Result returned after Blueprint apply or idempotent replay.

object

ApplicationId

string

nullable

BlueprintKey

string

nullable

BlueprintVersion

string

nullable

IdempotentReplay

boolean

PrimaryArtifactKind

string

nullable

PrimaryArtifactId

string

nullable

Artifacts

Array<object>

nullable

Artifact persisted in a Blueprint application record.

object

Kind

string

nullable

Id

string

nullable

Key

string

nullable

Name

string

nullable

Action

integer format: int32

Allowed values: 0 1 2

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

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

DemoDataRecords

Array<object>

nullable

Runtime demo record created by a Blueprint application.

object

SeedSetId

string

nullable

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

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