API - Instances calls

Tip

Test all of those requests in our API-Explorer.

/instances

POST /api/v1/instances
Create a new instance
{
    "template_id":    780,
    "name":           "New Instance {{$timestamp}}",
    "description":    "The description of my new instance.",
    "lang_tag":       "en_US"
}
Data:
  • name (string) – (Required) Name of the instance
  • template_id (integer) – (Required) Template ID the instance should be created of
  • company_id (int) – (Optional) Company_id of the company the instance should be created for
  • template_type (enum) – (Optional) The entity the instance should be generated of
  • description (string) – (Optional) Description of the instance.
  • lang_tag (enum) – (Optional) [“sq_AL”, “ar_DZ”, “ar_BH”, “ar_EG”, “ar_IQ”, “ar_JO”, “ar_KW”, “ar_LB”, “ar_LY”, “ar_MA”, “ar_OM”, “ar_QA”, “ar_SA”, “ar_SD”, “ar_SY”, “ar_TN”, “ar_AE”, “ar_YE”, “be_BY”, “bg_BG”, “ca_ES”,”zh_CN”, “zh_HK”, “zh_SG”, “hr_HR”, “cs_CZ”, “da_DK”, “nl_BE”, “nl_NL”, “en_AU”, “en_CA”, “en_IN”, “en_IE”,”en_MT”, “en_NZ”, “en_PH”, “en_SG”, “en_ZA”, “en_GB”, “en_US”, “et_EE”, “fi_FI”, “fr_BE”, “fr_CA”, “fr_FR”,”fr_LU”, “fr_CH”, “de_AT”, “de_DE”, “de_LU”, “de_CH”, “el_CY”, “el_GR”, “iw_IL”, “hi_IN”, “hu_HU”, “is_IS”,”in_ID”, “ga_IE”, “it_IT”, “it_CH”, “ja_JP”, “ja_JP”, “ko_KR”, “lv_LV”, “lt_LT”, “mk_MK”, “ms_MY”, “mt_MT”, “no_NO”, “no_NO”, “pl_PL”, “pt_BR”, “pt_PT”, “ro_RO”, “ru_RU”, “sr_BA”, “sr_ME”, “sr_CS”, “sr_RS”, “sk_SK”,”sl_SI”, “es_AR”, “es_BO”, “es_CL”, “es_CO”, “es_CR”, “es_DO”, “es_EC”, “es_SV”, “es_GT”, “es_HN”, “es_MX”,”es_NI”, “es_PA”, “es_PY”, “es_PE”, “es_PR”, “es_ES”, “es_US”, “es_UY”, “es_VE”, “sv_SE”, “th_TH”, “th_TH”,”tr_TR”, “uk_UA”, “vi_VN”]
Newly created instance object
{
    "active": 1,
    "base_url": "https:\/\/adventskranz.onlineapp.co\/",
    "description": "The description of my new instance.",
    "expiration_date": "2015-04-27",
    "fb_app_id": "725444547534506",
    "fb_app_namespace": "advents-kranz",
    "fb_page_id": null,
    "fb_page_name": null,
    "fb_page_url": "",
    "id": 9865,
    "lang_tag": "en_US",
    "m_id": 299,
    "name": "New Instance 1429522046",
    "template_id": 780,
    "timestamp": 1429522082,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9865"
        }
    }
}

Link to the parameter documentation.

GET /api/v1/instances
Retrieve a list of instances.
{
    "_links": {
        "self": {
            "href": "https://v2-stage.app-arena.com/api/v1/instances?page=1"
        },
        "first": {
            "href": "https://v2-stage.app-arena.com/api/v1/instances"
        },
        "last": {
            "href": "https://v2-stage.app-arena.com/api/v1/instances?page=371"
        },
        "next": {
            "href": "https://v2-stage.app-arena.com/api/v1/instances?page=2"
        }
    },
    "_embedded": {
        "data": [
            {  ... },
            {
                "active": 1,
                "base_url": "https://dev.iconsultants.eu/git/Photopuzzle-App/",
                "description": "",
                "id": 68,
                "lang_tag": "en_US",
                "m_id": 42,
                "name": "Test Photopuzzle",
                "template_id": 0,
                "_links": {
                    "self": {
                        "href": "https://v2-stage.app-arena.com/api/v1/instances/68"
                    }
                }
            },
            {  ... },
        ]
    },
    "page_count": 371,
    "page_size": 25,
    "total_items": 9270
}

