Return one warranty plan.

GET

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/entitlement-operations/models/warranty/example/plans/example"),
};
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/entitlement-operations/models/warranty/example/plans/example';
const options = {method: 'GET'};

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/entitlement-operations/models/warranty/example/plans/example

Authorizations

None

Parameters

Path Parameters

modelId

required

string

planId

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 warranty plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

PriceAmount

number format: double

nullable

PriceCurrencyCode

string

nullable

MaxCoveredPartyCount

integer format: int32

nullable

SortOrder

integer format: int32

IsActive

boolean

ResourceCount

integer format: int32

Families

Array<object>

nullable

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

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

DurationValue

integer format: int32

nullable

DurationUnit

integer format: int32

Allowed values: 0 1 2

GracePeriodValue

integer format: int32

nullable

GracePeriodUnit

integer format: int32

Allowed values: 0 1 2

ConsumableQuantity

number format: double

nullable

TimeBoundQuantity

number format: double

nullable

TimeBoundWindowValue

integer format: int32

nullable

TimeBoundWindowUnit

integer format: int32

Allowed values: 0 1 2

TimeBoundWindowAnchor

integer format: int32

Allowed values: 0 1

IssuedTermsRequirement

integer format: int32

Allowed values: 0 1 2

Resources

Array<object>

nullable

Resource attached to a plan.

object

string

nullable

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

Breadcrumbs

Array<object>

nullable

One breadcrumb item for a selected plan resource.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

SortOrder

integer format: int32

RowVersion

string format: uuid

RowVersion

string format: uuid

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": {
    "DurationUnit": 0,
    "GracePeriodUnit": 0,
    "TimeBoundWindowUnit": 0,
    "TimeBoundWindowAnchor": 0,
    "IssuedTermsRequirement": 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 warranty plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

PriceAmount

number format: double

nullable

PriceCurrencyCode

string

nullable

MaxCoveredPartyCount

integer format: int32

nullable

SortOrder

integer format: int32

IsActive

boolean

ResourceCount

integer format: int32

Families

Array<object>

nullable

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

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

DurationValue

integer format: int32

nullable

DurationUnit

integer format: int32

Allowed values: 0 1 2

GracePeriodValue

integer format: int32

nullable

GracePeriodUnit

integer format: int32

Allowed values: 0 1 2

ConsumableQuantity

number format: double

nullable

TimeBoundQuantity

number format: double

nullable

TimeBoundWindowValue

integer format: int32

nullable

TimeBoundWindowUnit

integer format: int32

Allowed values: 0 1 2

TimeBoundWindowAnchor

integer format: int32

Allowed values: 0 1

IssuedTermsRequirement

integer format: int32

Allowed values: 0 1 2

Resources

Array<object>

nullable

Resource attached to a plan.

object

string

nullable

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

Breadcrumbs

Array<object>

nullable

One breadcrumb item for a selected plan resource.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

SortOrder

integer format: int32

RowVersion

string format: uuid

RowVersion

string format: uuid

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": {
    "DurationUnit": 0,
    "GracePeriodUnit": 0,
    "TimeBoundWindowUnit": 0,
    "TimeBoundWindowAnchor": 0,
    "IssuedTermsRequirement": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Return one warranty plan.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

403

Examplegenerated

404

Example

Example^generated