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

Gets a specific EntityAttribute.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityAttributeId

The id of the EntityAttribute to get.

integer

Required



Body Parameters

None.



Response Information

Resource Description

The requested EntityAttribute, if it exists and no error occurs; an HTTP exception otherwise.

ReadEntityAttributeViewModel

NameDescriptionTypeAdditional information
AgendaItemBackgroundColor

string

None.

AgendaItemText

string

None.

AgendaItemTextColor

string

None.

Choices

Collection of ReadEntityAttributeChoiceViewModel

None.

CurrencyId

integer

None.

CurrencySymbol

string

None.

DefaultValue

string

None.

EntityCategoryId

integer

None.

Id

integer

None.

IsAgendaItem

boolean

None.

IsBirthday

boolean

None.

IsCurrency

boolean

None.

IsDeletable

boolean

None.

IsEditable

boolean

None.

IsMultiSelect

boolean

None.

IsPercentage

boolean

None.

IsRecurrable

boolean

None.

IsRequired

boolean

None.

IsUnique

boolean

None.

Name

string

None.

Order

integer

None.

RelatedEntityDefinitionId

integer

None.

TypeId

integer

None.

Validations

Collection of ReadEntityAttributeValidationViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "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:
<ReadEntityAttributeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <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" />
</ReadEntityAttributeViewModel>