Link to the parameter documentation.

/instances/:i_id

GET /api/v1/instances/:i_id
Path arguments:i_id – ID of the instance.
Retrieve basic information of a single instance.
{
    "active": 1,
    "base_url": "https:\/\/adventskranz.onlineapp.co\/",
    "description": "The description of my new instance.",
    "expiration_date": "2015-05-05",
    "fb_app_id": "725444547534506",
    "fb_app_namespace": "advents-kranz",
    "fb_page_id": null,
    "fb_page_name": null,
    "fb_page_url": "",
    "id": 9905,
    "lang_tag": "en_US",
    "m_id": 299,
    "name": "New Instance 1430202395",
    "template_id": 780,
    "timestamp": 1430202441,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9905"
        }
    }
}
Data:
  • active (bool) – Is this instance active or not (can it be used by the client)
  • base_url (string) – Public URI to access the instance
  • description (string) – Description for the instance
  • expiration_date (string) – Until which date the instance can be used. Format: YYYY-MM-DD
  • fb_app_id (string) – Facebook App ID used for this instance,
  • fb_app_namespace (string) – Facebook App namespace used for this instance
  • fb_page_id (string) – Facebook Fanpage ID the instance is installed on
  • fb_page_name (string) – Facebook Fanpage Name the instance is installed on
  • fb_page_url (string) – Facebook Fanpage Url the instance is installed on
  • id (int) – ID of the instance
  • lang_tag (string) – language of for new instances
  • m_id (int) – ID of the app model of the instance
  • name (string) – Name of the instance
  • template_id (int) – ID of the template of this instance
  • timestamp (int) – Creation/Update time on the server
PUT /api/v1/instances/:i_id
Path arguments:i_id – ID of the instance.
Example request body
{
    "name": "This is my new instance name. It's changed!",
    "expiration_date": "2015-12-24"
}

Link to the parameter documentation.

Example response body
{
    "active": 1,
    "base_url": "https:\/\/adventskranz.onlineapp.co\/",
    "description": "The description of my new instance.",
    "expiration_date": "2015-12-24",
    "fb_app_id": "725444547534506",
    "fb_app_namespace": "advents-kranz",
    "fb_page_id": "",
    "fb_page_name": "",
    "fb_page_url": "https:\/\/www.facebook.com\/",
    "id": 9759,
    "lang_tag": "en_US",
    "m_id": 299,
    "name": "This is my new instance name. It's changed!",
    "template_id": 780,
    "timestamp": 1427960768,
    "_links": {
    "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9759"
        }
    }
}

Link to the parameter documentation.

DELETE /api/v1/instances/:i_id
Path arguments:i_id – id of the instance.

Successful DELETE requests will return HTTP-Status code 204.

/instances/:i_id/configs

GET /api/v1/instances/:i_id/configs
Path arguments:i_id – id of the instance.
Example request body
{
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/configs?page=1"
        },
        "first": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/configs"
        },
        "last": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/configs?page=11"
        },
        "next": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/configs?page=2"
        }
    },
    "_embedded": {
        "data": [
            {  ... },
            {
                "description": "Show debug information for this instance?",
                "id": "admin_debug_mode",
                "lang_tag": "de_DE",
                "name": "[Show debug information]",
                "template_id": 0,
                "type": "checkbox",
                "value": 0,
                "_links": {
                    "self": {
                        "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/configs\/admin_debug_mode"
                    }
                }
            },
            {  ... },
        }
    }
}

