Get Default Configuration

Example cURL Request

curl 'https://adf-dev.semantic-web.at/ADF/api/configurations/default' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJfeXpPU1JLUkV5MWg2SFUyeDNYaG9EdXQyUEItRldZWmpVcTVqdF93UUpNIn0.eyJleHAiOjE3MDE5Njg1NTIsImlhdCI6MTcwMTk2ODI1MiwianRpIjoiMTgzNTQwOTktY2VjZi00NjFhLTk3ZWItMTEzMjdhMmI4OTNiIiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi1pbnRlcm5hbC1ldS5wb29scGFydHkuYml6L2F1dGgvcmVhbG1zL3JkZm94LWludGVncmF0aW9uLnBvb2xwYXJ0eS5iaXoiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiMmY4N2RiZjYtZWExZC00OTc5LWE3YWYtNmEwZTExMTA0N2IyIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicHB0Iiwic2Vzc2lvbl9zdGF0ZSI6IjgzNGI2YTAzLTBmNTYtNDcwMC1hNWYyLTk5MmJhYmE0ZGMyZiIsImFsbG93ZWQtb3JpZ2lucyI6WyIqIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImxvY2FsLXVzZXIiLCJQb29sUGFydHlVc2VyIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLXJkZm94LWludGVncmF0aW9uLnBvb2xwYXJ0eS5iaXoiXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwic2lkIjoiODM0YjZhMDMtMGY1Ni00NzAwLWE1ZjItOTkyYmFiYTRkYzJmIiwiaXJpIjoiaHR0cHM6Ly9yZGZveC1pbnRlZ3JhdGlvbi5wb29scGFydHkuYml6L3VzZXIvMmY4N2RiZjYtZWExZC00OTc5LWE3YWYtNmEwZTExMTA0N2IyIiwidWlMYW5ndWFnZSI6ImVuIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJkaXNwbGF5TGFuZ3VhZ2VzIjpbIiJdLCJza29zVmlldyI6IkJBU0lDU0tPU1ZJRVciLCJuYW1lIjoiUFBJTCBUZXN0IFVzZXIiLCJncm91cHMiOlsiL3BwaWwiXSwidGltZVpvbmUiOiJFdXJvcGUvVmllbm5hIiwicHJlZmVycmVkX3VzZXJuYW1lIjoicHBpbCIsImdpdmVuX25hbWUiOiJQUElMIiwiYWNMYW5ndWFnZSI6ImVuIiwiZmFtaWx5X25hbWUiOiJUZXN0IFVzZXIifQ.n4Tj5jUGO2fa5j94GmENmyUG5AAlOk2M2G18YOok9yrTIUotx93bGrPJcWBXMN6lAoGg6e9-QUr_mogjb0rOmp4wnWsp_5Pom7xD_QJYQd0iCElanYO-OWKjJiLpvq27hA1o6ro2i-TGKTNUdlijzpWZNS0Q7wy65Eq3QcKrRC7tW4JYU3_idQpmyrQ48hz-uWZD6BcrrjGXy5-33cW-0HkxoCstzalFXTFQ5aNEEhAZw9IvDEDb3dAprz6bik9WdI7SAgfYCwNuUWN9zb3a6ojbhg4RIp1Eugss-Wgl728rz1jQK43ECD9O4wZ73un3_nA8ArFAyMTrMtc7W8QrgQ'

Responses

Status	Meaning	Description
200	OK	Get the default settings of an ADF configuration
401	Unauthorized	Unauthorized; returned if the user is not logged in
403	Forbidden	Forbidden; returned if the user is logged in but not allowed to access the API endpoint or ADF as such (e.g. the user belongs to a user group in PoolParty that does not grant access to ADF)
404	Not Found	Not Found

200 Response Example

{
    "configuration": {
        "id": null,
        "user": "anonymous",
        "created": null,
        "config": {
            "title": "",
            "searchSpace": "",
            "visible": true,
            "result": {
                "itemsPerPage": 10,
                "showResultCount": true,
                "summaryLength": 200,
                "showTags": true,
                "numberOfTags": 10,
                "titleAction": "detail_view",
                "dateFormat": "medium",
                "showSimilarDocuments": true,
                "numberOfSimilarDocuments": 5,
                "showDynamicSentiment": false,
                "showResultAsImage": false
            },
            "filter": {
                "facetsToShow": [],
                "hideEmptyFacets": true,
                "componentOrder": []
            },
            "layout": {
                "basicActionColor": {
                    "backgroundColor": "#1565c0",
                    "fontColor": "#ffffff"
                },
                "focusActionColor": {
                    "backgroundColor": "#f07d2e",
                    "fontColor": "#ffffff"
                },
                "criticalActionColor": {
                    "backgroundColor": "#ff0000",
                    "fontColor": "#ffffff"
                },
                "navbar": {
                    "backgroundColor": "#00adee",
                    "fontColor": "#ffffff"
                },
                "facets": {
                    "backgroundColor": "#fff",
                    "fontColor": "#212121"
                },
                "documents": {
                    "backgroundColor": "#fff",
                    "fontColor": "#212121"
                },
                "logo": ""
            },
            "details": {
                "detailsToShow": [],
                "showSimilar": false,
                "showSimilarAsImage": false,
                "showRecommendations": false,
                "recommender": "",
                "numberOfRecommendations": 4,
                "numberOfSimilar": 4,
                "showRecommendedAsImage": false,
                "showConceptHighlighting": false
            }
        }
    },
    "message": "Successfully loaded the default configuration."
}

200 Response Schema

Name	Type	Description
configuration	object	An object with the default settings and metadata of an ADF Search Application configuration. Configuration
message	string	A message informing on the success of the operation.

Name

Type

Description

configuration

object

An object with the default settings and metadata of an ADF Search Application configuration.

Configuration

message

string

A message informing on the success of the operation.

In this section: