Skip to content

Reactivate a warranty entitlement model without changing its shape.

POST
/api/workspace/admin/entitlement-operations/models/warranty/{modelId}/reactivate
curl --request POST \
--url https://example.com/api/workspace/admin/entitlement-operations/models/warranty/example/reactivate \
--header 'Content-Type: application/json' \
--data '{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
  • None
modelId
required
string
access_token
string

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

Request used to reactivate a model without changing its shape.

object
Reason

Optional administrator reason.

string
nullable
RowVersion
required

Required concurrency token from the current model.

string format: uuid
Examplegenerated
{
"Reason": "example",
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
Data

Warranty entitlement model detail returned by typed administration APIs.

object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
PartyType
integer format: int32
Allowed values: 0 1 2
AccessMode
integer format: int32
Allowed values: 0 1 2
ResourceScopeMode
integer format: int32
Allowed values: 0 1
OwnerParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
DelegateParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
Resource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
RelatedResource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
PartyDelegationPath

Delegation path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
OwnerPartyRoleId
string
nullable
DelegatePartyRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
ResourceHierarchyPath

Resource hierarchy path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
ParentResourceRoleId
string
nullable
ChildResourceRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
Plans
Array<object>
nullable

Warranty plan summary row.

object
Id
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
Id
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
RowVersion
string format: uuid
AllowedActions

Server-computed actions allowed for one entitlement model.

object
CanEditIdentity
boolean
CanEditParty
boolean
CanEditResource
boolean
CanCreatePlan
boolean
CanDelete
boolean
CanDeactivate
boolean
CanReactivate
boolean
IsActive
boolean
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": {
"PartyType": 0,
"AccessMode": 0,
"ResourceScopeMode": 0,
"OwnerParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"DelegateParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"Resource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"RelatedResource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"PartyDelegationPath": {
"Steps": [
{
"Direction": 0
}
]
},
"ResourceHierarchyPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Plans": [
{
"DurationUnit": 0,
"GracePeriodUnit": 0,
"TimeBoundWindowUnit": 0,
"TimeBoundWindowAnchor": 0,
"IssuedTermsRequirement": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Warranty entitlement model detail returned by typed administration APIs.

object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
PartyType
integer format: int32
Allowed values: 0 1 2
AccessMode
integer format: int32
Allowed values: 0 1 2
ResourceScopeMode
integer format: int32
Allowed values: 0 1
OwnerParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
DelegateParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
Resource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
RelatedResource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
PartyDelegationPath

Delegation path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
OwnerPartyRoleId
string
nullable
DelegatePartyRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
ResourceHierarchyPath

Resource hierarchy path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
ParentResourceRoleId
string
nullable
ChildResourceRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
Plans
Array<object>
nullable

Warranty plan summary row.

object
Id
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
Id
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
RowVersion
string format: uuid
AllowedActions

Server-computed actions allowed for one entitlement model.

object
CanEditIdentity
boolean
CanEditParty
boolean
CanEditResource
boolean
CanCreatePlan
boolean
CanDelete
boolean
CanDeactivate
boolean
CanReactivate
boolean
IsActive
boolean
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": {
"PartyType": 0,
"AccessMode": 0,
"ResourceScopeMode": 0,
"OwnerParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"DelegateParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"Resource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"RelatedResource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"PartyDelegationPath": {
"Steps": [
{
"Direction": 0
}
]
},
"ResourceHierarchyPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Plans": [
{
"DurationUnit": 0,
"GracePeriodUnit": 0,
"TimeBoundWindowUnit": 0,
"TimeBoundWindowAnchor": 0,
"IssuedTermsRequirement": 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

Warranty entitlement model detail returned by typed administration APIs.

object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
PartyType
integer format: int32
Allowed values: 0 1 2
AccessMode
integer format: int32
Allowed values: 0 1 2
ResourceScopeMode
integer format: int32
Allowed values: 0 1
OwnerParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
DelegateParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
Resource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
RelatedResource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
PartyDelegationPath

Delegation path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
OwnerPartyRoleId
string
nullable
DelegatePartyRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
ResourceHierarchyPath

Resource hierarchy path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
ParentResourceRoleId
string
nullable
ChildResourceRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
Plans
Array<object>
nullable

Warranty plan summary row.

object
Id
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
Id
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
RowVersion
string format: uuid
AllowedActions

Server-computed actions allowed for one entitlement model.

object
CanEditIdentity
boolean
CanEditParty
boolean
CanEditResource
boolean
CanCreatePlan
boolean
CanDelete
boolean
CanDeactivate
boolean
CanReactivate
boolean
IsActive
boolean
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": {
"PartyType": 0,
"AccessMode": 0,
"ResourceScopeMode": 0,
"OwnerParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"DelegateParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"Resource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"RelatedResource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"PartyDelegationPath": {
"Steps": [
{
"Direction": 0
}
]
},
"ResourceHierarchyPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Plans": [
{
"DurationUnit": 0,
"GracePeriodUnit": 0,
"TimeBoundWindowUnit": 0,
"TimeBoundWindowAnchor": 0,
"IssuedTermsRequirement": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

Warranty entitlement model detail returned by typed administration APIs.

object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
PartyType
integer format: int32
Allowed values: 0 1 2
AccessMode
integer format: int32
Allowed values: 0 1 2
ResourceScopeMode
integer format: int32
Allowed values: 0 1
OwnerParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
DelegateParty

Party role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
Resource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
RelatedResource

Resource role owned by an entitlement model.

object
Id
string
nullable
RoleKind
integer format: int32
Allowed values: 0 1
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
RowVersion
string format: uuid
PartyDelegationPath

Delegation path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
OwnerPartyRoleId
string
nullable
DelegatePartyRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
ResourceHierarchyPath

Resource hierarchy path owned by an entitlement model.

object
Id
string
nullable
PathKey
string
nullable
ParentResourceRoleId
string
nullable
ChildResourceRoleId
string
nullable
DisplayName
string
nullable
LeafEntityDefinitionId
string
nullable
LeafEntityDisplayName
string
nullable
Steps
Array<object>
nullable

One resolved step inside a relationship path option.

object
SortOrder
integer format: int32
FromEntityDefinitionId
string
nullable
FromEntityDisplayName
string
nullable
ToEntityDefinitionId
string
nullable
ToEntityDisplayName
string
nullable
FieldId
string
nullable
FieldDisplayName
string
nullable
Direction
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
Plans
Array<object>
nullable

Warranty plan summary row.

object
Id
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
Id
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
RowVersion
string format: uuid
AllowedActions

Server-computed actions allowed for one entitlement model.

object
CanEditIdentity
boolean
CanEditParty
boolean
CanEditResource
boolean
CanCreatePlan
boolean
CanDelete
boolean
CanDeactivate
boolean
CanReactivate
boolean
IsActive
boolean
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": {
"PartyType": 0,
"AccessMode": 0,
"ResourceScopeMode": 0,
"OwnerParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"DelegateParty": {
"RoleKind": 0,
"InstancePickerInputType": 0,
"InstanceLookupTableSelectorMode": 0
},
"Resource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"RelatedResource": {
"RoleKind": 0,
"ResourcePickerInputType": 0,
"ResourceLookupTableSelectorMode": 0
},
"PartyDelegationPath": {
"Steps": [
{
"Direction": 0
}
]
},
"ResourceHierarchyPath": {
"Steps": [
{
"Direction": 0
}
]
},
"Plans": [
{
"DurationUnit": 0,
"GracePeriodUnit": 0,
"TimeBoundWindowUnit": 0,
"TimeBoundWindowAnchor": 0,
"IssuedTermsRequirement": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}