Documentation of the configs parameter.

/instances/:i_id/configs/:config_id

GET /api/v1/instances/:i_id/configs/:config_id(checkbox)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "Zusätzliche Loginabfrage für Export und löschen der Userdaten, inklusive Log-Eintrag der angemeldeten Person. Funktioniert nur mit App-Internen Logins, nicht mit Social-Connects!",
    "id": "activate_admin_secure_login",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "[Admin Sicherheitslogin aktivieren]",
    "template_id": 780,
    "type": "checkbox",
    "value": 0,
    "timestamp": 1429104304,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/activate_admin_secure_login"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(color)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "Die Hintergrundfarbe betrifft alle Seiten der App, inklusive Footer. Empfehlung: Wählen Sie eine helle, neutrale Farbe (z.B. weiß). Weitere Infos siehe Grafikleitfaden.",
    "id": "app_color_1",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "Hintergrundfarbe",
    "template_id": 780,
    "type": "color",
    "value": "#ffffff",
    "timestamp": 1429104762,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/app_color_1"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(css)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "compiler": "less",
    "description": "Diese CSS Konfiguration wird vom Entwickler erstellt und enthält die wichtigsten CSS Formatierungen der App.",
    "id": "css_app",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "CSS der Applikation",
    "src": "https:\/\/www.app-arena.com\/uploads\/apps\/model\/299\/0\/de_DE\/css\/css_app.css",
    "template_id": 780,
    "type": "css",
    "value": "Here you find the complete styling of the application."
    "timestamp": 1429104816,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/css_app"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(date)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "Nutzer können ab 0.01 Uhr des von Ihnen festgelegten Datums teilnehmen.",
    "id": "door_11_validity_period_start",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "Startdatum für die Teilnahme",
    "template_id": 780,
    "type": "date",
    "value": "2014-12-11",
    "timestamp": 1429105031,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/door_11_validity_period_start"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(image)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "Das Unternehmenslogo wird auf der Header-Grafik abgebildet. Alternativ können Sie das Logo in Ihre Grafiken integrieren und die automatische Ansicht des Logos in dem Punkt Header deaktivieren. Empfohlene Größe: 180 x 180 px. Weitere Infos siehe Grafikleitfaden.",
    "height": "",
    "id": "app_logo",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "Unternehmenslogo",
    "size": "",
    "src": "https:\/\/app-manager.s3.amazonaws.com\/apps\/models\/2\/9\/9\/0\/de_DE\/01_01_logo_1411631048_0.png",
    "template_id": 780,
    "type": "image",
    "value": "https:\/\/app-manager.s3.amazonaws.com\/apps\/models\/2\/9\/9\/0\/de_DE\/01_01_logo_1411631048_0.png",
    "width": "",
    "timestamp": 1429105088,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/app_logo"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(multiselect)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "Geben Sie hier an, welche Art von Inhalten Sie hinter dem Türchen anzeigen möchten. Die jeweiligen Inhalte legen Sie innerhalb der nächsten Schritte fest. Weitere Infos siehe Konfigurationsleitfaden.",
    "id": "door_1_pages_activated",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "Inhalte des Türchens",
    "source": [
        {
            "value": "none",
            "text": "Keine Seite"
        },
        {
            "value": "page",
            "text": "Inhaltsseite"
        },
        {
            "value": "quiz",
            "text": "Quiz-Seite"
        }
    ],
    "template_id": 780,
    "type": "multiselect",
    "value": [
        "page",
        "quiz"
    ],
    "timestamp": 1429105338,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/door_1_pages_activated"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(select)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "Wählen Sie eine der vordefinierten Schriftarten aus oder legen Sie per CSS eine eigene Schriftart fest. Weitere Infos siehe Grafikleitfaden.",
    "id": "app_font_body",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "Schriftart für Textkörper",
    "source": [
        {  ... },
        {
            "value": "arial",
            "text": "Arial"
        },
        {
            "value": "delius-Swash",
            "text": "Delius Swash Caps"
        }
        {  ... },
    ],
    "template_id": 780,
    "type": "select",
    "value": "source-sans-pro",
    "timestamp": 1429105490,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/app_font_body"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(text)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "Die E-Mail-Adresse des Ansprechpartners wird nicht veröffentlicht oder an Dritte weitergegeben. Beispiel: maxmustermann@unternehmensname.com.",
    "format": "text",
    "id": "admin_mails",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "maxlength": "",
    "name": "E-Mail-Adresse des Ansprechpartners (nicht öffentlich sichtbar)",
    "placeholder": "",
    "template_id": 780,
    "type": "text",
    "value": "",
    "timestamp": 1429105669,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/admin_mails"
        }
    }
}

