Get a Data Specification

GET 
/v1/data-specifications/:dataSpecificationId

Get a Data Specification

Request

Path Parameters

dataSpecificationId stringrequired

The Data Specification identifier.

Responses

200

OK

application/json

Schema

Schema

dataSpecification

object

required

A Data Specification.

dataSpecificationId stringrequired

The Data Specification identifier.

organizationId stringrequired

The Organization identifier that owns this Data Specification.

name stringrequired

A name for the Data Specification.

culture stringrequired

A culture (locale) in a format "languagecode2-country/regioncode2" e.g. "en-US". The culture determines the formatting for dates and numbers, as well as the currency.

description string

(Optional) A description for the Data Specification.

timeZone stringrequired

An IANA time zone database identifier corresponding to the time zone for date and time related properties e.g. "Australia/Sydney".

properties

object[]

required

A collection of properties.

Array [

name stringrequired

The name of the property.

description string

(Optional) The description for the property.

isQueryable booleanrequired

Is then property is queryable by a Campaign?

visibility Visibility (string)required

Visibility

Possible values: [PUBLIC, PRIVATE]

valueType

object

required

The value type of the property.

oneOf

calculated

calculated

object

required

A value that is calculated for a property, based on an expression.

expression stringrequired

An expression to determine the value. The expression may reference other property names.

provided

provided

object

required

A value that is provided for a property

isRequired booleanrequired

Whether the value is required

propertyType

object

required

The type of property.

oneOf

address

address

object

required

An address property that specifies address data.

requireLine1 booleanrequired

Whether line 1 of the address is required

requireLine2 booleanrequired

Whether line 2 of the address is required

requireTownCity booleanrequired

Whether the town / city of the address is required

requireRegion booleanrequired

Whether the region of the address is required

requirePostcode booleanrequired

Whether postal code of the address is required

allowedTwoLetterCountryCodes string[]required

A list of allowed two letter ISO 3166 country codes for the address. Leave empty to allow all countries.

long

long

object

required

A 64-bit integer property that specifies integer data between -9223372036854775808 and 9223372036854775807

minimumValue int64

(Optional) The minimum value that can be specified. If maximum value is also specified, minimum value must be less than or equal to maximum value.

maximumValue int64

(Optional) The maximum value that can be specified. If minimum value is also specified, maximum value must be greater than or equal to minimum value.

boolean

boolean

object

required

A boolean property that specifies a true or false value.

date

date

object

required

A date property that specifies a date or date with a time

hasTimeComponent booleanrequired

Whether the date allows a time component

allowedDays DayOfWeek (string)[]required

The allowed days

Possible values: [DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

minimumValue date-time

(Optional) The minimum value that can be specified. If maximum value is also specified, minimum value must be less than or equal to maximum value.

maximumValue date-time

(Optional) The maximum value that can be specified. If minimum value is also specified, maximum value must be greater than or equal to minimum value.

precision TimePrecision (string)required

The smallest precision of time allowed

Possible values: [HOUR, MINUTE, HIGHEST]

dateRange

dateRange

object

required

A date range property that specifies a date range

hasTimeComponent booleanrequired

Whether the date allows a time component

fromMinimumValue date-time

(Optional) The minimum value that can be specified. If maximum value is also specified, minimum value must be less than or equal to maximum value.

toMaximumValue date-time

(Optional) The maximum value that can be specified. If minimum value is also specified, maximum value must be greater than or equal to minimum value.

decimal

decimal

object

required

A 128-bit decimal property that allows decimal values with precision up to 28-29 digits between -79228162514264337593543950335 and 79228162514264337593543950335

minimumValue

object

A representation of a decimal value, such as 2.5

value stringrequired

The decimal value, as a string. The string representation consists of an optional sign, + (U+002B) or - (U+002D), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character e (U+0065) or E (U+0045) followed by one or more decimal digits.

maximumValue

object

A representation of a decimal value, such as 2.5

value stringrequired

The decimal value, as a string. The string representation consists of an optional sign, + (U+002B) or - (U+002D), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character e (U+0065) or E (U+0045) followed by one or more decimal digits.

roundingDecimals int32required

multiSelect

multiSelect

object

required

A multiple selection property that allows the multiple selection of one or more options

minimumSelections int32required

The minimum number of selections that must be made.

maximumSelections int32required

The maximum number of selections that must be made.

options

object[]

required

The options to select from

Array [

name stringrequired

The name of the option.

value stringrequired

The value of the option.

]

name

name

object

required

A property representing an individual's name

requireFirstName booleanrequired

Whether the first name is required

requireLastName booleanrequired

Whether the last name is required

requireTitle booleanrequired

Whether the title is required

singleSelect

singleSelect

object

required

A multiple selection property that allows the selection of a single option

options

object[]

required

The options to select from

Array [

name stringrequired

The name of the option.

value stringrequired

The value of the option.

]

text

text

object

required

A text property

minimumLength int32

(Optional) The minimum length that can be specified. If maximum length is also specified, minimum length must be less than or equal to maximum length.

maximumLength int32

(Optional) The maximum length that can be specified. If minimum length is also specified, maximum length must be greater than or equal to minimum length.

regularExpressionFormat string

(Optional) A regular expression that the value must match.

timeOfDay

timeOfDay

object

required

A time of day property

minimumValue

object

Represents a time of day. The date and time zone are not significant

hours int32

Hours of day in 24 hour format. Must be from 0 to 23

minutes int32

Minutes of hour of day. Must be from 0 to 59.

seconds int32

Seconds of minutes of the time. Must be from 0 to 59

nanos int32

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

maximumValue

object

Represents a time of day. The date and time zone are not significant

hours int32

Hours of day in 24 hour format. Must be from 0 to 23

minutes int32

Minutes of hour of day. Must be from 0 to 59.

seconds int32

Seconds of minutes of the time. Must be from 0 to 59

nanos int32

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

int

int

object

required

A 32-bit integer property that specifies integer data between -2147483648 and 2147483647

minimumValue int32

(Optional) The minimum value that can be specified. If maximum value is also specified, minimum value must be less than or equal to maximum value.

maximumValue int32

(Optional) The maximum value that can be specified. If minimum value is also specified, maximum value must be greater than or equal to minimum value.

]

Example (from schema)

{
  "dataSpecification": {
    "dataSpecificationId": "string",
    "organizationId": "string",
    "name": "string",
    "culture": "string",
    "description": "string",
    "timeZone": "string",
    "properties": [
      {
        "name": "string",
        "description": "string",
        "isQueryable": true,
        "visibility": "PUBLIC",
        "valueType": {},
        "propertyType": {}
      }
    ]
  }
}

default

Error

application/json

Schema

Schema

code int32

An error status code describing the response.

Enum Value	Description
0	OK
1	Cancelled
2	Unknown
3	InvalidArgument
4	DeadlineExceeded
5	NotFound
6	AlreadyExists
7	PermissionDenied
8	ResourceExhausted
9	FailedPrecondition
10	Aborted
11	OutOfRange
12	Unimplemented
13	Internal
14	Unavailable
15	DataLoss
16	Unauthenticated

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

message string

A developer-facing error message

details

object[]

A list of messages containing details about the errors

Array [

@type stringrequired

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...