Return one installed Blueprint application with artifacts, targets, and demo-data tracking.

GET

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/admin/blueprints/applications/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
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/applications/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://example.com/api/workspace/admin/blueprints/applications/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

application/json

object

Data

Detailed installed Blueprint application model.

object

Summary

Summary row for an installed Blueprint application.

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

ActorUserId

string

nullable

AppliedAt

string format: date-time

StartedAt

string format: date-time

nullable

CompletedAt

string format: date-time

nullable

PrimaryArtifactKind

string

nullable

PrimaryArtifactId

string

nullable

ArtifactCount

integer format: int32

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

DemoDataSeedSets

Array<object>

nullable

Summary of a tracked demo-data seed set created by a Blueprint application.

object

SeedSetId

string

nullable

SeedKey

string

nullable

EntityDefinitionId

string

nullable

RequestedCount

integer format: int32

CreatedCount

integer format: int32

PendingCount

integer format: int32

CleanedCount

integer format: int32

SkippedCount

integer format: int32

FailedCount

integer format: int32

CanCleanup

boolean

Artifacts

Array<object>

nullable

Artifact persisted in a Blueprint application record.

object

Kind

string

nullable

string

nullable

Key

string

nullable

Name

string

nullable

Action

integer format: int32

Allowed values: 0 1 2

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

Tracked demo record in a Blueprint seed set.

object

DemoDataRecordId

string

nullable

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

nullable

SeedRowVersion

string format: uuid

nullable

CleanupStatus

integer format: int32

Allowed values: 0 1 2 3

CleanupMessage

string

nullable

CleanedAt

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

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

Detailed installed Blueprint application model.

object

Summary

Summary row for an installed Blueprint application.

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

ActorUserId

string

nullable

AppliedAt

string format: date-time

StartedAt

string format: date-time

nullable

CompletedAt

string format: date-time

nullable

PrimaryArtifactKind

string

nullable

PrimaryArtifactId

string

nullable

ArtifactCount

integer format: int32

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

DemoDataSeedSets

Array<object>

nullable

Summary of a tracked demo-data seed set created by a Blueprint application.

object

SeedSetId

string

nullable

SeedKey

string

nullable

EntityDefinitionId

string

nullable

RequestedCount

integer format: int32

CreatedCount

integer format: int32

PendingCount

integer format: int32

CleanedCount

integer format: int32

SkippedCount

integer format: int32

FailedCount

integer format: int32

CanCleanup

boolean

Artifacts

Array<object>

nullable

Artifact persisted in a Blueprint application record.

object

Kind

string

nullable

string

nullable

Key

string

nullable

Name

string

nullable

Action

integer format: int32

Allowed values: 0 1 2

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

Tracked demo record in a Blueprint seed set.

object

DemoDataRecordId

string

nullable

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

nullable

SeedRowVersion

string format: uuid

nullable

CleanupStatus

integer format: int32

Allowed values: 0 1 2 3

CleanupMessage

string

nullable

CleanedAt

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

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

Return one installed Blueprint application with artifacts, targets, and demo-data tracking.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

403

Examplegenerated

404

Example

Example^generated