Update one plan family.

PUT

/api/workspace/entitlement-operations/models/{modelType}/{modelId}/plan-families/{planFamilyId}

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/example/example/plan-families/example"),
    Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"SortOrder\": 1, \"IsActive\": true, \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }")
    {
        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/example/example/plan-families/example';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"Key":"example","DisplayName":"example","Description":"example","SortOrder":1,"IsActive":true,"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

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/example/example/plan-families/example \
  --header 'Content-Type: application/json' \
  --data '{ "Key": "example", "DisplayName": "example", "Description": "example", "SortOrder": 1, "IsActive": true, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

None

Parameters

Path Parameters

modelType

required

string

modelId

required

string

planFamilyId

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

Update a plan family.

object

Key

Optional stable family key. The server generates one when omitted.

string

nullable

DisplayName

required

Family display name.

string

Description

Optional family description.

string

nullable

SortOrder

Display order.

integer format: int32

IsActive

Whether this family can be assigned to plans.

boolean

RowVersion

required

Required concurrency token from the current family.

string format: uuid

Example^generated

{
  "Key": "example",
  "DisplayName": "example",
  "Description": "example",
  "SortOrder": 1,
  "IsActive": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Update a plan family.

object

Key

Optional stable family key. The server generates one when omitted.

string

nullable

DisplayName

required

Family display name.

string

Description

Optional family description.

string

nullable

SortOrder

Display order.

integer format: int32

IsActive

Whether this family can be assigned to plans.

boolean

RowVersion

required

Required concurrency token from the current family.

string format: uuid

Example^generated

{
  "Key": "example",
  "DisplayName": "example",
  "Description": "example",
  "SortOrder": 1,
  "IsActive": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Update a plan family.

object

Key

Optional stable family key. The server generates one when omitted.

string

nullable

DisplayName

required

Family display name.

string

Description

Optional family description.

string

nullable

SortOrder

Display order.

integer format: int32

IsActive

Whether this family can be assigned to plans.

boolean

RowVersion

required

Required concurrency token from the current family.

string format: uuid

Example^generated

{
  "Key": "example",
  "DisplayName": "example",
  "Description": "example",
  "SortOrder": 1,
  "IsActive": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

Plan family detail.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

PlanCount

integer format: int32

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Plan family detail.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

PlanCount

integer format: int32

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

{
  "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

Plan family detail.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

PlanCount

integer format: int32

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Plan family detail.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

PlanCount

integer format: int32

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Update one plan family.

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