Documentation of the configs parameter.

GET /api/v1/instances/:i_id/configs/:config_id(textarea)
Path arguments:
  • model_id – ID of the config.
  • i_id – ID of the instance.
Retrieve basic information of a single model.
{
    "description": "<p>Erklärung, die ein Admin bestätigen muss, bevor er die Teilnehmer-Daten des Wettbewerbs exportieren darf.\ \ <\/p>",
    "id": "admin_export_terms",
    "instance_id": 9849,
    "lang_tag": "de_DE",
    "name": "[Erklärung zur Datenverwendung beim Export]",
    "template_id": 780,
    "type": "textarea",
    "value": "<h3>Erklärung zur vertraulichen Datenverwendung<\/h3>Hiermit bestätige ich, dass die durch diese Facebook Applikation erhobenen Daten ausschließlich zur Durchführung dieses Wettbewerbs verwendet werden. Zudem bestätige ich die Daten nach Ablauf der Werbeaktion zu löschen. Die iConsultants GmbH wird von jeglicher Haftung, die durch den Missbrauch der zur Verfügung gestellten Daten entsteht, befreit.",
    "timestamp": 1429105717,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9849\/configs\/admin_export_terms"
        }
    }
}

Documentation of the configs parameter.

PUT /api/v1/instances/:i_id/configs/:config_id(checkbox)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":               "Updated Name of Checkbox",
    "value":              false,
    "description":        "Updated description of my checkbox",
    "data_caption_off":   "Updated Custom Off",
    "data_caption_on":    "Updated Custom On",
    "data_label":         "Updated Optional label"
}
Example response body
{
    "description": "Zusätzliche Loginabfrage für Export und löschen der Userdaten, inklusive Log-Eintrag der angemeldeten Person. Funktioniert nur mit App-Internen Logins, nicht mit Social-Connects!",
    "id": "activate_admin_secure_login",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "[Admin Sicherheitslogin aktivieren]",
    "template_id": 780,
    "type": "checkbox",
    "value": 0,
    "timestamp": 1430291456,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/activate_admin_secure_login"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(color)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":       "Updated Name of Color",
    "value":      "#EEEEEE",
    "description":"Updated The description of my color"
}
Data:
  • name (string) – (Optional) Name for the config value
  • value (string) – (Optional) Default value for the config element
  • description (string) – (Optional) Description for the instance
Example response body
{
    "description": "Die Hintergrundfarbe betrifft alle Seiten der App, inklusive Footer. Empfehlung: Wählen Sie eine helle, neutrale Farbe (z.B. weiß). Weitere Infos siehe Grafikleitfaden.",
    "id": "app_color_1",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "Hintergrundfarbe",
    "template_id": 780,
    "type": "color",
    "value": "#ffffff",
    "timestamp": 1430291613,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/app_color_1"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(css)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":           "Updated Name of my CSS config",
    "value":          "body { text-align:center; text-color:red; } h1.h1, h2, h3 { font-size: 30px; }",
    "description":    "Updated The description of my config value.",
    "data_compiler":  "css"
}
Data:
  • name (string) – (Optional) Name for the config value
  • value (string) – (Optional) Default value for the config element
  • description (string) – (Optional) Description for the instance
