GET /api/v3/digital-boards/constants/field-map

Summary

GET /digital-boards/constants/field-map

Description

Return the field map macros for the digital board resource.

Tags: digital-boards

Parameters

Header Parameters

Name	Type	Required	Description	Example
Authorization	string	✓ Yes		Bearer {AuthToken}
Content-Type	string	✓ Yes		application/json
Accept	string	✓ Yes		application/json
AppIdV3	string	✓ Yes		LCUID-LAP-********-****-****-****-************

Responses

Response: 200

Content Type: application/json

Schema

Type: object

Properties:

• success (boolean)
• field_map (object) Type: object

Properties:

• digital_board.name (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.board_identifier (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.venue_taxonomy_id (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.cached_tags (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.city (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.options.geo_city_name_possessive (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.region_name (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.region_name_possessive (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.country_name (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.country_name_possessive (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.region (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.region_possessive (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.postal_code (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.country (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.country_possessive (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.timezone (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.timezone_offset_seconds (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.five_minute_intervals_since_unix_epoch (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.fifteen_minute_intervals_since_unix_epoch (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.thirty_minute_intervals_since_unix_epoch (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.hours_since_unix_epoch (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

• digital_board.location.days_since_unix_epoch (object) Type: object

  Properties:

  • id (string)
  • object (string)
  • group_id (string)
  • group_name (string)
  • class (string)
  • property (string)
  • macro (string)
  • macroCode (string)
  • name (string)
  • placeholder (string)
  • type (string)
  • defaultClasses (string)
  • defaultCss (string)
  • show (boolean)

Example Response

{
    "success": true,
    "field_map": {
        "digital_board.name": {
            "id": "digital_board_name",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "name",
            "macro": "digital_board.name",
            "macroCode": "{digital_board.name}",
            "name": "Screen Name",
            "placeholder": "The Screen",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.board_identifier": {
            "id": "digital_board_board_identifier",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "board_identifier",
            "macro": "digital_board.board_identifier",
            "macroCode": "{digital_board.board_identifier}",
            "name": "Screen Identifier",
            "placeholder": "SCREEN123",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.venue_taxonomy_id": {
            "id": "digital_board_venue_taxonomy_id",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "venue_taxonomy_id",
            "macro": "digital_board.venue_taxonomy_id",
            "macroCode": "{digital_board.venue_taxonomy_id}",
            "name": "Screen Venue Taxonomy ID",
            "placeholder": "12345",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.cached_tags": {
            "id": "digital_board_cached_tags",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "cached_tags",
            "macro": "digital_board.cached_tags",
            "macroCode": "{digital_board.cached_tags}",
            "name": "Screen Tags",
            "placeholder": "tag1:tag2:tag3",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.city": {
            "id": "digital_board_location_city",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.city",
            "macro": "digital_board.location.city",
            "macroCode": "{digital_board.location.city}",
            "name": "City",
            "placeholder": "Anytown",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.options.geo_city_name_possessive": {
            "id": "digital_board_location_options_geo_city_name_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_city_name_possessive",
            "macro": "digital_board.location.options.geo_city_name_possessive",
            "macroCode": "{digital_board.location.options.geo_city_name_possessive}",
            "name": "City Name Possessive",
            "placeholder": "Anytown's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region_name": {
            "id": "digital_board_location_region_name",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_state_name",
            "macro": "digital_board.location.options.geo_state_name",
            "macroCode": "{digital_board.location.options.geo_state_name}",
            "name": "State / Province",
            "placeholder": "New York",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region_name_possessive": {
            "id": "digital_board_location_region_name_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_state_name_possessive",
            "macro": "digital_board.location.options.geo_state_name_possessive",
            "macroCode": "{digital_board.location.options.geo_state_name_possessive}",
            "name": "State Possessive",
            "placeholder": "New York's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country_name": {
            "id": "digital_board_location_country_name",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_country_name",
            "macro": "digital_board.location.options.geo_country_name",
            "macroCode": "{digital_board.location.options.geo_country_name}",
            "name": "Country",
            "placeholder": "United States",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country_name_possessive": {
            "id": "digital_board_location_country_name_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_country_name_possessive",
            "macro": "digital_board.location.options.geo_country_name_possessive",
            "macroCode": "{digital_board.location.options.geo_country_name_possessive}",
            "name": "Country Possessive",
            "placeholder": "United States'",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region": {
            "id": "digital_board_location_region",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.region",
            "macro": "digital_board.location.region",
            "macroCode": "{digital_board.location.region}",
            "name": "State / Province Code",
            "placeholder": "NY",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region_possessive": {
            "id": "digital_board_location_region_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_state_code_possessive",
            "macro": "digital_board.location.options.geo_state_code_possessive",
            "macroCode": "{digital_board.location.options.geo_state_code_possessive}",
            "name": "State Code Possessive",
            "placeholder": "NY's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.postal_code": {
            "id": "digital_board_location_postal_code",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.postal_code",
            "macro": "digital_board.location.postal_code",
            "macroCode": "{digital_board.location.postal_code}",
            "name": "Postal Code",
            "placeholder": "12345",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country": {
            "id": "digital_board_location_country",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.country",
            "macro": "digital_board.location.country",
            "macroCode": "{digital_board.location.country}",
            "name": "Country Code",
            "placeholder": "USA",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country_possessive": {
            "id": "digital_board_location_country_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_country_code_possessive",
            "macro": "digital_board.location.options.geo_country_code_possessive",
            "macroCode": "{digital_board.location.options.geo_country_code_possessive}",
            "name": "Country Code Possessive",
            "placeholder": "USA's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.timezone": {
            "id": "digital_board_location_timezone",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.timezone",
            "macro": "digital_board.location.timezone",
            "macroCode": "{digital_board.location.timezone}",
            "name": "Timezone",
            "placeholder": "America/Chicago",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.timezone_offset_seconds": {
            "id": "digital_board_location_timezone_offset_seconds",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.timezone_offset_seconds",
            "macro": "digital_board.location.timezone_offset_seconds",
            "macroCode": "{digital_board.location.timezone_offset_seconds}",
            "name": "Timezone Offset Seconds",
            "placeholder": "-21600",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.five_minute_intervals_since_unix_epoch": {
            "id": "digital_board_location_five_minute_intervals_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.five_minute_intervals_since_unix_epoch",
            "macro": "digital_board.location.five_minute_intervals_since_unix_epoch",
            "macroCode": "{digital_board.location.five_minute_intervals_since_unix_epoch}",
            "name": "Five Minute Intervals Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.fifteen_minute_intervals_since_unix_epoch": {
            "id": "digital_board_location_fifteen_minute_intervals_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.fifteen_minute_intervals_since_unix_epoch",
            "macro": "digital_board.location.fifteen_minute_intervals_since_unix_epoch",
            "macroCode": "{digital_board.location.fifteen_minute_intervals_since_unix_epoch}",
            "name": "Fifteen Minute Intervals Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.thirty_minute_intervals_since_unix_epoch": {
            "id": "digital_board_location_thirty_minute_intervals_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.thirty_minute_intervals_since_unix_epoch",
            "macro": "digital_board.location.thirty_minute_intervals_since_unix_epoch",
            "macroCode": "{digital_board.location.thirty_minute_intervals_since_unix_epoch}",
            "name": "Thirty Minute Intervals Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.hours_since_unix_epoch": {
            "id": "digital_board_location_hours_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.hours_since_unix_epoch",
            "macro": "digital_board.location.hours_since_unix_epoch",
            "macroCode": "{digital_board.location.hours_since_unix_epoch}",
            "name": "Hours Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.days_since_unix_epoch": {
            "id": "digital_board_location_days_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.days_since_unix_epoch",
            "macro": "digital_board.location.days_since_unix_epoch",
            "macroCode": "{digital_board.location.days_since_unix_epoch}",
            "name": "Days Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        }
    }
}

Example Implementations

Bash (cURL)

curl --request GET \
    --get "https://api.lucit.app/api/v3/digital-boards/constants/field-map" \
    --header "Authorization: Bearer {AuthToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "AppIdV3: LCUID-LAP-********-****-****-****-************"

JavaScript (Fetch API)

const url = new URL(
    "https://api.lucit.app/api/v3/digital-boards/constants/field-map"
);

const headers = {
    "Authorization": "Bearer {AuthToken}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "AppIdV3": "LCUID-LAP-********-****-****-****-************",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

PHP (Guzzle)

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.lucit.app/api/v3/digital-boards/constants/field-map',
    [
        'headers' => [
            'Authorization' => 'Bearer {AuthToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Python (Requests)

import requests
import json

url = 'https://api.lucit.app/api/v3/digital-boards/constants/field-map'
headers = {
  'Authorization': 'Bearer {AuthToken}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example Responses

200 Response

{
    "success": true,
    "field_map": {
        "digital_board.name": {
            "id": "digital_board_name",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "name",
            "macro": "digital_board.name",
            "macroCode": "{digital_board.name}",
            "name": "Screen Name",
            "placeholder": "The Screen",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.board_identifier": {
            "id": "digital_board_board_identifier",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "board_identifier",
            "macro": "digital_board.board_identifier",
            "macroCode": "{digital_board.board_identifier}",
            "name": "Screen Identifier",
            "placeholder": "SCREEN123",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.venue_taxonomy_id": {
            "id": "digital_board_venue_taxonomy_id",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "venue_taxonomy_id",
            "macro": "digital_board.venue_taxonomy_id",
            "macroCode": "{digital_board.venue_taxonomy_id}",
            "name": "Screen Venue Taxonomy ID",
            "placeholder": "12345",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.cached_tags": {
            "id": "digital_board_cached_tags",
            "object": "digital_board",
            "group_id": "screen",
            "group_name": "Screen",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "cached_tags",
            "macro": "digital_board.cached_tags",
            "macroCode": "{digital_board.cached_tags}",
            "name": "Screen Tags",
            "placeholder": "tag1:tag2:tag3",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.city": {
            "id": "digital_board_location_city",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.city",
            "macro": "digital_board.location.city",
            "macroCode": "{digital_board.location.city}",
            "name": "City",
            "placeholder": "Anytown",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.options.geo_city_name_possessive": {
            "id": "digital_board_location_options_geo_city_name_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_city_name_possessive",
            "macro": "digital_board.location.options.geo_city_name_possessive",
            "macroCode": "{digital_board.location.options.geo_city_name_possessive}",
            "name": "City Name Possessive",
            "placeholder": "Anytown's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region_name": {
            "id": "digital_board_location_region_name",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_state_name",
            "macro": "digital_board.location.options.geo_state_name",
            "macroCode": "{digital_board.location.options.geo_state_name}",
            "name": "State / Province",
            "placeholder": "New York",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region_name_possessive": {
            "id": "digital_board_location_region_name_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_state_name_possessive",
            "macro": "digital_board.location.options.geo_state_name_possessive",
            "macroCode": "{digital_board.location.options.geo_state_name_possessive}",
            "name": "State Possessive",
            "placeholder": "New York's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country_name": {
            "id": "digital_board_location_country_name",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_country_name",
            "macro": "digital_board.location.options.geo_country_name",
            "macroCode": "{digital_board.location.options.geo_country_name}",
            "name": "Country",
            "placeholder": "United States",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country_name_possessive": {
            "id": "digital_board_location_country_name_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_country_name_possessive",
            "macro": "digital_board.location.options.geo_country_name_possessive",
            "macroCode": "{digital_board.location.options.geo_country_name_possessive}",
            "name": "Country Possessive",
            "placeholder": "United States'",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region": {
            "id": "digital_board_location_region",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.region",
            "macro": "digital_board.location.region",
            "macroCode": "{digital_board.location.region}",
            "name": "State / Province Code",
            "placeholder": "NY",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.region_possessive": {
            "id": "digital_board_location_region_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_state_code_possessive",
            "macro": "digital_board.location.options.geo_state_code_possessive",
            "macroCode": "{digital_board.location.options.geo_state_code_possessive}",
            "name": "State Code Possessive",
            "placeholder": "NY's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.postal_code": {
            "id": "digital_board_location_postal_code",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.postal_code",
            "macro": "digital_board.location.postal_code",
            "macroCode": "{digital_board.location.postal_code}",
            "name": "Postal Code",
            "placeholder": "12345",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country": {
            "id": "digital_board_location_country",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.country",
            "macro": "digital_board.location.country",
            "macroCode": "{digital_board.location.country}",
            "name": "Country Code",
            "placeholder": "USA",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.country_possessive": {
            "id": "digital_board_location_country_possessive",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.options.geo_country_code_possessive",
            "macro": "digital_board.location.options.geo_country_code_possessive",
            "macroCode": "{digital_board.location.options.geo_country_code_possessive}",
            "name": "Country Code Possessive",
            "placeholder": "USA's",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.timezone": {
            "id": "digital_board_location_timezone",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.timezone",
            "macro": "digital_board.location.timezone",
            "macroCode": "{digital_board.location.timezone}",
            "name": "Timezone",
            "placeholder": "America/Chicago",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.timezone_offset_seconds": {
            "id": "digital_board_location_timezone_offset_seconds",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.timezone_offset_seconds",
            "macro": "digital_board.location.timezone_offset_seconds",
            "macroCode": "{digital_board.location.timezone_offset_seconds}",
            "name": "Timezone Offset Seconds",
            "placeholder": "-21600",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.five_minute_intervals_since_unix_epoch": {
            "id": "digital_board_location_five_minute_intervals_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.five_minute_intervals_since_unix_epoch",
            "macro": "digital_board.location.five_minute_intervals_since_unix_epoch",
            "macroCode": "{digital_board.location.five_minute_intervals_since_unix_epoch}",
            "name": "Five Minute Intervals Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.fifteen_minute_intervals_since_unix_epoch": {
            "id": "digital_board_location_fifteen_minute_intervals_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.fifteen_minute_intervals_since_unix_epoch",
            "macro": "digital_board.location.fifteen_minute_intervals_since_unix_epoch",
            "macroCode": "{digital_board.location.fifteen_minute_intervals_since_unix_epoch}",
            "name": "Fifteen Minute Intervals Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.thirty_minute_intervals_since_unix_epoch": {
            "id": "digital_board_location_thirty_minute_intervals_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.thirty_minute_intervals_since_unix_epoch",
            "macro": "digital_board.location.thirty_minute_intervals_since_unix_epoch",
            "macroCode": "{digital_board.location.thirty_minute_intervals_since_unix_epoch}",
            "name": "Thirty Minute Intervals Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.hours_since_unix_epoch": {
            "id": "digital_board_location_hours_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.hours_since_unix_epoch",
            "macro": "digital_board.location.hours_since_unix_epoch",
            "macroCode": "{digital_board.location.hours_since_unix_epoch}",
            "name": "Hours Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        },
        "digital_board.location.days_since_unix_epoch": {
            "id": "digital_board_location_days_since_unix_epoch",
            "object": "digital_board",
            "group_id": "digital_board_location",
            "group_name": "Location",
            "class": "App\\LuCore\\DigitalBoards\\BoardClass",
            "property": "location.days_since_unix_epoch",
            "macro": "digital_board.location.days_since_unix_epoch",
            "macroCode": "{digital_board.location.days_since_unix_epoch}",
            "name": "Days Since Unix Epoch",
            "placeholder": "5000",
            "type": "text",
            "defaultClasses": "lc_ut_designer lc_dt_data lc_dt_text lc_format_fit_text",
            "defaultCss": "",
            "show": true
        }
    }
}

---

← Back to digital-boards index | Back to main index