PUT api/organizations/current/users/current/entitycategories/{entityCategoryId}

Updates a specific EntityCategory.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityCategoryId

The id of the EntityCategory to update.

integer

Required



Body Parameters

A model representing properties to update the EntityCategory with.

UpdateEntityCategoryViewModel
NameDescriptionTypeAdditional information
EntityCategoryContextId

integer

None.

Id

integer

None.

IsList

boolean

None.

IsReadOnly

boolean

None.

Name

string

None.

Order

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "EntityCategoryContextId": 1,
  "Id": 1,
  "IsList": true,
  "IsReadOnly": true,
  "Name": "sample string 4",
  "Order": 5
}

application/xml, text/xml

Sample:
<UpdateEntityCategoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <EntityCategoryContextId>1</EntityCategoryContextId>
  <Id>1</Id>
  <IsList>true</IsList>
  <IsReadOnly>true</IsReadOnly>
  <Name>sample string 4</Name>
  <Order>5</Order>
</UpdateEntityCategoryViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information

Resource Description

A ReadEntityCategoryViewModel representing the updated EntityCategory.

UpdatedEntityCategoryViewModel

NameDescriptionTypeAdditional information
AdditionalDeletedEntities

ReadAdditionalDeletedEntitiesViewModel

None.

EntityCategory

ReadEntityCategoryViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "AdditionalDeletedEntities": {
    "DeletedEntityAttributeIds": [
      1,
      2
    ],
    "DeletedEntityCategoryIds": [
      1,
      2
    ],
    "DeletedEntityDefinitionIds": [
      1,
      2
    ]
  },
  "EntityCategory": null
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.