Example response body
{
    "compiler": "less",
    "description": "Diese CSS Konfiguration wird vom Entwickler erstellt und enthält die wichtigsten CSS Formatierungen der App.",
    "id": "css_app",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "CSS der Applikation",
    "src": "https:\/\/www.app-arena.com\/uploads\/apps\/model\/299\/0\/de_DE\/css\/css_app.css",
    "template_id": 780,
    "type": "css",
    "value": "Here you find the complete styling of the application.",
    "timestamp": 1430291682,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/css_app"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(date) DEPRECATED
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":       "Updated Name of my date",
    "value":      "1911-02-22",
    "description":"Updated Enter a valid date"
}
Data:
  • name (string) – (Optional) Name for the config value
  • value (string) – (Optional) value for the config element
  • description (string) – (Optional) Description for the instance
Example response body
{
    "description": "Nutzer können ab 0.01 Uhr des von Ihnen festgelegten Datums teilnehmen.",
    "id": "door_11_validity_period_start",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "Startdatum für die Teilnahme",
    "template_id": 780,
    "type": "date",
    "value": "2014-12-11",
    "timestamp": 1430291882,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/door_11_validity_period_start"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(image)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":           "Updated Name of my image config value",
    "value":          "https://app-manager.s3.amazonaws.com/apps/models/3/0/4/0/de_DE/AppArena_Logo_aufblau_1426686667_0.png",
    "description":    "Updated The description of my config value.",
    "data_alt":       "Updated Service Flatrate promotion image",
    "data_title":     "Updated Save 25% in may on our service flatrate",
    "data_max_height":2000,
    "data_max_width": 2000,
    "data_min_height":200,
    "data_min_width" :200,
    "data_height":    600,
    "data_width":     1000,
    "data_format":    ["jpg"],
    "data_nullable":  true
}
Data:
  • name (string) – (Optional) Name for the config value
  • value (string) – (Optional) value for the config element
  • description (string) – (Optional) Description for the instance
Example response body
{
    "description": "Das Unternehmenslogo wird auf der Header-Grafik abgebildet. Alternativ können Sie das Logo in Ihre Grafiken integrieren und die automatische Ansicht des Logos in dem Punkt "Header” deaktivieren. Empfohlene Größe: 180 x 180 px. Weitere Infos siehe Grafikleitfaden.",
    "height": "",
    "id": "app_logo",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "Unternehmenslogo",
    "size": "",
    "src": "https:\/\/app-manager.s3.amazonaws.com\/apps\/models\/2\/9\/9\/0\/de_DE\/01_01_logo_1411631048_0.png",
    "template_id": 780,
    "type": "image",
    "value": "https:\/\/app-manager.s3.amazonaws.com\/apps\/models\/2\/9\/9\/0\/de_DE\/01_01_logo_1411631048_0.png",
    "width": "",
    "timestamp": 1430291933,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/app_logo"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(multiselect)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":"Updated Name of my config value",
    "description":"Updated The description of my config value.",
    "source":[
        {
            "value": "updated_value_id_1",
            "text": "Updated Text for value 1"
        },
        {
            "value": "value_id_2",
            "text": "Updated Text for value 2"
        },
        {
            "value": "updated_value_id_3",
            "text": "Updated Text for value 3"
        }
    ],
    "value":[ "page" ]
}
Data:
  • name (string) – (Optional) Name for the config value
  • value (array) – (Optional) All values which should be selected by defaul
  • description (string) – (Optional) Description for the instance
  • source (array) – (Optional) All available options of the select config value
