PUT api/organizations/current/users/current/entityattributes/{entityAttributeId}

Updates a specific EntityAttribute.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityAttributeId

The id of the EntityAttribute to update.

integer

Required



Body Parameters

A model depicting the state to update the EntityAttribute to.

UpdateEntityAttributeViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Required

boolean

None.

TypeId

integer

None.

Unique

boolean

None.

ValidationId

integer

None.

ChoiceSettingsConfiguration

ChoiceSettingsConfigurationViewModel

None.

DateSettingsConfiguration

DateSettingsConfigurationViewModel

None.

NumberSettingsConfiguration

NumberSettingsConfigurationViewModel

None.

RelationSettingsConfiguration

RelationSettingsConfigurationViewModel

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Required": true,
  "TypeId": 4,
  "Unique": true,
  "ValidationId": 1,
  "ChoiceSettingsConfiguration": {
    "Choices": [
      {
        "Order": 1,
        "Value": "sample string 2"
      },
      {
        "Order": 1,
        "Value": "sample string 2"
      }
    ],
    "DefaultValue": "sample string 1",
    "MultiSelect": true
  },
  "DateSettingsConfiguration": {
    "AgendaItemBackgroundColor": "sample string 1",
    "AgendaItemText": "sample string 2",
    "AgendaItemTextColor": "sample string 3",
    "IsAgendaItem": true,
    "IsBirthday": true,
    "IsRecurrable": true
  },
  "NumberSettingsConfiguration": {
    "CurrencyId": 1,
    "IsCurrency": true,
    "IsPercentage": true
  },
  "RelationSettingsConfiguration": {
    "RelatedEntityAttributeName": "sample string 1",
    "RelatedEntityCategoryListName": "sample string 2",
    "RelatedEntityDefinitionId": 3
  }
}

application/xml, text/xml

Sample:
<UpdateEntityAttributeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <ChoiceSettingsConfiguration>
    <Choices>
      <EntityAttributeChoiceViewModel>
        <Order>1</Order>
        <Value>sample string 2</Value>
      </EntityAttributeChoiceViewModel>
      <EntityAttributeChoiceViewModel>
        <Order>1</Order>
        <Value>sample string 2</Value>
      </EntityAttributeChoiceViewModel>
    </Choices>
    <DefaultValue>sample string 1</DefaultValue>
    <MultiSelect>true</MultiSelect>
  </ChoiceSettingsConfiguration>
  <DateSettingsConfiguration>
    <AgendaItemBackgroundColor>sample string 1</AgendaItemBackgroundColor>
    <AgendaItemText>sample string 2</AgendaItemText>
    <AgendaItemTextColor>sample string 3</AgendaItemTextColor>
    <IsAgendaItem>true</IsAgendaItem>
    <IsBirthday>true</IsBirthday>
    <IsRecurrable>true</IsRecurrable>
  </DateSettingsConfiguration>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <NumberSettingsConfiguration>
    <CurrencyId>1</CurrencyId>
    <IsCurrency>true</IsCurrency>
    <IsPercentage>true</IsPercentage>
  </NumberSettingsConfiguration>
  <RelationSettingsConfiguration>
    <RelatedEntityAttributeName>sample string 1</RelatedEntityAttributeName>
    <RelatedEntityCategoryListName>sample string 2</RelatedEntityCategoryListName>
    <RelatedEntityDefinitionId>3</RelatedEntityDefinitionId>
  </RelationSettingsConfiguration>
  <Required>true</Required>
  <TypeId>4</TypeId>
  <Unique>true</Unique>
  <ValidationId>1</ValidationId>
</UpdateEntityAttributeViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information

Resource Description

A ReadEntityAttributeViewModel representing the updated EntityAttribute.

UpdatedEntityAttributeViewModel

NameDescriptionTypeAdditional information
AdditionalManipulatedEntities

ReadAdditionalManipulatedEntitiesViewModel

None.

EntityAttribute

ReadEntityAttributeViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "AdditionalManipulatedEntities": {
    "AdditionalAddedEntities": {
      "AddedEntityAttributesIds": [
        1,
        2
      ],
      "AddedEntityCategoriesIds": [
        1,
        2
      ],
      "AddedEntityDefinitionsIds": [
        1,
        2
      ]
    },
    "AdditionalDeletedEntities": {
      "DeletedEntityAttributeIds": [
        1,
        2
      ],
      "DeletedEntityCategoryIds": [
        1,
        2
      ],
      "DeletedEntityDefinitionIds": [
        1,
        2
      ]
    },
    "AdditionalUpdatedEntities": {
      "UpdatedEntityAttributesIds": [
        1,
        2
      ],
      "UpdatedEntityCategoriesIds": [
        1,
        2
      ],
      "UpdatedEntityDefinitionsIds": [
        1,
        2
      ]
    }
  },
  "EntityAttribute": {
    "AgendaItemBackgroundColor": "sample string 1",
    "AgendaItemText": "sample string 2",
    "AgendaItemTextColor": "sample string 3",
    "Choices": null,
    "CurrencyId": 1,
    "CurrencySymbol": "sample string 4",
    "DefaultValue": "sample string 5",
    "EntityCategoryId": 6,
    "Id": 7,
    "IsAgendaItem": true,
    "IsBirthday": true,
    "IsCurrency": true,
    "IsDeletable": true,
    "IsEditable": true,
    "IsMultiSelect": true,
    "IsPercentage": true,
    "IsRecurrable": true,
    "IsRequired": true,
    "IsUnique": true,
    "Name": "sample string 18",
    "Order": 19,
    "RelatedEntityDefinitionId": 1,
    "TypeId": 20,
    "Validations": null
  }
}

application/xml, text/xml

Sample:
<UpdatedEntityAttributeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <AdditionalManipulatedEntities>
    <AdditionalAddedEntities>
      <AddedEntityAttributesIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </AddedEntityAttributesIds>
      <AddedEntityCategoriesIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </AddedEntityCategoriesIds>
      <AddedEntityDefinitionsIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </AddedEntityDefinitionsIds>
    </AdditionalAddedEntities>
    <AdditionalDeletedEntities>
      <DeletedEntityAttributeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </DeletedEntityAttributeIds>
      <DeletedEntityCategoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </DeletedEntityCategoryIds>
      <DeletedEntityDefinitionIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </DeletedEntityDefinitionIds>
    </AdditionalDeletedEntities>
    <AdditionalUpdatedEntities>
      <UpdatedEntityAttributesIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </UpdatedEntityAttributesIds>
      <UpdatedEntityCategoriesIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </UpdatedEntityCategoriesIds>
      <UpdatedEntityDefinitionsIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </UpdatedEntityDefinitionsIds>
    </AdditionalUpdatedEntities>
  </AdditionalManipulatedEntities>
  <EntityAttribute>
    <AgendaItemBackgroundColor>sample string 1</AgendaItemBackgroundColor>
    <AgendaItemText>sample string 2</AgendaItemText>
    <AgendaItemTextColor>sample string 3</AgendaItemTextColor>
    <Choices i:nil="true" />
    <CurrencyId>1</CurrencyId>
    <CurrencySymbol>sample string 4</CurrencySymbol>
    <DefaultValue>sample string 5</DefaultValue>
    <EntityCategoryId>6</EntityCategoryId>
    <Id>7</Id>
    <IsAgendaItem>true</IsAgendaItem>
    <IsBirthday>true</IsBirthday>
    <IsCurrency>true</IsCurrency>
    <IsDeletable>true</IsDeletable>
    <IsEditable>true</IsEditable>
    <IsMultiSelect>true</IsMultiSelect>
    <IsPercentage>true</IsPercentage>
    <IsRecurrable>true</IsRecurrable>
    <IsRequired>true</IsRequired>
    <IsUnique>true</IsUnique>
    <Name>sample string 18</Name>
    <Order>19</Order>
    <RelatedEntityDefinitionId>1</RelatedEntityDefinitionId>
    <TypeId>20</TypeId>
    <Validations i:nil="true" />
  </EntityAttribute>
</UpdatedEntityAttributeViewModel>