Configuration and Content API Guide

Add Data Extensions

post

/config/sim/v1/setup/DataExtensions

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string(string)

Detail that Identifies that who made the change

Data Extension Resource Object

Root Schema : DataExtensionResourceObject

Type: object

Model for Data Extension Object

Show Source

dataConstraints(required): object dataConstraints

Constraints on the values that can be inserted for this data extension property. Note that for 'Boolean' and "XML Document" types, data constraints are not required. For all other types, this is a required field
displayWidth: integer

Maximum Length: 3

The display width of the column, acceptable values include null, 30-999 inclusive

Example: 150
extraColumnName(required): string

Maximum Length: 128

name of the data extension property, cannot be empty.

Example: isKiosk
isDownloadable: boolean

boolean value to specify if the property is downloadable. Default Value = true

Example: true
isEditable: boolean

boolean value to specify if the property is editable. Default Value = true

Example: true
isViewable: boolean

boolean value to specify if the property is viewable. Default Value = true

Example: true
objectNum(required): integer

Object Number of the Data Extension property.

Example: 1
sortPriority: integer

sort priority of the property.

Example: 1
tableNum: integer

Object Number of the table. ** Below table descibes acceptable values for tableNum and the corresponding table Name | tableNum | tableName | |-----------|--------------------| | 17 |Hierarchy Unit | | 20 |Revenue Center | | 25 |Order Type | | 41 |Workstations | | 50 |Currency | | 54 |Tax Class | | 58 |Menu Item Class | | 67 |Discount | | 70 |Service Charge | | 71 |Tender/Media | | 85 |Job Code | | 104 |Employee Class | | 106 |Employee | | 128 |Serving Period | | 131 |Menu Item Master | | 134 |Menu Item Definition| | 138 |Effectivity Groups | | 1001 |Property | | 1010 |Role |

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(required): 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

{
    "description":"Model for Data Extension Object",
    "type":"object",
    "required":[
        "objectNum",
        "extraColumnName",
        "type",
        "dataConstraints"
    ],
    "properties":{
        "objectNum":{
            "description":"Object Number of the Data Extension property.",
            "type":"integer",
            "example":1
        },
        "extraColumnName":{
            "description":"name of the data extension property, cannot be empty.",
            "type":"string",
            "example":"isKiosk",
            "maxLength":128
        },
        "type":{
            "type":"integer",
            "description":"Type of data that can be inserted for this data extension property.\n\n** Below is a list of acceptable values for type\n\n|Type |Description   |\n|-----|--------------|\n|0    |Text          |\n|1    |Multiline Text|\n|2    |Number        |\n|3    |Decimal       |\n|4    |Boolean       |\n|5    |Date          |\n|6    |Time          |\n|7    |Date/Time     |\n|8    |Text List     |\n|9    |Lookup List   |\n|10   |Big Text List |\n|11   |XML Document  |\n|12   |JSON          |\n",
            "example":1
        },
        "dataConstraints":{
            "description":"Constraints on the values that can be inserted for this data extension property. Note that for 'Boolean' and \"XML Document\" types, data constraints are not required. For all other types, this is a required field",
            "type":"object",
            "properties":{
                "maxChars":{
                    "description":"maximum characters allowed. For types- Text and JSON",
                    "type":"integer",
                    "example":128
                },
                "lines":{
                    "description":"number of lines allowed. For types- Multiline Text",
                    "example":2,
                    "type":"integer"
                },
                "minValue":{
                    "description":"minimum value for the allowed range. For types- Number, Decimal",
                    "type":"number",
                    "example":0
                },
                "maxValue":{
                    "description":"maximum value for the allowed range. For types- Number, Decimal",
                    "type":"number",
                    "example":9999
                },
                "dateTimeFormat":{
                    "description":"Valid Date/Time format. For types- Date, Time, Date/Time. Following is the format in which each of the mentioned fields should be passed:\nyear: yyyy or yy\nmonth: MM or M\ndate: dd or d\nhour: HH or H or h or hh\nminute: mm or m or mm:ss\ndisplay_type: t or tt (optional and applicable only when hour is in 'h' or 'hh' format)\ndate_format: year/month/date or month/date/year or date/month/year or year-month-date or month-date-year or date-month-year\ntime_format: hour:minute display_type\ndateTime format: date_format time_format\n",
                    "type":"string",
                    "example":"yyyy/MM/dd hh:mm t"
                },
                "lookupList":{
                    "description":"List to choose data values from. For types- Lookup List, Text List, Big Text List",
                    "type":"object",
                    "example":{
                        "1":"Entry-1",
                        "2":"Entry-2",
                        "3":"Entry-3"
                    }
                }
            }
        },
        "tableNum":{
            "description":"Object Number of the table.\n\n** Below table descibes acceptable values for tableNum and the corresponding table Name\n\n| tableNum  | tableName          |\n|-----------|--------------------|\n| 17        |Hierarchy Unit      |\n| 20        |Revenue Center      |\n| 25        |Order Type          |\n| 41        |Workstations        |\n| 50        |Currency            |\n| 54        |Tax Class           |\n| 58        |Menu Item Class     |\n| 67        |Discount            |\n| 70        |Service Charge      |\n| 71        |Tender/Media        |\n| 85        |Job Code            |\n| 104       |Employee Class      |\n| 106       |Employee            |\n| 128       |Serving Period      |\n| 131       |Menu Item Master    |\n| 134       |Menu Item Definition|\n| 138       |Effectivity Groups  |\n| 1001      |Property            |\n| 1010      |Role                |\n",
            "type":"integer",
            "example":1
        },
        "sortPriority":{
            "type":"integer",
            "example":1,
            "description":"sort priority of the property."
        },
        "displayWidth":{
            "description":"The display width of the column, acceptable values include null, 30-999 inclusive",
            "type":"integer",
            "example":150,
            "maxLength":3
        },
        "translatableName":{
            "description":"A string that contains translations of column name for the property",
            "type":"object",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "ar-AR":"?????"
            }
        },
        "translatableHelp":{
            "description":"A string that contains translations of help for the property",
            "type":"object",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "ar-AR":"?????"
            }
        },
        "isEditable":{
            "description":"boolean value to specify if the property is editable. Default Value =  true",
            "type":"boolean",
            "example":true
        },
        "isViewable":{
            "description":"boolean value to specify if the property is viewable. Default Value =  true",
            "type":"boolean",
            "example":true
        },
        "isDownloadable":{
            "description":"boolean value to specify if the property is downloadable. Default Value =  true",
            "type":"boolean",
            "example":true
        }
    }
}

