Get Data Extensions
post
/config/sim/v1/setup/getDataExtensions
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of data extension objects.
Root Schema : DataExtensionsGetResponse
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of data extension objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of data extension objects of the organization.
Show Source
-
Array of:
object DataExtensionResponseBody
Model for Data Extension Object
Nested Schema : DataExtensionResponseBody
Type:
objectModel for Data Extension Object
Show Source
-
dataConstraints:
object dataConstraints
Constraints on the values that can be inserted for this data extension property.
-
displayWidth:
integer
This value sets the width of the column when it is displayed in EMCExample:
150 -
extraColumnName:
string
name of the data extension property, cannot be empty.Example:
isKiosk -
isDownloadable:
boolean
boolean value to specify if the property is downloadable.Example:
true -
isEditable:
boolean
boolean value to specify if the property is editable.Example:
true -
isViewable:
boolean
boolean value to specify if the property is viewable.Example:
true -
objectNum:
integer
Object Number of the Data Extension property.Example:
1 -
sortPriority:
integer
sort priority of the property.Example:
1 -
tableName:
string
Name of the table.Example:
workstation -
tableNum:
integer
Object Number of the table.Example:
1 -
translatableHelp:
object translatableHelp
A string that contains translations of help for the property
-
translatableName:
object translatableName
A string that contains translations of column name for the property
-
type:
integer
Type of data that can be inserted for this data extension property. ** Below is a list of acceptable values for type |Type |Description | |-----|--------------| |0 |Text | |1 |Multiline Text| |2 |Number | |3 |Decimal | |4 |Boolean | |5 |Date | |6 |Time | |7 |Date/Time | |8 |Text List | |9 |Lookup List | |10 |Big Text List | |11 |XML Document | |12 |JSON |Example:
1
Nested Schema : dataConstraints
Type:
objectConstraints on the values that can be inserted for this data extension property.
Show Source
-
dateTimeFormat:
string
Valid Date/Time format. For types- Date, Time, Date/Time.Example:
yyyy/MM/dd hh:mm t -
lines:
integer
number of lines allowed. For types- Multiline TextExample:
2 -
lookupList:
object lookupList
List to choose data values from. For types- Lookup List, Text List, Big Text List
-
maxChars:
integer
maximum characters allowed. For types- Text and JSONExample:
128 -
maxValue:
number
maximum value for the allowed range. For types- Number, DecimalExample:
9999 -
minValue:
number
minimum value for the allowed range. For types- Number, DecimalExample:
0
Nested Schema : translatableHelp
Type:
objectA string that contains translations of help for the property
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : translatableName
Type:
objectA string that contains translations of column name for the property
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : lookupList
Type:
objectList to choose data values from. For types- Lookup List, Text List, Big Text List
Example:
{
"1":"Entry-1",
"2":"Entry-2",
"3":"Entry-3"
}