GET Setup/CodeTable
Get codeTables from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeHiddenTables |
Include records where IncludeHiddenTables == true |
boolean |
None. |
| TableName |
Filter by TableName |
string |
None. |
| TableNames | Collection of string |
None. |
|
| AccessType |
Filter by AccessType |
CodeTableAccessType |
None. |
| Scope |
Filter by Scope |
SettingScope |
None. |
| EntryAccessType |
Filter by EntryAccessType |
CodeTableEntryAccessType |
None. |
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| IncludeError |
Include records where RecordState == RecordState.CreatedInError |
boolean |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
Body Parameters
None.
Response Information
Resource Description
List of CodeTableDTOs
Collection of CodeTableDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| TableID |
Table ID |
integer |
None. |
| TableName |
Table Name |
string |
None. |
| AccessType |
Access Type |
CodeTableAccessType |
None. |
| Scope |
Scope |
SettingScope |
None. |
| EntryAccessType |
Entry Access Type |
CodeTableEntryAccessType |
None. |
| EntryValueMaxLength |
Entry Value Max Length |
integer |
None. |
| EntryDescriptionMaxLength |
Entry Description Max Length |
integer |
None. |
| EntryReferenceValueMaxLength |
Entry Reference Value Max Length |
integer |
None. |
| EntryLevels |
Entry Levels |
byte |
None. |
| EntrySortOrder |
Entry Sort Order |
CodeTableEntrySortOrder |
None. |
| EntryProps |
Entry Props |
Collection of Object |
None. |
| Props |
Props |
Collection of Object |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| Summary |
Summary |
string |
None. |