Nested Schema : dataConstraints

Type: object

Constraints on the values that can be inserted for this data extension property. Note that for 'Boolean' and "XML Document" types, data constraints are not required. For all other types, this is a required field

Show Source

dateTimeFormat: string

Valid Date/Time format. For types- Date, Time, Date/Time. Following is the format in which each of the mentioned fields should be passed: year: yyyy or yy month: MM or M date: dd or d hour: HH or H or h or hh minute: mm or m or mm:ss display_type: t or tt (optional and applicable only when hour is in 'h' or 'hh' format) date_format: year/month/date or month/date/year or date/month/year or year-month-date or month-date-year or date-month-year time_format: hour:minute display_type dateTime format: date_format time_format

Example: yyyy/MM/dd hh:mm t
lines: integer

number of lines allowed. For types- Multiline Text

Example: 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 JSON

Example: 128
maxValue: number

maximum value for the allowed range. For types- Number, Decimal

Example: 9999
minValue: number

minimum value for the allowed range. For types- Number, Decimal

Example: 0

{
    "description":"Constraints on the values that can be inserted for this data extension property. Note that for 'Boolean' and \"XML Document\" types, data constraints are not required. For all other types, this is a required field",
    "type":"object",
    "properties":{
        "maxChars":{
            "description":"maximum characters allowed. For types- Text and JSON",
            "type":"integer",
            "example":128
        },
        "lines":{
            "description":"number of lines allowed. For types- Multiline Text",
            "example":2,
            "type":"integer"
        },
        "minValue":{
            "description":"minimum value for the allowed range. For types- Number, Decimal",
            "type":"number",
            "example":0
        },
        "maxValue":{
            "description":"maximum value for the allowed range. For types- Number, Decimal",
            "type":"number",
            "example":9999
        },
        "dateTimeFormat":{
            "description":"Valid Date/Time format. For types- Date, Time, Date/Time. Following is the format in which each of the mentioned fields should be passed:\nyear: yyyy or yy\nmonth: MM or M\ndate: dd or d\nhour: HH or H or h or hh\nminute: mm or m or mm:ss\ndisplay_type: t or tt (optional and applicable only when hour is in 'h' or 'hh' format)\ndate_format: year/month/date or month/date/year or date/month/year or year-month-date or month-date-year or date-month-year\ntime_format: hour:minute display_type\ndateTime format: date_format time_format\n",
            "type":"string",
            "example":"yyyy/MM/dd hh:mm t"
        },
        "lookupList":{
            "description":"List to choose data values from. For types- Lookup List, Text List, Big Text List",
            "type":"object",
            "example":{
                "1":"Entry-1",
                "2":"Entry-2",
                "3":"Entry-3"
            }
        }
    }
}

Nested Schema : translatableHelp

Type: object

A string that contains translations of help for the property

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"?????"
}

Nested Schema : translatableName

Type: object

A string that contains translations of column name for the property

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"?????"
}

Nested Schema : lookupList

Type: object

List to choose data values from. For types- Lookup List, Text List, Big Text List

Example:

{
    "1":"Entry-1",
    "2":"Entry-2",
    "3":"Entry-3"
}

Response

Supported Media Types

application/json

200 Response

Response object

Root Schema : DataExtensionsResponse

Type: object

Show Source

objectNum(required): integer

Object number of the data extension property

Example: 1

{
    "type":"object",
    "required":[
        "objectNum"
    ],
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the data extension property"
        }
    }
}

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): string

A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}