POST api/organizations/current/users/current/entityattributes
Request Information
URI Parameters
None.
Body Parameters
CreateEntityAttributeViewModelName | Description | Type | Additional information |
---|---|---|---|
AutoNumericSettingsConfiguration | AutoNumericSettingsConfigurationViewModel |
None. |
|
CheckboxSettingsConfiguration | CheckboxSettingsConfigurationViewModel |
None. |
|
ChoiceSettingsConfiguration | ChoiceSettingsConfigurationViewModel |
None. |
|
DateSettingsConfiguration | DateSettingsConfigurationViewModel |
None. |
|
EmployeeListSettingsConfiguration | EmployeeListSettingsConfigurationViewModel |
None. |
|
EntityCategoryId | integer |
None. |
|
Explanation | string |
None. |
|
FileSettingsConfiguration | FileSettingsConfigurationViewModel |
None. |
|
Name | string |
None. |
|
NumberSettingsConfiguration | NumberSettingsConfigurationViewModel |
None. |
|
RelationSettingsConfiguration | RelationSettingsConfigurationViewModel |
None. |
|
MirrorSettingsConfiguration | MirrorSettingsConfigurationViewModel |
None. |
|
Required | boolean |
None. |
|
TypeId | integer |
None. |
|
Unique | boolean |
None. |
|
ValidationId | integer |
None. |
|
IsReadOnly | boolean |
None. |
|
StartIndex | integer |
None. |
|
Prefix | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "AutoNumericSettingsConfiguration": { "Prefix": "sample string 1", "StartIndex": 2 }, "CheckboxSettingsConfiguration": { "DefaultValue": true }, "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 }, "EmployeeListSettingsConfiguration": { "DefaultToAuthor": true }, "EntityCategoryId": 1, "Explanation": "sample string 2", "FileSettingsConfiguration": { "MaxFileSizeMb": 1.0, "AllowedExtensions": [ "sample string 1", "sample string 2" ] }, "Name": "sample string 3", "NumberSettingsConfiguration": { "CurrencyId": 1, "IsCurrency": true, "IsPercentage": true }, "RelationSettingsConfiguration": { "RelatedEntityAttributeName": "sample string 1", "RelatedEntityCategoryListName": "sample string 2", "RelatedEntityDefinitionId": 3 }, "MirrorSettingsConfiguration": { "mirrorAttributeId": 1, "mirrorEntityTrail": [ 1, 2 ] }, "Required": true, "TypeId": 5, "Unique": true, "ValidationId": 1, "IsReadOnly": true, "StartIndex": 1, "Prefix": "sample string 8" }
application/xml, text/xml
Sample:
<CreateEntityAttributeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels"> <AutoNumericSettingsConfiguration> <Prefix>sample string 1</Prefix> <StartIndex>2</StartIndex> </AutoNumericSettingsConfiguration> <CheckboxSettingsConfiguration> <DefaultValue>true</DefaultValue> </CheckboxSettingsConfiguration> <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> <EmployeeListSettingsConfiguration> <DefaultToAuthor>true</DefaultToAuthor> </EmployeeListSettingsConfiguration> <EntityCategoryId>1</EntityCategoryId> <Explanation>sample string 2</Explanation> <FileSettingsConfiguration> <AllowedExtensions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AllowedExtensions> <MaxFileSizeMb>1</MaxFileSizeMb> </FileSettingsConfiguration> <IsReadOnly>true</IsReadOnly> <MirrorSettingsConfiguration> <mirrorAttributeId>1</mirrorAttributeId> <mirrorEntityTrail xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:long>1</d3p1:long> <d3p1:long>2</d3p1:long> </mirrorEntityTrail> </MirrorSettingsConfiguration> <Name>sample string 3</Name> <NumberSettingsConfiguration> <CurrencyId>1</CurrencyId> <IsCurrency>true</IsCurrency> <IsPercentage>true</IsPercentage> </NumberSettingsConfiguration> <Prefix>sample string 8</Prefix> <RelationSettingsConfiguration> <RelatedEntityAttributeName>sample string 1</RelatedEntityAttributeName> <RelatedEntityCategoryListName>sample string 2</RelatedEntityCategoryListName> <RelatedEntityDefinitionId>3</RelatedEntityDefinitionId> </RelationSettingsConfiguration> <Required>true</Required> <StartIndex>1</StartIndex> <TypeId>5</TypeId> <Unique>true</Unique> <ValidationId>1</ValidationId> </CreateEntityAttributeViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ReadEntityAttributeViewModelName | Description | Type | Additional information |
---|---|---|---|
AgendaItemBackgroundColor | string |
None. |
|
AgendaItemText | string |
None. |
|
AgendaItemTextColor | string |
None. |
|
Choices | Collection of ReadEntityAttributeChoiceViewModel |
None. |
|
CurrencyId | integer |
None. |
|
CurrencySymbol | string |
None. |
|
DefaultToAuthor | boolean |
None. |
|
DefaultValue | string |
None. |
|
EntityCategoryId | integer |
None. |
|
Explanation | string |
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. |
|
IsReadOnly | boolean |
None. |
|
IsRecurrable | boolean |
None. |
|
IsRequired | boolean |
None. |
|
IsUnique | boolean |
None. |
|
MirrorConfig | MirrorSettingsConfigurationViewModel |
None. |
|
Name | string |
None. |
|
Order | integer |
None. |
|
Prefix | string |
None. |
|
StartIndex | integer |
None. |
|
RelatedEntityDefinitionId | integer |
None. |
|
TypeId | integer |
None. |
|
MaxFileSizeMb | decimal number |
None. |
|
AllowedExtensions | string |
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", "DefaultToAuthor": true, "DefaultValue": "sample string 6", "EntityCategoryId": 7, "Explanation": "sample string 8", "Id": 9, "IsAgendaItem": true, "IsBirthday": true, "IsCurrency": true, "IsDeletable": true, "IsEditable": true, "IsMultiSelect": true, "IsPercentage": true, "IsReadOnly": true, "IsRecurrable": true, "IsRequired": true, "IsUnique": true, "MirrorConfig": { "mirrorAttributeId": 1, "mirrorEntityTrail": [ 1, 2 ] }, "Name": "sample string 21", "Order": 22, "Prefix": "sample string 23", "StartIndex": 24, "RelatedEntityDefinitionId": 1, "TypeId": 25, "MaxFileSizeMb": 1.0, "AllowedExtensions": "sample string 26", "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.Shared.Models.ViewModels"> <AgendaItemBackgroundColor>sample string 1</AgendaItemBackgroundColor> <AgendaItemText>sample string 2</AgendaItemText> <AgendaItemTextColor>sample string 3</AgendaItemTextColor> <AllowedExtensions>sample string 26</AllowedExtensions> <Choices i:nil="true" /> <CurrencyId>1</CurrencyId> <CurrencySymbol>sample string 4</CurrencySymbol> <DefaultToAuthor>true</DefaultToAuthor> <DefaultValue>sample string 6</DefaultValue> <EntityCategoryId>7</EntityCategoryId> <Explanation>sample string 8</Explanation> <Id>9</Id> <IsAgendaItem>true</IsAgendaItem> <IsBirthday>true</IsBirthday> <IsCurrency>true</IsCurrency> <IsDeletable>true</IsDeletable> <IsEditable>true</IsEditable> <IsMultiSelect>true</IsMultiSelect> <IsPercentage>true</IsPercentage> <IsReadOnly>true</IsReadOnly> <IsRecurrable>true</IsRecurrable> <IsRequired>true</IsRequired> <IsUnique>true</IsUnique> <MaxFileSizeMb>1</MaxFileSizeMb> <MirrorConfig> <mirrorAttributeId>1</mirrorAttributeId> <mirrorEntityTrail xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:long>1</d3p1:long> <d3p1:long>2</d3p1:long> </mirrorEntityTrail> </MirrorConfig> <Name>sample string 21</Name> <Order>22</Order> <Prefix>sample string 23</Prefix> <RelatedEntityDefinitionId>1</RelatedEntityDefinitionId> <StartIndex>24</StartIndex> <TypeId>25</TypeId> <Validations i:nil="true" /> </ReadEntityAttributeViewModel>