Return warranty plan editor bootstrap metadata.

GET

/api/workspace/entitlement-operations/models/warranty/{modelId}/plans/bootstrap

curl --request GET \
  --url https://example.com/api/workspace/entitlement-operations/models/warranty/example/plans/bootstrap

Authorizations

• None

Parameters

Path Parameters

modelId

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

Bootstrap data for plan administration under one entitlement model.

object

EntitlementModel

Entitlement model available for plan authoring.

object

Id

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

ModelType

integer format: int32

Allowed values: 0 1 2 3

RootResourceEntityDefinitionId

string

nullable

RootResourceDisplayName

string

nullable

RelatedResourceEntityDefinitionId

string

nullable

RelatedResourceDisplayName

string

nullable

PlanFamilies

Array<object>

nullable

Plan family reference attached to a plan or exposed for plan authoring.

object

Id

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

LimitFamilies

Array<object>

nullable

Limit family option exposed by the server.

object

Value

integer format: int32

Allowed values: 0 1 2 3

Key

string

nullable

TimeUnits

Array<object>

nullable

Time unit option exposed by the server.

object

Value

integer format: int32

Allowed values: 0 1 2

Key

string

nullable

WindowAnchors

Array<object>

nullable

Time-bound quantity window anchor option exposed by the server.

object

Value

integer format: int32

Allowed values: 0 1

Key

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": {
    "EntitlementModel": {
      "ModelType": 0
    },
    "LimitFamilies": [
      {
        "Value": 0
      }
    ],
    "TimeUnits": [
      {
        "Value": 0
      }
    ],
    "WindowAnchors": [
      {
        "Value": 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

Bootstrap data for plan administration under one entitlement model.

object

EntitlementModel

Entitlement model available for plan authoring.

object

Id

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

ModelType

integer format: int32

Allowed values: 0 1 2 3

RootResourceEntityDefinitionId

string

nullable

RootResourceDisplayName

string

nullable

RelatedResourceEntityDefinitionId

string

nullable

RelatedResourceDisplayName

string

nullable

PlanFamilies

Array<object>

nullable

Plan family reference attached to a plan or exposed for plan authoring.

object

Id

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

LimitFamilies

Array<object>

nullable

Limit family option exposed by the server.

object

Value

integer format: int32

Allowed values: 0 1 2 3

Key

string

nullable

TimeUnits

Array<object>

nullable

Time unit option exposed by the server.

object

Value

integer format: int32

Allowed values: 0 1 2

Key

string

nullable

WindowAnchors

Array<object>

nullable

Time-bound quantity window anchor option exposed by the server.

object

Value

integer format: int32

Allowed values: 0 1

Key

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": {
    "EntitlementModel": {
      "ModelType": 0
    },
    "LimitFamilies": [
      {
        "Value": 0
      }
    ],
    "TimeUnits": [
      {
        "Value": 0
      }
    ],
    "WindowAnchors": [
      {
        "Value": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}