Example response body
{
    "description": "Geben Sie hier an, welche Art von Inhalten Sie hinter dem Türchen anzeigen möchten. Die jeweiligen Inhalte legen Sie innerhalb der nächsten Schritte fest. Weitere Infos siehe Konfigurationsleitfaden.",
    "id": "door_1_pages_activated",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "Inhalte des Türchens",
    "source": [
        {
            "value": "none",
            "text": "Keine Seite"
        },
        {
            "value": "page",
            "text": "Inhaltsseite"
        },
        {
            "value": "quiz",
            "text": "Quiz-Seite"
        }
    ],
    "template_id": 780,
    "type": "multiselect",
    "value": [
    "page",
    "quiz"
    ],
    "timestamp": 1430291995,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/door_1_pages_activated"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(select)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":"Updated Name of my config value",
    "description":"The description of my config value.",
    "source":[
        {
            "value": "ubuntu",
            "text": "New Ubuntu text"
        },
        {
            "value": "updated_value_id_2",
            "text": "Updated Text for value 2"
        },
        {
            "value": "value_id_3",
            "text": "Updated Text for value 3"
        }
    ],
    "value":"ubuntu"
}
Data:
  • name (string) – (Optional) Name for the config value
  • value (string) – (Optional) Default value for the config element
  • description (string) – (Optional) Description for the instance
  • source (array) – (Optional) All available options of the select config value
Example response body
{
    "description": "Wählen Sie eine der vordefinierten Schriftarten aus oder legen Sie per CSS eine eigene Schriftart fest. Weitere Infos siehe Grafikleitfaden.",
    "id": "app_font_body",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "Schriftart für Textkörper",
    "source": [
        {
            "value": "arial",
            "text": "Arial"
        },
        {
            "value": "delius-Swash",
            "text": "Delius Swash Caps"
        }
    ],
    "template_id": 780,
    "type": "select",
    "value": "source-sans-pro",
    "timestamp": 1430292095,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/app_font_body"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(text)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":"Updated Name of my config value",
    "value":"updated@email.com",
    "description":"Updated Enter a valid Email (max. 22 lowercase characters or numbers, no whitespaces, @).",
    "data_type":"email",
    "data_placeholder":"Updated Enter email here",
    "data_pattern":"[a-zA-Z0-9@]{22}"
}
Data:
  • name (string) – (Optional) Name of the config value
  • value (string) – (Optional) value for the config element
  • description (string) – (Optional) Description for the config value
  • min (integer) – (Optional) Minimum value (validation for type “number”)
  • max (integer) – (Optional) Maximum value (validation for type “number”)
  • max_lenght (integer) – (Optional) Maximum value (validation for type “text”)
  • min_lenght (integer) – (Optional) Minimum value (validation for type “text”)
  • pattern (string) – (Optional) Regular expression for input validation defines an input mask
Example response body
{
    "description": "Die E-Mail-Adresse des Ansprechpartners wird nicht veröffentlicht oder an Dritte weitergegeben. Beispiel: maxmustermann@unternehmensname.com.",
    "format": "text",
    "id": "admin_mails",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "maxlength": "",
    "name": "E-Mail-Adresse des Ansprechpartners (nicht öffentlich sichtbar)",
    "placeholder": "",
    "template_id": 780,
    "type": "text",
    "value": "",
    "timestamp": 1430292203,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/admin_mails"
        }
    }
}

Table with data_ parameters and the description of them.

PUT /api/v1/instances/:i_id/configs/:config_id(textarea)
Path arguments:
  • i_id – ID of the instance.
  • model_id – ID of the config.
Example request body
{
    "name":       "Updated Name of my config value",
    "value":      "<h1>Updated This is my default HTML content</h1>",
    "description":"Updated The description of my config value.",
    "data_editor":"code"
}
Data:
  • name (string) – (Optional) Name of the config value
  • value (string) – (Optional) Default value for the config element
  • description (string) – (Optional) Description for the config value
  • editor (enum) – (Optional) Which editor should be shown to the user?
