Update Configuration
24/03/2026
PUT {baseUrl}/api/configurations/{configId}
Allows you to edit settings and metadata of an existing configuration.
Tip
Alternatively, you can use the configuration user interface to edit a configuration. For more information, refer to Creating or Editing a Search Application Configuration.
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
configId | path | integer(int32) | true | The ID of the configuration to update. |
configuration | body (raw) | object | false | An object with the updated settings and metadata of the configuration. Mandatory parameters:
|
Note
application/json is a mandatory content type for operations with a request body.
curl --request PUT 'https://adf-dev.semantic-web.at/ADF/api/configurations/' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ3U2ZNbmY1Wm9leEFhc2NiSnNtZ2tlNktHRnc2NG1laWY0MzJwNHBXX2RrIn0.eyJleHAiOjE3MDk3MzM1MTksImlhdCI6MTcwOTczMzIxOSwianRpIjoiMzcwYjFhY2MtOWUxOS00NzE0LTg5MzgtOTg4NGM5YzYxM2JkIiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi1pbnRlcm5hbC1ldS5wb29scGFydHkuYml6L2F1dGgvcmVhbG1zL3ZvY2FidWxhcnkuc2VtYW50aWMtd2ViLmF0IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQwNjk1MTk2LTQyZGYtNGIzOS05NGEyLTQ1MzgzOGM3YzEzMSIsInR5cCI6IkJlYXJlciIsImF6cCI6InBwdCIsInNlc3Npb25fc3RhdGUiOiIzODA1M2YzYS1lZTA5LTRhOGEtYjdkNi0zZDI2MzI2NjY0YWEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJQb29sUGFydHlTdXBlckFkbWluIiwibG9jYWwtdXNlciIsInVtYV9hdXRob3JpemF0aW9uIiwiZGVmYXVsdC1yb2xlcy12b2NhYnVsYXJ5LnNlbWFudGljLXdlYi5hdCJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIGVtYWlsIHByb2ZpbGUiLCJzaWQiOiIzODA1M2YzYS1lZTA5LTRhOGEtYjdkNi0zZDI2MzI2NjY0YWEiLCJpcmkiOiJodHRwOi8vcmVzb3VyY2Uuc2VtYW50aWMtd2ViLmF0L3VzZXIvbGFrb21jaWtvdmFyIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsInVpTGFuZ3VhZ2UiOiJlbiIsImRpc3BsYXlMYW5ndWFnZXMiOlsiIl0sInNrb3NWaWV3IjoiQkFTSUNTS09TVklFVyIsIm5hbWUiOiJSb21hbmEgTGFrb21jaWtvdmEiLCJncm91cHMiOlsiL0NvY2t0YWlscyIsIi9QdWJsaWMiLCIvU1dDIl0sInRpbWVab25lIjoiRXVyb3BlL1ZpZW5uYSIsInByZWZlcnJlZF91c2VybmFtZSI6Imxha29tY2lrb3ZhciIsImdpdmVuX25hbWUiOiJSb21hbmEiLCJhY0xhbmd1YWdlIjoiZW4iLCJmYW1pbHlfbmFtZSI6Ikxha29tY2lrb3ZhIn0.ZMbxrFVL426M8zAXKf6iGnpZLuisTFO7gQeifejy2aldfFjWCDpdlDL1QfwMve1-AI6mRe6C4KJoRUrguxIYDOdBk5fzqyRgBXSPeSPWXv7wUGvtXTyn2BXYuClXhQO8bFeAkx235Umo9nhrAuxf2pyRqLeTxeSuEcfUh6hGXhXJHFUhhihHYNoYrcgGJ2UkVU9Zwq4oDK5m-7KZoOAwFdaM4Ri5B3tMTgym72Y-aNTZVLzLbFKfcSj3pepWr8URYoJT-x5BKD_wpXS7g3AHPtf9I0l0N-8RXLHn9w5xWVHn4G0P0BDjXXtJb1s6ifpUKR7bfJsXhfeYxnWavMvHUA' \
--data '{
"config": {...
},
"created": "2023-08-04T08:09:42.889Z",
"id": 1,
"user": "ppil"
}'
{
"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": true,
"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": true,
"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": true,
"showRecommendations": false,
"recommender": "",
"numberOfRecommendations": 4,
"numberOfSimilar": 4,
"showRecommendedAsImage": false,
"showConceptHighlighting": false
}
}
}
Responses
Status | Meaning | Description |
|---|---|---|
200 | Update an existing ADF configuration | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
{
"message": "Successfully updated configuration \"Wine Cheese Vocabulary\".",
"config": {
"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": true,
"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": true,
"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": true,
"showRecommendations": false,
"recommender": "",
"numberOfRecommendations": 4,
"numberOfSimilar": 4,
"showRecommendedAsImage": false,
"showConceptHighlighting": false
}
}
},
"errors": []
}Name | Type | Description |
|---|---|---|
message | string | A message informing on the success of the operation. |
config | object | An object with the settings and metadata of the updated configuration. |
errors | array | An array of objects, each representing a single resource key update of which failed. |
» key | string | The resource key the update of which failed. |
» message | string | A message informing about the reasons why the update failed. |
In this section: