Create a warranty plan.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/entitlement-operations/models/warranty/example/plans"), Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"PriceAmount\": 1, \"PriceCurrencyCode\": \"example\", \"IsActive\": true, \"DurationValue\": 1, \"DurationUnit\": 0, \"GracePeriodValue\": 1, \"GracePeriodUnit\": 0, \"ConsumableQuantity\": 1, \"TimeBoundQuantity\": 1, \"TimeBoundWindowValue\": 1, \"TimeBoundWindowUnit\": 0, \"TimeBoundWindowAnchor\": 0, \"IssuedTermsRequirement\": 0, \"MaxCoveredPartyCount\": 1, \"RenewalPolicyId\": \"example\", \"Resources\": [ { \"EntityDefinitionId\": \"example\", \"ResourceEntityInstanceId\": \"example\", \"SortOrder\": 1 } ], \"PlanFamilyIds\": [ \"example\" ] }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};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';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Key":"example","DisplayName":"example","Description":"example","PriceAmount":1,"PriceCurrencyCode":"example","IsActive":true,"DurationValue":1,"DurationUnit":0,"GracePeriodValue":1,"GracePeriodUnit":0,"ConsumableQuantity":1,"TimeBoundQuantity":1,"TimeBoundWindowValue":1,"TimeBoundWindowUnit":0,"TimeBoundWindowAnchor":0,"IssuedTermsRequirement":0,"MaxCoveredPartyCount":1,"RenewalPolicyId":"example","Resources":[{"EntityDefinitionId":"example","ResourceEntityInstanceId":"example","SortOrder":1}],"PlanFamilyIds":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/entitlement-operations/models/warranty/example/plans \ --header 'Content-Type: application/json' \ --data '{ "Key": "example", "DisplayName": "example", "Description": "example", "PriceAmount": 1, "PriceCurrencyCode": "example", "IsActive": true, "DurationValue": 1, "DurationUnit": 0, "GracePeriodValue": 1, "GracePeriodUnit": 0, "ConsumableQuantity": 1, "TimeBoundQuantity": 1, "TimeBoundWindowValue": 1, "TimeBoundWindowUnit": 0, "TimeBoundWindowAnchor": 0, "IssuedTermsRequirement": 0, "MaxCoveredPartyCount": 1, "RenewalPolicyId": "example", "Resources": [ { "EntityDefinitionId": "example", "ResourceEntityInstanceId": "example", "SortOrder": 1 } ], "PlanFamilyIds": [ "example" ] }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Create a warranty plan with validity, claim quantity, and issued terms settings.
object
Optional stable plan key. The server generates one when omitted.
Plan display name.
Optional plan description.
Optional commercial display price. It is metadata only.
Optional three-letter currency code for the commercial display price.
Whether this plan can be used for new grants.
Optional warranty duration length.
Optional grace period length.
Optional total claim or use quantity.
Optional periodic claim or use quantity.
Optional periodic quota window length.
Optional explicit covered-party limit for delegated explicit Organization/Family models.
Unsupported for Warranty v1. Must be null.
Unsupported for Warranty v1. Must be empty because resources are selected when the entitlement is granted.
Resource selected for a plan.
object
Entity definition of the selected resource instance.
Selected runtime EntityInstance id.
Display order.
Optional plan family ids assigned to this plan.
Create a warranty plan with validity, claim quantity, and issued terms settings.
object
Optional stable plan key. The server generates one when omitted.
Plan display name.
Optional plan description.
Optional commercial display price. It is metadata only.
Optional three-letter currency code for the commercial display price.
Whether this plan can be used for new grants.
Optional warranty duration length.
Optional grace period length.
Optional total claim or use quantity.
Optional periodic claim or use quantity.
Optional periodic quota window length.
Optional explicit covered-party limit for delegated explicit Organization/Family models.
Unsupported for Warranty v1. Must be null.
Unsupported for Warranty v1. Must be empty because resources are selected when the entitlement is granted.
Resource selected for a plan.
object
Entity definition of the selected resource instance.
Selected runtime EntityInstance id.
Display order.
Optional plan family ids assigned to this plan.
Create a warranty plan with validity, claim quantity, and issued terms settings.
object
Optional stable plan key. The server generates one when omitted.
Plan display name.
Optional plan description.
Optional commercial display price. It is metadata only.
Optional three-letter currency code for the commercial display price.
Whether this plan can be used for new grants.
Optional warranty duration length.
Optional grace period length.
Optional total claim or use quantity.
Optional periodic claim or use quantity.
Optional periodic quota window length.
Optional explicit covered-party limit for delegated explicit Organization/Family models.
Unsupported for Warranty v1. Must be null.
Unsupported for Warranty v1. Must be empty because resources are selected when the entitlement is granted.
Resource selected for a plan.
object
Entity definition of the selected resource instance.
Selected runtime EntityInstance id.
Display order.
Optional plan family ids assigned to this plan.
Responses
Section titled “Responses”OK
object
Detailed warranty plan.
object
Plan family reference attached to a plan or exposed for plan authoring.
object
Resource attached to a plan.
object
One breadcrumb item for a selected plan resource.
object
object
object
object
object
Example
{ "Data": { "DurationUnit": 0, "GracePeriodUnit": 0, "TimeBoundWindowUnit": 0, "TimeBoundWindowAnchor": 0, "IssuedTermsRequirement": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Detailed warranty plan.
object
Plan family reference attached to a plan or exposed for plan authoring.
object
Resource attached to a plan.
object
One breadcrumb item for a selected plan resource.
object
object
object
object
object
Example
{ "Data": { "DurationUnit": 0, "GracePeriodUnit": 0, "TimeBoundWindowUnit": 0, "TimeBoundWindowAnchor": 0, "IssuedTermsRequirement": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Detailed warranty plan.
object
Plan family reference attached to a plan or exposed for plan authoring.
object
Resource attached to a plan.
object
One breadcrumb item for a selected plan resource.
object
object
object
object
object
Example
{ "Data": { "DurationUnit": 0, "GracePeriodUnit": 0, "TimeBoundWindowUnit": 0, "TimeBoundWindowAnchor": 0, "IssuedTermsRequirement": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Detailed warranty plan.
object
Plan family reference attached to a plan or exposed for plan authoring.
object
Resource attached to a plan.
object
One breadcrumb item for a selected plan resource.
object
object
object
object
object
Example
{ "Data": { "DurationUnit": 0, "GracePeriodUnit": 0, "TimeBoundWindowUnit": 0, "TimeBoundWindowAnchor": 0, "IssuedTermsRequirement": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}