Example response body
{
    "description": "<p>Erklärung, die ein Admin bestätigen muss, bevor er die Teilnehmer-Daten des Wettbewerbs exportieren darf.\ \ <\/p>",
    "id": "admin_export_terms",
    "instance_id": 9910,
    "lang_tag": "de_DE",
    "name": "[Erklärung zur Datenverwendung beim Export]",
    "template_id": 780,
    "type": "textarea",
    "value": "<h3>Erklärung zur vertraulichen Datenverwendung<\/h3>Hiermit bestätige ich, dass die durch diese Facebook Applikation erhobenen Daten ausschließlich zur Durchführung dieses Wettbewerbs verwendet werden. Zudem bestätige ich die Daten nach Ablauf der Werbeaktion zu löschen. Die iConsultants GmbH wird von jeglicher Haftung, die durch den Missbrauch der zur Verfügung gestellten Daten entsteht, befreit.",
    "timestamp": 1430292255,
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9910\/configs\/admin_export_terms"
        }
    }
}

Table with data_ parameters and the description of them.

DELETE /api/v1/instances/:i_id/configs/:config_id

Successful DELETE requests will return HTTP-Status code 204.

/instances/:i_id/languages

GET /api/v1/instances/:i_id/languages
Example request body
{
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/languages?page=1"
        },
        "first": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/languages"
        },
        "last": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/languages?page=1"
        }
    },
    "_embedded": {
        "data": [
            {
                "lang_id": 409,
                "name": "German (Germany)",
                "is_activated": 1,
                "lang_tag": "de_DE"
            },
            {
                "lang_id": 410,
                "name": "English (United States)",
                "is_activated": 0,
                "lang_tag": "en_US"
            },
            {
                "lang_id": 413,
                "name": "French (France)",
                "is_activated": 0,
                "lang_tag": "fr_FR"
            },
            {
                "lang_id": 488,
                "name": "German (Austria)",
                "is_activated": 0,
                "lang_tag": "de_AT"
            },
            {
                "lang_id": 490,
                "name": "Italian (Italy)",
                "is_activated": 0,
                "lang_tag": "it_IT"
            },
            {
                "lang_id": 524,
                "name": "Spanish (Spain)",
                "is_activated": 0,
                "lang_tag": "es_ES"
            }
        ]
    },
    "page_count": 1,
    "page_size": 25,
    "total_items": 6
}

Documentation for the language.

/instances/:i_id/languages/:lang_tag

PUT /api/v1/instances/:i_id/languages/:lang_tag
Path arguments:
  • i_id – ID of the instance.
  • lang_tag – ID of the language.
Example request body
{
    "is_activated":0
}
Example response body
{
    "is_activated": 0,
    "lang_tag": "en_US",
    "timestamp": 1430141442,
    "id": "en_US",
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9903\/languages\/en_US"
        }
    }
}

/instances/:i_id/languages/:lang_tag/translations

GET /api/v1/instances/:i_id/languages/:lang_tag/translations
Path arguments:
  • i_id – ID of the instance.
  • lang_tag – ID of the language.
Example request body
{
    "_links": {
        "self": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/languages\/en_US\/translations?page=1"
        },
        "first": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/languages\/en_US\/translations"
        },
        "last": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/languages\/en_US\/translations?page=19"
        },
        "next": {
            "href": "https:\/\/v2.app-arena.com\/api\/v1\/instances\/9847\/languages\/en_US\/translations?page=2"
        }
    },
    "_embedded": {
    "data": [
        {  ... },
        {
            "translation_id": "vote",
            "value": "Abstimmen"
        },
        {
            "translation_id": "please_enter_custom_field",
            "value": "Bitte geben Sie einen Wert für %s an."
        },
        {
            "translation_id": "select_video",
            "value": "Video auswählen"
        },
        {  ... },
    }
}

Documentation for the language.

/instances/{i_id}/languages/:lang_tag/translation/:translation_id

PUT /api/v1/instances/{i_id}/languages/:lang_tag/translation/:translation_id
Path arguments:
  • i_id – ID of the translation.
  • lang_tag – ID of the language.
  • translation_id – ID of the translation.
Example request body
{
    "value":"UPDATED Il mio test translation!"
}
Data:value (string) – (Required) Translation

Documentation for the language.