Skip to main content

List Data Specifications

GET 

/v1/data-specifications

List Data Specifications

Request

Query Parameters

    pageSize int32

    Page size. Must be between 1 and 100.

    pageToken string

    Page token used to retrieve the next page of results.

    organizationIds string[]

    Filter to a list of Organization identifiers.

Responses

OK

Schema

    dataSpecifications

    object[]

    required

  • Array [

  • 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

    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.

    propertyType

    object

    required

    The type of property.

    oneOf

    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.

  • ]

  • ]

  • nextPageToken string

    (Optional)

Loading...