Persist explicit software license plan ordering.

PUT

/api/workspace/entitlement-operations/models/software-license/{modelId}/plans/order

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/entitlement-operations/models/software-license/example/plans/order"),
    Content = new StringContent("{ \"PlanIds\": [ \"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/software-license/example/plans/order';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"PlanIds":["example"]}'
};

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

curl --request PUT \
  --url https://example.com/api/workspace/entitlement-operations/models/software-license/example/plans/order \
  --header 'Content-Type: application/json' \
  --data '{ "PlanIds": [ "example" ] }'

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.

Request Body

Explicit plan ordering inside one entitlement model.

object

PlanIds

required

Plan ids in target display order.

Array<string>

Example^generated

{
  "PlanIds": [
    "example"
  ]
}

Explicit plan ordering inside one entitlement model.

object

PlanIds

required

Plan ids in target display order.

Array<string>

Example^generated

{
  "PlanIds": [
    "example"
  ]
}

Explicit plan ordering inside one entitlement model.

object

PlanIds

required

Plan ids in target display order.

Array<string>

Example^generated

{
  "PlanIds": [
    "example"
  ]
}

Responses

200

application/json

object

Data

Paginated software license plan list response.

object

Items

Array<object>

nullable

Software license plan summary row.

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

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

TotalCount

integer format: int32

Page

integer format: int32

PageSize

integer format: int32

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": {
    "Items": [
      {
        "DurationUnit": 0,
        "GracePeriodUnit": 0,
        "RenewalPolicy": {
          "Mode": 0
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Paginated software license plan list response.

object

Items

Array<object>

nullable

Software license plan summary row.

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

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

TotalCount

integer format: int32

Page

integer format: int32

PageSize

integer format: int32

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": {
    "Items": [
      {
        "DurationUnit": 0,
        "GracePeriodUnit": 0,
        "RenewalPolicy": {
          "Mode": 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

Paginated software license plan list response.

object

Items

Array<object>

nullable

Software license plan summary row.

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

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

TotalCount

integer format: int32

Page

integer format: int32

PageSize

integer format: int32

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": {
    "Items": [
      {
        "DurationUnit": 0,
        "GracePeriodUnit": 0,
        "RenewalPolicy": {
          "Mode": 0
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Paginated software license plan list response.

object

Items

Array<object>

nullable

Software license plan summary row.

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

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

TotalCount

integer format: int32

Page

integer format: int32

PageSize

integer format: int32

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": {
    "Items": [
      {
        "DurationUnit": 0,
        "GracePeriodUnit": 0,
        "RenewalPolicy": {
          "Mode": 0
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Persist explicit software license plan ordering.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated

Example^generated

Example^generated

Example^generated