Get Configuration

Parameters

Name	In	Type	Required	Description
configId	path	integer(int32)	true	The ID of the configuration to load.

Example cURL Request

curl 'https://adf-dev.semantic-web.at/ADF/api/configurations/1' \
--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	A specific ADF configuration
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not Found

200 Response Example

{
    "configuration": {
        "id": 1,
        "user": "ppil",
        "created": "2023-08-04T08:09:42.889Z",
        "config": {
            "title": "Wine Cheese Vocabulary",
            "searchSpace": "f8c3c4f8-c14c-48c7-af5a-ab5f63b3ae93",
            "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": [
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Wines",
                        "title": "Wines",
                        "show": true,
                        "facetMode": "hierarchical",
                        "hierarchicalDepth": 3,
                        "maximumTerms": 10,
                        "sorting": "count",
                        "sortingOrder": "desc",
                        "showAllButton": false,
                        "searchable": true,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Wines"
                    },
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Cheeses",
                        "title": "Cheeses",
                        "show": true,
                        "facetMode": "hierarchical",
                        "hierarchicalDepth": 3,
                        "maximumTerms": 10,
                        "sorting": "count",
                        "sortingOrder": "desc",
                        "showAllButton": false,
                        "searchable": true,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Cheeses"
                    },
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Cheese-descriptors",
                        "title": "Cheese descriptors",
                        "show": true,
                        "facetMode": "flat",
                        "hierarchicalDepth": 3,
                        "maximumTerms": 10,
                        "sorting": "count",
                        "sortingOrder": "desc",
                        "showAllButton": false,
                        "searchable": true,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Cheese-descriptors"
                    },
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Wine-descriptors",
                        "title": "Wine descriptors",
                        "show": true,
                        "facetMode": "flat",
                        "hierarchicalDepth": 3,
                        "maximumTerms": 10,
                        "sorting": "count",
                        "sortingOrder": "desc",
                        "showAllButton": false,
                        "searchable": false,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Wine-descriptors"
                    },
                    {
                        "uri": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type",
                        "title": "Entity types",
                        "show": true,
                        "facetMode": "flat",
                        "hierarchicalDepth": 3,
                        "maximumTerms": 10,
                        "sorting": "count",
                        "sortingOrder": "desc",
                        "showAllButton": false,
                        "searchable": false,
                        "refId": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
                    }
                ],
                "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": [
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Wines",
                        "title": "Wines",
                        "show": false,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Wines"
                    },
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Cheeses",
                        "title": "Cheeses",
                        "show": false,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Cheeses"
                    },
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Cheese-descriptors",
                        "title": "Cheese descriptors",
                        "show": false,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Cheese-descriptors"
                    },
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/Wine-descriptors",
                        "title": "Wine descriptors",
                        "show": false,
                        "refId": "http://schema.semantic-web.at/Harmonizer/Wine-descriptors"
                    },
                    {
                        "uri": "http://schema.semantic-web.at/Harmonizer/website",
                        "title": "website",
                        "show": false,
                        "refId": "http://schema.semantic-web.at/Harmonizer/website"
                    },
                    {
                        "uri": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type",
                        "title": "Entity types",
                        "show": false,
                        "refId": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
                    }
                ],
                "showSimilar": true,
                "showSimilarAsImage": false,
                "showRecommendations": false,
                "recommender": "",
                "numberOfRecommendations": 4,
                "numberOfSimilar": 4,
                "showRecommendedAsImage": false,
                "showConceptHighlighting": true
            }
        }
    },
    "message": "Successfully loaded configuration 1."
}

200 Response Schema

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

Name

Type

Description

configuration

object

An object with the settings and metadata of the configuration.

Configuration

message

string

A message informing on the success of the operation.

In this section: