Overview
HTTP Methods
This REST API adheres to standard HTTP and REST conventions in the usage of HTTP methods.
| Method | Usage |
|---|---|
|
Used to retrieve a resource |
|
Used to create and update a resource |
|
Used to delete an existing resource |
HTTP Status Codes
This REST API adheres to standard HTTP and REST conventions in the usage of HTTP status codes.
| Status Code | Usage |
|---|---|
|
The request completed successfully. |
|
The request could not be completed due to a conflict. |
|
The request was malformed. The response body includes an error providing further information. |
|
The requested resource did not exist. |
CSRF
In order to prevent Cross-Site Request Forgery (CSRF), the SAP Analytics Hub provides a standard security mechanism based on a CSRF token.
Every POST or DELETE request should provide an X-CSRF-Token header that is associated with the HTTP session.
To get this token, call any GET endpoint (e.g. /hub/api/v1/profile) with X-CSRF-Token: Fetch.
SAP Analytics Hub API
This API exposes services that allow you to create the elements of the structure of the hub.
-
Creating a global list of values
-
Creating global fields
-
Creating global fields based on a list of values
-
Creating an asset type
-
Creating fields associated to an asset type
-
Creating fields based on a list of values associated to an asset type
-
Creating layouts used to display an asset type
-
Creating tags
-
Managing the facet order
Editing the SAP Analytics Hub Structure
You can define and update the structure of the hub through the following entry point:
-
/hub/api/v1/structure
Create a new asset type
A POST request is used to create a new asset type.
By default, three fields are automatically associated to the new asset type (Title, Description, and Short Description).
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The title of the asset type |
|
|
The description of the asset type |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset type |
|
|
The title of the asset type |
|
|
The description of the asset type |
|
|
The different localized titles of the asset type |
|
|
The different localized descriptions of the asset type |
|
|
The fields of the asset type |
|
|
The LOV fields of the asset type |
|
|
The list of layouts of the asset type |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"title" : "My structure name",
"description" : "Description of my structure"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 13098
{
"id" : 1,
"title" : "My structure name",
"description" : "Description of my structure",
"fields" : [ {
"id" : 1,
"field" : {
"id" : 1,
"multi" : false,
"type" : "string",
"title" : "Title",
"description" : "The name of an asset",
"isCore" : true,
"coreId" : 1,
"titles" : [ {
"languageId" : 1,
"title" : "Titulek"
}, {
"languageId" : 2,
"title" : "Title"
}, {
"languageId" : 3,
"title" : "Titel"
}, {
"languageId" : 4,
"title" : "Título"
}, {
"languageId" : 5,
"title" : "Titre"
}, {
"languageId" : 6,
"title" : "Megnevezés"
}, {
"languageId" : 7,
"title" : "Titolo"
}, {
"languageId" : 8,
"title" : "タイトル"
}, {
"languageId" : 9,
"title" : "제목"
}, {
"languageId" : 10,
"title" : "Tytuł"
}, {
"languageId" : 11,
"title" : "Título"
}, {
"languageId" : 12,
"title" : "Заголовок"
}, {
"languageId" : 13,
"title" : "Nadpis"
}, {
"languageId" : 14,
"title" : "标题"
}, {
"languageId" : 15,
"title" : "標題"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Název assetu"
}, {
"languageId" : 2,
"title" : "The name of an asset"
}, {
"languageId" : 3,
"title" : "Name des Assets"
}, {
"languageId" : 4,
"title" : "Nombre de un asset"
}, {
"languageId" : 5,
"title" : "Nom d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset neve"
}, {
"languageId" : 7,
"title" : "Nome di un asset"
}, {
"languageId" : 8,
"title" : "アセットの名前"
}, {
"languageId" : 9,
"title" : "Asset 이름"
}, {
"languageId" : 10,
"title" : "Nazwa zasobu"
}, {
"languageId" : 11,
"title" : "Nome de um asset"
}, {
"languageId" : 12,
"title" : "Имя Asset"
}, {
"languageId" : 13,
"title" : "Názov assetu"
}, {
"languageId" : 14,
"title" : "Asset 的名称"
}, {
"languageId" : 15,
"title" : "Asset 名稱"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : true
}, {
"id" : 2,
"field" : {
"id" : 2,
"multi" : false,
"type" : "string",
"title" : "Description",
"description" : "The description of an asset",
"isCore" : true,
"coreId" : 2,
"titles" : [ {
"languageId" : 1,
"title" : "Popis"
}, {
"languageId" : 2,
"title" : "Description"
}, {
"languageId" : 3,
"title" : "Beschreibung"
}, {
"languageId" : 4,
"title" : "Descripción"
}, {
"languageId" : 5,
"title" : "Description"
}, {
"languageId" : 6,
"title" : "Leírás"
}, {
"languageId" : 7,
"title" : "Descrizione"
}, {
"languageId" : 8,
"title" : "説明"
}, {
"languageId" : 9,
"title" : "내역"
}, {
"languageId" : 10,
"title" : "Opis"
}, {
"languageId" : 11,
"title" : "Descrição"
}, {
"languageId" : 12,
"title" : "Описание"
}, {
"languageId" : 13,
"title" : "Popis"
}, {
"languageId" : 14,
"title" : "描述"
}, {
"languageId" : 15,
"title" : "說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Popis assetu"
}, {
"languageId" : 2,
"title" : "The description of an asset"
}, {
"languageId" : 3,
"title" : "Beschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción de un asset"
}, {
"languageId" : 5,
"title" : "Description d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset leírása"
}, {
"languageId" : 7,
"title" : "Descrizione di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明"
}, {
"languageId" : 9,
"title" : "Asset 내역"
}, {
"languageId" : 10,
"title" : "Opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição de um asset"
}, {
"languageId" : 12,
"title" : "Описание Asset"
}, {
"languageId" : 13,
"title" : "Popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的描述"
}, {
"languageId" : 15,
"title" : "Asset 說明"
} ]
},
"tileVisible" : false,
"searchable" : false,
"sortable" : false
}, {
"id" : 3,
"field" : {
"id" : 3,
"multi" : false,
"type" : "string",
"title" : "Short Description",
"description" : "The short description of an asset",
"isCore" : true,
"coreId" : 3,
"titles" : [ {
"languageId" : 1,
"title" : "Krátký popis"
}, {
"languageId" : 2,
"title" : "Short Description"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung"
}, {
"languageId" : 4,
"title" : "Descripción breve"
}, {
"languageId" : 5,
"title" : "Description synthétique"
}, {
"languageId" : 6,
"title" : "Rövid leírás"
}, {
"languageId" : 7,
"title" : "Descrizione breve"
}, {
"languageId" : 8,
"title" : "説明 (短)"
}, {
"languageId" : 9,
"title" : "간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis"
}, {
"languageId" : 11,
"title" : "Descrição breve"
}, {
"languageId" : 12,
"title" : "Краткое описание"
}, {
"languageId" : 13,
"title" : "Krátky popis"
}, {
"languageId" : 14,
"title" : "简短描述"
}, {
"languageId" : 15,
"title" : "簡短說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Krátký popis assetu"
}, {
"languageId" : 2,
"title" : "The short description of an asset"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción breve de un asset"
}, {
"languageId" : 5,
"title" : "Description synthétique d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset rövid leírása"
}, {
"languageId" : 7,
"title" : "Descrizione breve di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明 (短)"
}, {
"languageId" : 9,
"title" : "Asset에 대한 간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição breve de um asset"
}, {
"languageId" : 12,
"title" : "Краткое описание Asset"
}, {
"languageId" : 13,
"title" : "Krátky popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的简短描述"
}, {
"languageId" : 15,
"title" : "Asset 簡短說明"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : false
}, {
"id" : 4,
"field" : {
"id" : 4,
"multi" : false,
"type" : "string",
"title" : "Hidden tags",
"description" : "The hidden tags of an asset",
"isCore" : true,
"coreId" : 4,
"titles" : [ {
"languageId" : 1,
"title" : "Skryté tagy"
}, {
"languageId" : 2,
"title" : "Hidden tags"
}, {
"languageId" : 3,
"title" : "Ausgeblendete Tags"
}, {
"languageId" : 4,
"title" : "Etiquetas ocultas"
}, {
"languageId" : 5,
"title" : "Tags masqués"
}, {
"languageId" : 6,
"title" : "Rejtett címkék"
}, {
"languageId" : 7,
"title" : "Tag nascosti"
}, {
"languageId" : 8,
"title" : "非表示タグ"
}, {
"languageId" : 9,
"title" : "숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki"
}, {
"languageId" : 11,
"title" : "Tags ocultas"
}, {
"languageId" : 12,
"title" : "Скрытые теги"
}, {
"languageId" : 13,
"title" : "Skryté značky"
}, {
"languageId" : 14,
"title" : "隐藏标签"
}, {
"languageId" : 15,
"title" : "隱藏標籤"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Skryté tagy assetu"
}, {
"languageId" : 2,
"title" : "The hidden tags of an asset"
}, {
"languageId" : 3,
"title" : "Die ausgeblendeten Tags eines Assets"
}, {
"languageId" : 4,
"title" : "Las etiquetas ocultas de un asset"
}, {
"languageId" : 5,
"title" : "Les tags masqués d'un asset."
}, {
"languageId" : 6,
"title" : "Az asset rejtett címkéi"
}, {
"languageId" : 7,
"title" : "Tag nascosti di un asset"
}, {
"languageId" : 8,
"title" : "アセットの非表示タグ"
}, {
"languageId" : 9,
"title" : "Asset의 숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki zasobu"
}, {
"languageId" : 11,
"title" : "As tags ocultas de um asset"
}, {
"languageId" : 12,
"title" : "Скрытые теги Asset"
}, {
"languageId" : 13,
"title" : "Skryté značky assetu"
}, {
"languageId" : 14,
"title" : "隐藏的 Asset 标签"
}, {
"languageId" : 15,
"title" : "Asset 的隱藏標籤"
} ]
},
"tileVisible" : false,
"searchable" : true,
"sortable" : false
} ],
"lovFields" : [ ],
"layouts" : [ {
"id" : 3,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "NO_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 4,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "BIG_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 5,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "SMALL_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 6,
"type" : "detail",
"assetType" : 1,
"content" : {
"title" : {
"id" : "4482d667-b12f-4ff0-87a5-b1c4b5038cfc",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "84b14320-5969-4485-93bb-c0e529fe7585",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
},
"sections" : [ {
"id" : "aa7cb52b-f6d2-42cc-a745-1d4e744bfc0f",
"title" : "Description",
"fields" : [ {
"id" : "4483a2b0-61dc-4ec7-a38d-29d9504a35ae",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 2
}
} ]
} ],
"overviewSideFields" : [ ]
}
} ],
"titles" : [ {
"languageId" : 2,
"title" : "My structure name"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Description of my structure"
} ]
}Update the name and the description of an asset type
A POST request updates the name and the description of an asset type.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The title of the asset type |
|
|
The description of the asset type |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset type |
|
|
The title of the asset type |
|
|
The description of the asset type |
|
|
The different localized titles of the asset type |
|
|
The different localized descriptions of the asset type |
|
|
The fields of the asset type |
|
|
The LOV fields of the asset type |
|
|
The list of layouts of the asset type |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"title" : "My structure name changed",
"description" : "Updated description of my structure"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 13130
{
"id" : 1,
"title" : "My structure name changed",
"description" : "Updated description of my structure",
"fields" : [ {
"id" : 1,
"field" : {
"id" : 1,
"multi" : false,
"type" : "string",
"title" : "Title",
"description" : "The name of an asset",
"isCore" : true,
"coreId" : 1,
"titles" : [ {
"languageId" : 1,
"title" : "Titulek"
}, {
"languageId" : 2,
"title" : "Title"
}, {
"languageId" : 3,
"title" : "Titel"
}, {
"languageId" : 4,
"title" : "Título"
}, {
"languageId" : 5,
"title" : "Titre"
}, {
"languageId" : 6,
"title" : "Megnevezés"
}, {
"languageId" : 7,
"title" : "Titolo"
}, {
"languageId" : 8,
"title" : "タイトル"
}, {
"languageId" : 9,
"title" : "제목"
}, {
"languageId" : 10,
"title" : "Tytuł"
}, {
"languageId" : 11,
"title" : "Título"
}, {
"languageId" : 12,
"title" : "Заголовок"
}, {
"languageId" : 13,
"title" : "Nadpis"
}, {
"languageId" : 14,
"title" : "标题"
}, {
"languageId" : 15,
"title" : "標題"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Název assetu"
}, {
"languageId" : 2,
"title" : "The name of an asset"
}, {
"languageId" : 3,
"title" : "Name des Assets"
}, {
"languageId" : 4,
"title" : "Nombre de un asset"
}, {
"languageId" : 5,
"title" : "Nom d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset neve"
}, {
"languageId" : 7,
"title" : "Nome di un asset"
}, {
"languageId" : 8,
"title" : "アセットの名前"
}, {
"languageId" : 9,
"title" : "Asset 이름"
}, {
"languageId" : 10,
"title" : "Nazwa zasobu"
}, {
"languageId" : 11,
"title" : "Nome de um asset"
}, {
"languageId" : 12,
"title" : "Имя Asset"
}, {
"languageId" : 13,
"title" : "Názov assetu"
}, {
"languageId" : 14,
"title" : "Asset 的名称"
}, {
"languageId" : 15,
"title" : "Asset 名稱"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : true
}, {
"id" : 2,
"field" : {
"id" : 2,
"multi" : false,
"type" : "string",
"title" : "Description",
"description" : "The description of an asset",
"isCore" : true,
"coreId" : 2,
"titles" : [ {
"languageId" : 1,
"title" : "Popis"
}, {
"languageId" : 2,
"title" : "Description"
}, {
"languageId" : 3,
"title" : "Beschreibung"
}, {
"languageId" : 4,
"title" : "Descripción"
}, {
"languageId" : 5,
"title" : "Description"
}, {
"languageId" : 6,
"title" : "Leírás"
}, {
"languageId" : 7,
"title" : "Descrizione"
}, {
"languageId" : 8,
"title" : "説明"
}, {
"languageId" : 9,
"title" : "내역"
}, {
"languageId" : 10,
"title" : "Opis"
}, {
"languageId" : 11,
"title" : "Descrição"
}, {
"languageId" : 12,
"title" : "Описание"
}, {
"languageId" : 13,
"title" : "Popis"
}, {
"languageId" : 14,
"title" : "描述"
}, {
"languageId" : 15,
"title" : "說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Popis assetu"
}, {
"languageId" : 2,
"title" : "The description of an asset"
}, {
"languageId" : 3,
"title" : "Beschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción de un asset"
}, {
"languageId" : 5,
"title" : "Description d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset leírása"
}, {
"languageId" : 7,
"title" : "Descrizione di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明"
}, {
"languageId" : 9,
"title" : "Asset 내역"
}, {
"languageId" : 10,
"title" : "Opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição de um asset"
}, {
"languageId" : 12,
"title" : "Описание Asset"
}, {
"languageId" : 13,
"title" : "Popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的描述"
}, {
"languageId" : 15,
"title" : "Asset 說明"
} ]
},
"tileVisible" : false,
"searchable" : false,
"sortable" : false
}, {
"id" : 3,
"field" : {
"id" : 3,
"multi" : false,
"type" : "string",
"title" : "Short Description",
"description" : "The short description of an asset",
"isCore" : true,
"coreId" : 3,
"titles" : [ {
"languageId" : 1,
"title" : "Krátký popis"
}, {
"languageId" : 2,
"title" : "Short Description"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung"
}, {
"languageId" : 4,
"title" : "Descripción breve"
}, {
"languageId" : 5,
"title" : "Description synthétique"
}, {
"languageId" : 6,
"title" : "Rövid leírás"
}, {
"languageId" : 7,
"title" : "Descrizione breve"
}, {
"languageId" : 8,
"title" : "説明 (短)"
}, {
"languageId" : 9,
"title" : "간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis"
}, {
"languageId" : 11,
"title" : "Descrição breve"
}, {
"languageId" : 12,
"title" : "Краткое описание"
}, {
"languageId" : 13,
"title" : "Krátky popis"
}, {
"languageId" : 14,
"title" : "简短描述"
}, {
"languageId" : 15,
"title" : "簡短說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Krátký popis assetu"
}, {
"languageId" : 2,
"title" : "The short description of an asset"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción breve de un asset"
}, {
"languageId" : 5,
"title" : "Description synthétique d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset rövid leírása"
}, {
"languageId" : 7,
"title" : "Descrizione breve di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明 (短)"
}, {
"languageId" : 9,
"title" : "Asset에 대한 간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição breve de um asset"
}, {
"languageId" : 12,
"title" : "Краткое описание Asset"
}, {
"languageId" : 13,
"title" : "Krátky popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的简短描述"
}, {
"languageId" : 15,
"title" : "Asset 簡短說明"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : false
}, {
"id" : 4,
"field" : {
"id" : 4,
"multi" : false,
"type" : "string",
"title" : "Hidden tags",
"description" : "The hidden tags of an asset",
"isCore" : true,
"coreId" : 4,
"titles" : [ {
"languageId" : 1,
"title" : "Skryté tagy"
}, {
"languageId" : 2,
"title" : "Hidden tags"
}, {
"languageId" : 3,
"title" : "Ausgeblendete Tags"
}, {
"languageId" : 4,
"title" : "Etiquetas ocultas"
}, {
"languageId" : 5,
"title" : "Tags masqués"
}, {
"languageId" : 6,
"title" : "Rejtett címkék"
}, {
"languageId" : 7,
"title" : "Tag nascosti"
}, {
"languageId" : 8,
"title" : "非表示タグ"
}, {
"languageId" : 9,
"title" : "숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki"
}, {
"languageId" : 11,
"title" : "Tags ocultas"
}, {
"languageId" : 12,
"title" : "Скрытые теги"
}, {
"languageId" : 13,
"title" : "Skryté značky"
}, {
"languageId" : 14,
"title" : "隐藏标签"
}, {
"languageId" : 15,
"title" : "隱藏標籤"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Skryté tagy assetu"
}, {
"languageId" : 2,
"title" : "The hidden tags of an asset"
}, {
"languageId" : 3,
"title" : "Die ausgeblendeten Tags eines Assets"
}, {
"languageId" : 4,
"title" : "Las etiquetas ocultas de un asset"
}, {
"languageId" : 5,
"title" : "Les tags masqués d'un asset."
}, {
"languageId" : 6,
"title" : "Az asset rejtett címkéi"
}, {
"languageId" : 7,
"title" : "Tag nascosti di un asset"
}, {
"languageId" : 8,
"title" : "アセットの非表示タグ"
}, {
"languageId" : 9,
"title" : "Asset의 숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki zasobu"
}, {
"languageId" : 11,
"title" : "As tags ocultas de um asset"
}, {
"languageId" : 12,
"title" : "Скрытые теги Asset"
}, {
"languageId" : 13,
"title" : "Skryté značky assetu"
}, {
"languageId" : 14,
"title" : "隐藏的 Asset 标签"
}, {
"languageId" : 15,
"title" : "Asset 的隱藏標籤"
} ]
},
"tileVisible" : false,
"searchable" : true,
"sortable" : false
} ],
"lovFields" : [ ],
"layouts" : [ {
"id" : 3,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "NO_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 4,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "BIG_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 5,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "SMALL_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 6,
"type" : "detail",
"assetType" : 1,
"content" : {
"title" : {
"id" : "4482d667-b12f-4ff0-87a5-b1c4b5038cfc",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "84b14320-5969-4485-93bb-c0e529fe7585",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
},
"sections" : [ {
"id" : "aa7cb52b-f6d2-42cc-a745-1d4e744bfc0f",
"title" : "Description",
"fields" : [ {
"id" : "4483a2b0-61dc-4ec7-a38d-29d9504a35ae",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 2
}
} ]
} ],
"overviewSideFields" : [ ]
}
} ],
"titles" : [ {
"languageId" : 2,
"title" : "My structure name changed"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Updated description of my structure"
} ]
}List all existing asset types
A GET request lists all the asset types.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The list of asset types |
|
|
The identifier of the asset type |
|
|
The title of the asset type |
|
|
The description of the asset type |
|
|
The different localized titles of the asset type |
|
|
The different localized descriptions of the asset type |
|
|
The fields of the asset type |
|
|
The LOV fields of the asset type |
|
|
The list of layouts of the asset type |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 13102
[ {
"id" : 1,
"title" : "My structure name",
"description" : "Description of my structure",
"fields" : [ {
"id" : 1,
"field" : {
"id" : 1,
"multi" : false,
"type" : "string",
"title" : "Title",
"description" : "The name of an asset",
"isCore" : true,
"coreId" : 1,
"titles" : [ {
"languageId" : 1,
"title" : "Titulek"
}, {
"languageId" : 2,
"title" : "Title"
}, {
"languageId" : 3,
"title" : "Titel"
}, {
"languageId" : 4,
"title" : "Título"
}, {
"languageId" : 5,
"title" : "Titre"
}, {
"languageId" : 6,
"title" : "Megnevezés"
}, {
"languageId" : 7,
"title" : "Titolo"
}, {
"languageId" : 8,
"title" : "タイトル"
}, {
"languageId" : 9,
"title" : "제목"
}, {
"languageId" : 10,
"title" : "Tytuł"
}, {
"languageId" : 11,
"title" : "Título"
}, {
"languageId" : 12,
"title" : "Заголовок"
}, {
"languageId" : 13,
"title" : "Nadpis"
}, {
"languageId" : 14,
"title" : "标题"
}, {
"languageId" : 15,
"title" : "標題"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Název assetu"
}, {
"languageId" : 2,
"title" : "The name of an asset"
}, {
"languageId" : 3,
"title" : "Name des Assets"
}, {
"languageId" : 4,
"title" : "Nombre de un asset"
}, {
"languageId" : 5,
"title" : "Nom d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset neve"
}, {
"languageId" : 7,
"title" : "Nome di un asset"
}, {
"languageId" : 8,
"title" : "アセットの名前"
}, {
"languageId" : 9,
"title" : "Asset 이름"
}, {
"languageId" : 10,
"title" : "Nazwa zasobu"
}, {
"languageId" : 11,
"title" : "Nome de um asset"
}, {
"languageId" : 12,
"title" : "Имя Asset"
}, {
"languageId" : 13,
"title" : "Názov assetu"
}, {
"languageId" : 14,
"title" : "Asset 的名称"
}, {
"languageId" : 15,
"title" : "Asset 名稱"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : true
}, {
"id" : 2,
"field" : {
"id" : 2,
"multi" : false,
"type" : "string",
"title" : "Description",
"description" : "The description of an asset",
"isCore" : true,
"coreId" : 2,
"titles" : [ {
"languageId" : 1,
"title" : "Popis"
}, {
"languageId" : 2,
"title" : "Description"
}, {
"languageId" : 3,
"title" : "Beschreibung"
}, {
"languageId" : 4,
"title" : "Descripción"
}, {
"languageId" : 5,
"title" : "Description"
}, {
"languageId" : 6,
"title" : "Leírás"
}, {
"languageId" : 7,
"title" : "Descrizione"
}, {
"languageId" : 8,
"title" : "説明"
}, {
"languageId" : 9,
"title" : "내역"
}, {
"languageId" : 10,
"title" : "Opis"
}, {
"languageId" : 11,
"title" : "Descrição"
}, {
"languageId" : 12,
"title" : "Описание"
}, {
"languageId" : 13,
"title" : "Popis"
}, {
"languageId" : 14,
"title" : "描述"
}, {
"languageId" : 15,
"title" : "說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Popis assetu"
}, {
"languageId" : 2,
"title" : "The description of an asset"
}, {
"languageId" : 3,
"title" : "Beschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción de un asset"
}, {
"languageId" : 5,
"title" : "Description d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset leírása"
}, {
"languageId" : 7,
"title" : "Descrizione di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明"
}, {
"languageId" : 9,
"title" : "Asset 내역"
}, {
"languageId" : 10,
"title" : "Opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição de um asset"
}, {
"languageId" : 12,
"title" : "Описание Asset"
}, {
"languageId" : 13,
"title" : "Popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的描述"
}, {
"languageId" : 15,
"title" : "Asset 說明"
} ]
},
"tileVisible" : false,
"searchable" : false,
"sortable" : false
}, {
"id" : 3,
"field" : {
"id" : 3,
"multi" : false,
"type" : "string",
"title" : "Short Description",
"description" : "The short description of an asset",
"isCore" : true,
"coreId" : 3,
"titles" : [ {
"languageId" : 1,
"title" : "Krátký popis"
}, {
"languageId" : 2,
"title" : "Short Description"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung"
}, {
"languageId" : 4,
"title" : "Descripción breve"
}, {
"languageId" : 5,
"title" : "Description synthétique"
}, {
"languageId" : 6,
"title" : "Rövid leírás"
}, {
"languageId" : 7,
"title" : "Descrizione breve"
}, {
"languageId" : 8,
"title" : "説明 (短)"
}, {
"languageId" : 9,
"title" : "간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis"
}, {
"languageId" : 11,
"title" : "Descrição breve"
}, {
"languageId" : 12,
"title" : "Краткое описание"
}, {
"languageId" : 13,
"title" : "Krátky popis"
}, {
"languageId" : 14,
"title" : "简短描述"
}, {
"languageId" : 15,
"title" : "簡短說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Krátký popis assetu"
}, {
"languageId" : 2,
"title" : "The short description of an asset"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción breve de un asset"
}, {
"languageId" : 5,
"title" : "Description synthétique d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset rövid leírása"
}, {
"languageId" : 7,
"title" : "Descrizione breve di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明 (短)"
}, {
"languageId" : 9,
"title" : "Asset에 대한 간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição breve de um asset"
}, {
"languageId" : 12,
"title" : "Краткое описание Asset"
}, {
"languageId" : 13,
"title" : "Krátky popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的简短描述"
}, {
"languageId" : 15,
"title" : "Asset 簡短說明"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : false
}, {
"id" : 4,
"field" : {
"id" : 4,
"multi" : false,
"type" : "string",
"title" : "Hidden tags",
"description" : "The hidden tags of an asset",
"isCore" : true,
"coreId" : 4,
"titles" : [ {
"languageId" : 1,
"title" : "Skryté tagy"
}, {
"languageId" : 2,
"title" : "Hidden tags"
}, {
"languageId" : 3,
"title" : "Ausgeblendete Tags"
}, {
"languageId" : 4,
"title" : "Etiquetas ocultas"
}, {
"languageId" : 5,
"title" : "Tags masqués"
}, {
"languageId" : 6,
"title" : "Rejtett címkék"
}, {
"languageId" : 7,
"title" : "Tag nascosti"
}, {
"languageId" : 8,
"title" : "非表示タグ"
}, {
"languageId" : 9,
"title" : "숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki"
}, {
"languageId" : 11,
"title" : "Tags ocultas"
}, {
"languageId" : 12,
"title" : "Скрытые теги"
}, {
"languageId" : 13,
"title" : "Skryté značky"
}, {
"languageId" : 14,
"title" : "隐藏标签"
}, {
"languageId" : 15,
"title" : "隱藏標籤"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Skryté tagy assetu"
}, {
"languageId" : 2,
"title" : "The hidden tags of an asset"
}, {
"languageId" : 3,
"title" : "Die ausgeblendeten Tags eines Assets"
}, {
"languageId" : 4,
"title" : "Las etiquetas ocultas de un asset"
}, {
"languageId" : 5,
"title" : "Les tags masqués d'un asset."
}, {
"languageId" : 6,
"title" : "Az asset rejtett címkéi"
}, {
"languageId" : 7,
"title" : "Tag nascosti di un asset"
}, {
"languageId" : 8,
"title" : "アセットの非表示タグ"
}, {
"languageId" : 9,
"title" : "Asset의 숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki zasobu"
}, {
"languageId" : 11,
"title" : "As tags ocultas de um asset"
}, {
"languageId" : 12,
"title" : "Скрытые теги Asset"
}, {
"languageId" : 13,
"title" : "Skryté značky assetu"
}, {
"languageId" : 14,
"title" : "隐藏的 Asset 标签"
}, {
"languageId" : 15,
"title" : "Asset 的隱藏標籤"
} ]
},
"tileVisible" : false,
"searchable" : true,
"sortable" : false
} ],
"lovFields" : [ ],
"layouts" : [ {
"id" : 3,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "NO_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 4,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "BIG_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 5,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "SMALL_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 6,
"type" : "detail",
"assetType" : 1,
"content" : {
"title" : {
"id" : "4482d667-b12f-4ff0-87a5-b1c4b5038cfc",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "84b14320-5969-4485-93bb-c0e529fe7585",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
},
"sections" : [ {
"id" : "aa7cb52b-f6d2-42cc-a745-1d4e744bfc0f",
"title" : "Description",
"fields" : [ {
"id" : "4483a2b0-61dc-4ec7-a38d-29d9504a35ae",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 2
}
} ]
} ],
"overviewSideFields" : [ ]
}
} ],
"titles" : [ {
"languageId" : 2,
"title" : "My structure name"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Description of my structure"
} ]
} ]Retrieve an asset type
A GET request fetches a specific asset type.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset type |
|
|
The title of the asset type |
|
|
The description of the asset type |
|
|
The different localized titles of the asset type |
|
|
The different localized descriptions of the asset type |
|
|
The fields of the asset type |
|
|
The LOV fields of the asset type |
|
|
The list of layouts of the asset type |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 13098
{
"id" : 1,
"title" : "My structure name",
"description" : "Description of my structure",
"fields" : [ {
"id" : 1,
"field" : {
"id" : 1,
"multi" : false,
"type" : "string",
"title" : "Title",
"description" : "The name of an asset",
"isCore" : true,
"coreId" : 1,
"titles" : [ {
"languageId" : 1,
"title" : "Titulek"
}, {
"languageId" : 2,
"title" : "Title"
}, {
"languageId" : 3,
"title" : "Titel"
}, {
"languageId" : 4,
"title" : "Título"
}, {
"languageId" : 5,
"title" : "Titre"
}, {
"languageId" : 6,
"title" : "Megnevezés"
}, {
"languageId" : 7,
"title" : "Titolo"
}, {
"languageId" : 8,
"title" : "タイトル"
}, {
"languageId" : 9,
"title" : "제목"
}, {
"languageId" : 10,
"title" : "Tytuł"
}, {
"languageId" : 11,
"title" : "Título"
}, {
"languageId" : 12,
"title" : "Заголовок"
}, {
"languageId" : 13,
"title" : "Nadpis"
}, {
"languageId" : 14,
"title" : "标题"
}, {
"languageId" : 15,
"title" : "標題"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Název assetu"
}, {
"languageId" : 2,
"title" : "The name of an asset"
}, {
"languageId" : 3,
"title" : "Name des Assets"
}, {
"languageId" : 4,
"title" : "Nombre de un asset"
}, {
"languageId" : 5,
"title" : "Nom d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset neve"
}, {
"languageId" : 7,
"title" : "Nome di un asset"
}, {
"languageId" : 8,
"title" : "アセットの名前"
}, {
"languageId" : 9,
"title" : "Asset 이름"
}, {
"languageId" : 10,
"title" : "Nazwa zasobu"
}, {
"languageId" : 11,
"title" : "Nome de um asset"
}, {
"languageId" : 12,
"title" : "Имя Asset"
}, {
"languageId" : 13,
"title" : "Názov assetu"
}, {
"languageId" : 14,
"title" : "Asset 的名称"
}, {
"languageId" : 15,
"title" : "Asset 名稱"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : true
}, {
"id" : 2,
"field" : {
"id" : 2,
"multi" : false,
"type" : "string",
"title" : "Description",
"description" : "The description of an asset",
"isCore" : true,
"coreId" : 2,
"titles" : [ {
"languageId" : 1,
"title" : "Popis"
}, {
"languageId" : 2,
"title" : "Description"
}, {
"languageId" : 3,
"title" : "Beschreibung"
}, {
"languageId" : 4,
"title" : "Descripción"
}, {
"languageId" : 5,
"title" : "Description"
}, {
"languageId" : 6,
"title" : "Leírás"
}, {
"languageId" : 7,
"title" : "Descrizione"
}, {
"languageId" : 8,
"title" : "説明"
}, {
"languageId" : 9,
"title" : "내역"
}, {
"languageId" : 10,
"title" : "Opis"
}, {
"languageId" : 11,
"title" : "Descrição"
}, {
"languageId" : 12,
"title" : "Описание"
}, {
"languageId" : 13,
"title" : "Popis"
}, {
"languageId" : 14,
"title" : "描述"
}, {
"languageId" : 15,
"title" : "說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Popis assetu"
}, {
"languageId" : 2,
"title" : "The description of an asset"
}, {
"languageId" : 3,
"title" : "Beschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción de un asset"
}, {
"languageId" : 5,
"title" : "Description d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset leírása"
}, {
"languageId" : 7,
"title" : "Descrizione di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明"
}, {
"languageId" : 9,
"title" : "Asset 내역"
}, {
"languageId" : 10,
"title" : "Opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição de um asset"
}, {
"languageId" : 12,
"title" : "Описание Asset"
}, {
"languageId" : 13,
"title" : "Popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的描述"
}, {
"languageId" : 15,
"title" : "Asset 說明"
} ]
},
"tileVisible" : false,
"searchable" : false,
"sortable" : false
}, {
"id" : 3,
"field" : {
"id" : 3,
"multi" : false,
"type" : "string",
"title" : "Short Description",
"description" : "The short description of an asset",
"isCore" : true,
"coreId" : 3,
"titles" : [ {
"languageId" : 1,
"title" : "Krátký popis"
}, {
"languageId" : 2,
"title" : "Short Description"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung"
}, {
"languageId" : 4,
"title" : "Descripción breve"
}, {
"languageId" : 5,
"title" : "Description synthétique"
}, {
"languageId" : 6,
"title" : "Rövid leírás"
}, {
"languageId" : 7,
"title" : "Descrizione breve"
}, {
"languageId" : 8,
"title" : "説明 (短)"
}, {
"languageId" : 9,
"title" : "간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis"
}, {
"languageId" : 11,
"title" : "Descrição breve"
}, {
"languageId" : 12,
"title" : "Краткое описание"
}, {
"languageId" : 13,
"title" : "Krátky popis"
}, {
"languageId" : 14,
"title" : "简短描述"
}, {
"languageId" : 15,
"title" : "簡短說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Krátký popis assetu"
}, {
"languageId" : 2,
"title" : "The short description of an asset"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción breve de un asset"
}, {
"languageId" : 5,
"title" : "Description synthétique d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset rövid leírása"
}, {
"languageId" : 7,
"title" : "Descrizione breve di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明 (短)"
}, {
"languageId" : 9,
"title" : "Asset에 대한 간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição breve de um asset"
}, {
"languageId" : 12,
"title" : "Краткое описание Asset"
}, {
"languageId" : 13,
"title" : "Krátky popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的简短描述"
}, {
"languageId" : 15,
"title" : "Asset 簡短說明"
} ]
},
"tileVisible" : true,
"searchable" : true,
"sortable" : false
}, {
"id" : 4,
"field" : {
"id" : 4,
"multi" : false,
"type" : "string",
"title" : "Hidden tags",
"description" : "The hidden tags of an asset",
"isCore" : true,
"coreId" : 4,
"titles" : [ {
"languageId" : 1,
"title" : "Skryté tagy"
}, {
"languageId" : 2,
"title" : "Hidden tags"
}, {
"languageId" : 3,
"title" : "Ausgeblendete Tags"
}, {
"languageId" : 4,
"title" : "Etiquetas ocultas"
}, {
"languageId" : 5,
"title" : "Tags masqués"
}, {
"languageId" : 6,
"title" : "Rejtett címkék"
}, {
"languageId" : 7,
"title" : "Tag nascosti"
}, {
"languageId" : 8,
"title" : "非表示タグ"
}, {
"languageId" : 9,
"title" : "숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki"
}, {
"languageId" : 11,
"title" : "Tags ocultas"
}, {
"languageId" : 12,
"title" : "Скрытые теги"
}, {
"languageId" : 13,
"title" : "Skryté značky"
}, {
"languageId" : 14,
"title" : "隐藏标签"
}, {
"languageId" : 15,
"title" : "隱藏標籤"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Skryté tagy assetu"
}, {
"languageId" : 2,
"title" : "The hidden tags of an asset"
}, {
"languageId" : 3,
"title" : "Die ausgeblendeten Tags eines Assets"
}, {
"languageId" : 4,
"title" : "Las etiquetas ocultas de un asset"
}, {
"languageId" : 5,
"title" : "Les tags masqués d'un asset."
}, {
"languageId" : 6,
"title" : "Az asset rejtett címkéi"
}, {
"languageId" : 7,
"title" : "Tag nascosti di un asset"
}, {
"languageId" : 8,
"title" : "アセットの非表示タグ"
}, {
"languageId" : 9,
"title" : "Asset의 숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki zasobu"
}, {
"languageId" : 11,
"title" : "As tags ocultas de um asset"
}, {
"languageId" : 12,
"title" : "Скрытые теги Asset"
}, {
"languageId" : 13,
"title" : "Skryté značky assetu"
}, {
"languageId" : 14,
"title" : "隐藏的 Asset 标签"
}, {
"languageId" : 15,
"title" : "Asset 的隱藏標籤"
} ]
},
"tileVisible" : false,
"searchable" : true,
"sortable" : false
} ],
"lovFields" : [ ],
"layouts" : [ {
"id" : 3,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "NO_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 4,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "BIG_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 5,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "SMALL_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 6,
"type" : "detail",
"assetType" : 1,
"content" : {
"title" : {
"id" : "4482d667-b12f-4ff0-87a5-b1c4b5038cfc",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "84b14320-5969-4485-93bb-c0e529fe7585",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
},
"sections" : [ {
"id" : "aa7cb52b-f6d2-42cc-a745-1d4e744bfc0f",
"title" : "Description",
"fields" : [ {
"id" : "4483a2b0-61dc-4ec7-a38d-29d9504a35ae",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 2
}
} ]
} ],
"overviewSideFields" : [ ]
}
} ],
"titles" : [ {
"languageId" : 2,
"title" : "My structure name"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Description of my structure"
} ]
}Delete an asset type
A DELETE request deletes a specific asset type.
Request parameter
-
force: False by default. If true, all assets based on this asset type are also deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset type |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 1
}Create a new global field
A POST request creates a global field.
A global field is available for all asset types composing the SAP Analytics Hub.
An asset field must then be created to bind the global field to a specific asset type.
Available field types are: string | integer | boolean | date | link | user
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The field title |
|
|
The field description |
|
|
The field data type |
|
|
True if the field is multi-valued, false otherwise. |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The field identifier |
|
|
The field title |
|
|
The field description |
|
|
The different localized field titles |
|
|
The different localized field descriptions |
|
|
The field data type |
|
|
True if the field is multi-valued, false otherwise. |
|
|
True if the field is a core field, false otherwise. |
|
|
If the field is a core field, the core field’s ID. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/field' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"multi" : false,
"type" : "string",
"title" : "A new field",
"description" : "Description of the new field"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 338
{
"id" : 5,
"multi" : false,
"type" : "string",
"title" : "A new field",
"description" : "Description of the new field",
"isCore" : false,
"coreId" : 0,
"titles" : [ {
"languageId" : 2,
"title" : "A new field"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Description of the new field"
} ]
}Update a global field
A POST request updates a global field.
Request parameter
-
force: False by default. If true, all asset field values are deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The field identifier |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The field title |
|
|
The field description |
|
|
True if the field is multi-valued, false otherwise. |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The field identifier |
|
|
The field title |
|
|
The field description |
|
|
The different localized field titles |
|
|
The different localized field descriptions |
|
|
The field data type |
|
|
True if the field is multi-valued, false otherwise. |
|
|
True if the field is a core field, false otherwise. |
|
|
If the field is a core field, the core field’s ID. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/field/5' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"multi" : false,
"title" : "A new field name changed",
"description" : "Updated description of the field"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 372
{
"id" : 5,
"multi" : false,
"type" : "string",
"title" : "A new field name changed",
"description" : "Updated description of the field",
"isCore" : false,
"coreId" : 0,
"titles" : [ {
"languageId" : 2,
"title" : "A new field name changed"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Updated description of the field"
} ]
}List all existing global fields
A GET request lists all of the global fields.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The list of fields |
|
|
The field identifier |
|
|
The field title |
|
|
The field description |
|
|
The different localized field titles |
|
|
The different localized field descriptions |
|
|
The field data type |
|
|
True if the field is multi-valued, false otherwise. |
|
|
True if the field is a core field, false otherwise. |
|
|
If the field is a core field, the core field’s ID. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/field' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 8740
[ {
"id" : 1,
"multi" : false,
"type" : "string",
"title" : "Title",
"description" : "The name of an asset",
"isCore" : true,
"coreId" : 1,
"titles" : [ {
"languageId" : 1,
"title" : "Titulek"
}, {
"languageId" : 2,
"title" : "Title"
}, {
"languageId" : 3,
"title" : "Titel"
}, {
"languageId" : 4,
"title" : "Título"
}, {
"languageId" : 5,
"title" : "Titre"
}, {
"languageId" : 6,
"title" : "Megnevezés"
}, {
"languageId" : 7,
"title" : "Titolo"
}, {
"languageId" : 8,
"title" : "タイトル"
}, {
"languageId" : 9,
"title" : "제목"
}, {
"languageId" : 10,
"title" : "Tytuł"
}, {
"languageId" : 11,
"title" : "Título"
}, {
"languageId" : 12,
"title" : "Заголовок"
}, {
"languageId" : 13,
"title" : "Nadpis"
}, {
"languageId" : 14,
"title" : "标题"
}, {
"languageId" : 15,
"title" : "標題"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Název assetu"
}, {
"languageId" : 2,
"title" : "The name of an asset"
}, {
"languageId" : 3,
"title" : "Name des Assets"
}, {
"languageId" : 4,
"title" : "Nombre de un asset"
}, {
"languageId" : 5,
"title" : "Nom d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset neve"
}, {
"languageId" : 7,
"title" : "Nome di un asset"
}, {
"languageId" : 8,
"title" : "アセットの名前"
}, {
"languageId" : 9,
"title" : "Asset 이름"
}, {
"languageId" : 10,
"title" : "Nazwa zasobu"
}, {
"languageId" : 11,
"title" : "Nome de um asset"
}, {
"languageId" : 12,
"title" : "Имя Asset"
}, {
"languageId" : 13,
"title" : "Názov assetu"
}, {
"languageId" : 14,
"title" : "Asset 的名称"
}, {
"languageId" : 15,
"title" : "Asset 名稱"
} ]
}, {
"id" : 2,
"multi" : false,
"type" : "string",
"title" : "Description",
"description" : "The description of an asset",
"isCore" : true,
"coreId" : 2,
"titles" : [ {
"languageId" : 1,
"title" : "Popis"
}, {
"languageId" : 2,
"title" : "Description"
}, {
"languageId" : 3,
"title" : "Beschreibung"
}, {
"languageId" : 4,
"title" : "Descripción"
}, {
"languageId" : 5,
"title" : "Description"
}, {
"languageId" : 6,
"title" : "Leírás"
}, {
"languageId" : 7,
"title" : "Descrizione"
}, {
"languageId" : 8,
"title" : "説明"
}, {
"languageId" : 9,
"title" : "내역"
}, {
"languageId" : 10,
"title" : "Opis"
}, {
"languageId" : 11,
"title" : "Descrição"
}, {
"languageId" : 12,
"title" : "Описание"
}, {
"languageId" : 13,
"title" : "Popis"
}, {
"languageId" : 14,
"title" : "描述"
}, {
"languageId" : 15,
"title" : "說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Popis assetu"
}, {
"languageId" : 2,
"title" : "The description of an asset"
}, {
"languageId" : 3,
"title" : "Beschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción de un asset"
}, {
"languageId" : 5,
"title" : "Description d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset leírása"
}, {
"languageId" : 7,
"title" : "Descrizione di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明"
}, {
"languageId" : 9,
"title" : "Asset 내역"
}, {
"languageId" : 10,
"title" : "Opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição de um asset"
}, {
"languageId" : 12,
"title" : "Описание Asset"
}, {
"languageId" : 13,
"title" : "Popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的描述"
}, {
"languageId" : 15,
"title" : "Asset 說明"
} ]
}, {
"id" : 3,
"multi" : false,
"type" : "string",
"title" : "Short Description",
"description" : "The short description of an asset",
"isCore" : true,
"coreId" : 3,
"titles" : [ {
"languageId" : 1,
"title" : "Krátký popis"
}, {
"languageId" : 2,
"title" : "Short Description"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung"
}, {
"languageId" : 4,
"title" : "Descripción breve"
}, {
"languageId" : 5,
"title" : "Description synthétique"
}, {
"languageId" : 6,
"title" : "Rövid leírás"
}, {
"languageId" : 7,
"title" : "Descrizione breve"
}, {
"languageId" : 8,
"title" : "説明 (短)"
}, {
"languageId" : 9,
"title" : "간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis"
}, {
"languageId" : 11,
"title" : "Descrição breve"
}, {
"languageId" : 12,
"title" : "Краткое описание"
}, {
"languageId" : 13,
"title" : "Krátky popis"
}, {
"languageId" : 14,
"title" : "简短描述"
}, {
"languageId" : 15,
"title" : "簡短說明"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Krátký popis assetu"
}, {
"languageId" : 2,
"title" : "The short description of an asset"
}, {
"languageId" : 3,
"title" : "Kurzbeschreibung des Assets"
}, {
"languageId" : 4,
"title" : "Descripción breve de un asset"
}, {
"languageId" : 5,
"title" : "Description synthétique d'un asset"
}, {
"languageId" : 6,
"title" : "Az asset rövid leírása"
}, {
"languageId" : 7,
"title" : "Descrizione breve di un asset"
}, {
"languageId" : 8,
"title" : "アセットの説明 (短)"
}, {
"languageId" : 9,
"title" : "Asset에 대한 간단한 설명"
}, {
"languageId" : 10,
"title" : "Krótki opis zasobu"
}, {
"languageId" : 11,
"title" : "Descrição breve de um asset"
}, {
"languageId" : 12,
"title" : "Краткое описание Asset"
}, {
"languageId" : 13,
"title" : "Krátky popis assetu"
}, {
"languageId" : 14,
"title" : "Asset 的简短描述"
}, {
"languageId" : 15,
"title" : "Asset 簡短說明"
} ]
}, {
"id" : 4,
"multi" : false,
"type" : "string",
"title" : "Hidden tags",
"description" : "The hidden tags of an asset",
"isCore" : true,
"coreId" : 4,
"titles" : [ {
"languageId" : 1,
"title" : "Skryté tagy"
}, {
"languageId" : 2,
"title" : "Hidden tags"
}, {
"languageId" : 3,
"title" : "Ausgeblendete Tags"
}, {
"languageId" : 4,
"title" : "Etiquetas ocultas"
}, {
"languageId" : 5,
"title" : "Tags masqués"
}, {
"languageId" : 6,
"title" : "Rejtett címkék"
}, {
"languageId" : 7,
"title" : "Tag nascosti"
}, {
"languageId" : 8,
"title" : "非表示タグ"
}, {
"languageId" : 9,
"title" : "숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki"
}, {
"languageId" : 11,
"title" : "Tags ocultas"
}, {
"languageId" : 12,
"title" : "Скрытые теги"
}, {
"languageId" : 13,
"title" : "Skryté značky"
}, {
"languageId" : 14,
"title" : "隐藏标签"
}, {
"languageId" : 15,
"title" : "隱藏標籤"
} ],
"descriptions" : [ {
"languageId" : 1,
"title" : "Skryté tagy assetu"
}, {
"languageId" : 2,
"title" : "The hidden tags of an asset"
}, {
"languageId" : 3,
"title" : "Die ausgeblendeten Tags eines Assets"
}, {
"languageId" : 4,
"title" : "Las etiquetas ocultas de un asset"
}, {
"languageId" : 5,
"title" : "Les tags masqués d'un asset."
}, {
"languageId" : 6,
"title" : "Az asset rejtett címkéi"
}, {
"languageId" : 7,
"title" : "Tag nascosti di un asset"
}, {
"languageId" : 8,
"title" : "アセットの非表示タグ"
}, {
"languageId" : 9,
"title" : "Asset의 숨겨진 태그"
}, {
"languageId" : 10,
"title" : "Ukryte znaczniki zasobu"
}, {
"languageId" : 11,
"title" : "As tags ocultas de um asset"
}, {
"languageId" : 12,
"title" : "Скрытые теги Asset"
}, {
"languageId" : 13,
"title" : "Skryté značky assetu"
}, {
"languageId" : 14,
"title" : "隐藏的 Asset 标签"
}, {
"languageId" : 15,
"title" : "Asset 的隱藏標籤"
} ]
}, {
"id" : 5,
"multi" : false,
"type" : "string",
"title" : "A new field",
"description" : "Description of the new field",
"isCore" : false,
"coreId" : 0,
"titles" : [ {
"languageId" : 2,
"title" : "A new field"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Description of the new field"
} ]
} ]Retrieve a global field
A GET request fetches a specific global field.
Path parameters
| Parameter | Description |
|---|---|
|
The field identifier |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The field identifier |
|
|
The field title |
|
|
The field description |
|
|
The different localized field titles |
|
|
The different localized field descriptions |
|
|
The field data type |
|
|
True if the field is multi-valued, false otherwise. |
|
|
True if the field is a core field, false otherwise. |
|
|
If the field is a core field, the core field’s ID. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/field/5' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 338
{
"id" : 5,
"multi" : false,
"type" : "string",
"title" : "A new field",
"description" : "Description of the new field",
"isCore" : false,
"coreId" : 0,
"titles" : [ {
"languageId" : 2,
"title" : "A new field"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Description of the new field"
} ]
}Delete a global field
A DELETE request deletes a specific global field.
Request parameter
-
force: False by default. If true, all asset fields based on this field are also deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The field identifier |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The field identifier |
Example request
$ curl '{server hostname}/hub/api/v1/structure/field/5' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 5
}Create a new asset field
A POST request creates a new asset field.
An asset field is used to bind a specific asset property to a global field.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The field identifier |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset field |
|
|
The field identifier |
|
|
The field data type |
|
|
True if the field is multi-valued, false otherwise. |
|
|
The field title |
|
|
The field description |
|
|
The different localized field titles |
|
|
The different localized field descriptions |
|
|
True if the field is a core field, false otherwise. |
|
|
If the field is a core field, the core field’s ID. |
|
|
True if the asset field is visible (displayed) in the tile |
|
|
True if the asset field can be searched |
|
|
True if the asset field can be sorted |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1/field' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"field" : {
"id" : 5
}
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 503
{
"id" : 5,
"field" : {
"id" : 5,
"multi" : false,
"type" : "string",
"title" : "A new field name changed",
"description" : "Updated description of the field",
"isCore" : false,
"coreId" : 0,
"titles" : [ {
"languageId" : 2,
"title" : "A new field name changed"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : "Updated description of the field"
} ]
},
"tileVisible" : false,
"searchable" : false,
"sortable" : false
}Delete an asset field
A DELETE request deletes a specific asset field.
Request parameter
-
force: False by default. If true, all asset field values based on this field are deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
|
The identifier of the asset field |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset field |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1/field/5' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 5
}Create a new list of values
A POST request creates a list of values.
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
If the parameter sortType is not in the request, it will be set to "occurrence" by default.
Since version 18.01
The sortType parameter allows to define the sort order applied for a list of values exposed through a facet.
-
occurrence: Values are ranked by the number of found occurrences
-
custom: Keep the order of the values defined in the list of values
If the parameter sortType is not in the request, it will be set to "occurrence" by default.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"title" : "New LOV",
"sortType" : "occurrence",
"values" : [ {
"title" : "A"
}, {
"title" : "B"
}, {
"title" : "C"
} ]
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 326
{
"id" : 1,
"title" : "New LOV",
"sortType" : "occurrence",
"values" : [ {
"id" : 1,
"title" : "A",
"values" : null,
"titles" : null
}, {
"id" : 2,
"title" : "B",
"values" : null,
"titles" : null
}, {
"id" : 3,
"title" : "C",
"values" : null,
"titles" : null
} ]
}Update the name and the sort type of a list of values
A POST request updates the name and the sort type of a list of values.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV title |
|
|
The LOV sort type (occurrence|custom) |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"title" : "New LOV name changed",
"sortType" : "custom"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 335
{
"id" : 1,
"title" : "New LOV name changed",
"sortType" : "custom",
"values" : [ {
"id" : 1,
"title" : "A",
"values" : null,
"titles" : null
}, {
"id" : 2,
"title" : "B",
"values" : null,
"titles" : null
}, {
"id" : 3,
"title" : "C",
"values" : null,
"titles" : null
} ]
}List all existing list of values
A GET request lists all the list of values.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The list of lists of values (LOV) |
|
|
The LOV identifier |
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 330
[ {
"id" : 1,
"title" : "New LOV",
"sortType" : "occurrence",
"values" : [ {
"id" : 1,
"title" : "A",
"values" : null,
"titles" : null
}, {
"id" : 2,
"title" : "B",
"values" : null,
"titles" : null
}, {
"id" : 3,
"title" : "C",
"values" : null,
"titles" : null
} ]
} ]Retrieve a list of values
A GET request fetches a specific list of values.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 326
{
"id" : 1,
"title" : "New LOV",
"sortType" : "occurrence",
"values" : [ {
"id" : 1,
"title" : "A",
"values" : null,
"titles" : null
}, {
"id" : 2,
"title" : "B",
"values" : null,
"titles" : null
}, {
"id" : 3,
"title" : "C",
"values" : null,
"titles" : null
} ]
}Insert new values into a specific list of values
A POST request creates the new values for a specific list of values.
The new values are inserted after the existing values of the updated list of values.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV values |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1/values' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"values" : [ {
"title" : "D"
} ]
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 416
{
"id" : 1,
"title" : "New LOV name changed",
"sortType" : "custom",
"values" : [ {
"id" : 1,
"title" : "A",
"values" : null,
"titles" : null
}, {
"id" : 2,
"title" : "B",
"values" : null,
"titles" : null
}, {
"id" : 3,
"title" : "C",
"values" : null,
"titles" : null
}, {
"id" : 4,
"title" : "D",
"values" : null,
"titles" : null
} ]
}Update an existing value of a specific list of values
A POST request updates a specific value.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
|
The identifier of a LOV value |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The title of a LOV value |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1/values/3' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"title" : "Updated C"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 424
{
"id" : 1,
"title" : "New LOV name changed",
"sortType" : "custom",
"values" : [ {
"id" : 1,
"title" : "A",
"values" : null,
"titles" : null
}, {
"id" : 2,
"title" : "B",
"values" : null,
"titles" : null
}, {
"id" : 3,
"title" : "Updated C",
"values" : null,
"titles" : null
}, {
"id" : 4,
"title" : "D",
"values" : null,
"titles" : null
} ]
}Update an existing LOV custom sort order
A POST request updates the custom sort order of an existing LOV.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV custom sort order |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
|
|
The LOV title |
|
|
The LOV values |
|
|
The LOV sort type (occurrence|custom) |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1/order' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"order" : [ 4, 3, 2, 1 ]
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 424
{
"id" : 1,
"title" : "New LOV name changed",
"sortType" : "custom",
"values" : [ {
"id" : 4,
"title" : "D",
"values" : null,
"titles" : null
}, {
"id" : 3,
"title" : "Updated C",
"values" : null,
"titles" : null
}, {
"id" : 2,
"title" : "B",
"values" : null,
"titles" : null
}, {
"id" : 1,
"title" : "A",
"values" : null,
"titles" : null
} ]
}Delete a value of a specific list of values
A DELETE request deletes a specific value.
Request parameter
-
force: False by default. If true, all asset lov field values based on this lov value are also deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
|
The identifier of a LOV value |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of a LOV value |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1/values/3' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 3
}Delete all values of a specific list of values
A DELETE request deletes all values.
Request parameter
-
force: False by default. If true, all asset lov field values based on the lov values are also deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1/values' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 1
}Delete a list of values
A DELETE request deletes a specific list of values.
Request parameter
-
force: False by default. If true, all lov fields, asset lov fields and asset lov field values based on this lov are also deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The LOV identifier |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The LOV identifier |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lov/1' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 1
}Create a new global lov field
A POST request creates a global lov field.
A global lov field is available for all asset types composing the SAP Analytics Hub.
An asset lov field must then be created to bind the global lov field to a specific asset type.
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The title of the LOV field |
|
|
The identifier of the referenced LOV |
|
|
True if the LOV field is multi-valued, false otherwise. |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the LOV Field |
|
|
The identifier of the referenced LOV |
|
|
The title of the LOV field |
|
|
The description of the LOV field |
|
|
The different localized titles of the LOV field |
|
|
The different localized descriptions of the LOV field |
|
|
True if the LOV field is multi-valued, false otherwise. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lovfield' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"lovId" : 1,
"multi" : false,
"title" : "A new LOV field"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 248
{
"id" : 1,
"lovId" : 1,
"multi" : false,
"title" : "A new LOV field",
"description" : "",
"titles" : [ {
"languageId" : 2,
"title" : "A new LOV field"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : ""
} ]
}Update a global lov field
A POST request updates a global lov field.
Request parameter
-
force: False by default. If true, all asset lov field values are deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the LOV Field |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The title of the LOV field |
|
|
True if the LOV field is multi-valued, false otherwise. |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the LOV Field |
|
|
The identifier of the referenced LOV |
|
|
The title of the LOV field |
|
|
The description of the LOV field |
|
|
The different localized titles of the LOV field |
|
|
The different localized descriptions of the LOV field |
|
|
True if the LOV field is multi-valued, false otherwise. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lovfield/1' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"multi" : false,
"title" : "A new LOV field name changed"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 274
{
"id" : 1,
"lovId" : 1,
"multi" : false,
"title" : "A new LOV field name changed",
"description" : "",
"titles" : [ {
"languageId" : 2,
"title" : "A new LOV field name changed"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : ""
} ]
}Listing all existing global lov fields
A GET request lists all of the global lov fields.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The list of LOV fields |
|
|
The identifier of the LOV Field |
|
|
The identifier of the referenced LOV |
|
|
The title of the LOV field |
|
|
The description of the LOV field |
|
|
The different localized titles of the LOV field |
|
|
The different localized descriptions of the LOV field |
|
|
True if the LOV field is multi-valued, false otherwise. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lovfield' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 252
[ {
"id" : 1,
"lovId" : 1,
"multi" : false,
"title" : "A new LOV field",
"description" : "",
"titles" : [ {
"languageId" : 2,
"title" : "A new LOV field"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : ""
} ]
} ]Retrieve a global lov field
A GET request fetches a specific global lov field.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the LOV Field |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the LOV Field |
|
|
The identifier of the referenced LOV |
|
|
The title of the LOV field |
|
|
The description of the LOV field |
|
|
The different localized titles of the LOV field |
|
|
The different localized descriptions of the LOV field |
|
|
True if the LOV field is multi-valued, false otherwise. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lovfield/1' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 248
{
"id" : 1,
"lovId" : 1,
"multi" : false,
"title" : "A new LOV field",
"description" : "",
"titles" : [ {
"languageId" : 2,
"title" : "A new LOV field"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : ""
} ]
}Delete a global lov field
A DELETE request deletes a specific global lov field.
Request parameter
-
force: False by default. If true, all asset fields and asset field values based on this lov field are also deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the LOV Field |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the LOV Field |
Example request
$ curl '{server hostname}/hub/api/v1/structure/lovfield/1' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 1
}Create a new asset lov field
A POST request creates a new asset lov field.
An asset lov field is used to bind a specific asset property to a global lov field.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the LOV Field |
|
|
True if the asset LOV field can be used as facet |
|
|
The sort type of the asset LOV field |
Only the title is mandatory. Default values apply to other properties.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset LOV field |
|
|
The identifier of the LOV Field |
|
|
The identifier of the referenced LOV |
|
|
The title of the LOV field |
|
|
The description of the LOV field |
|
|
The different localized titles of the LOV field |
|
|
The different localized descriptions of the LOV field |
|
|
True if the LOV field is multi-valued, false otherwise. |
|
|
True if the asset LOV field is visible (displayed) in the tile |
|
|
True if the asset LOV field can be used as facet |
|
|
The sort type of the asset LOV field |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1/lovfield' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"lovField" : {
"id" : 1
},
"facetable" : true,
"sortType" : "occurrence"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 409
{
"id" : 1,
"lovField" : {
"id" : 1,
"lovId" : 1,
"multi" : false,
"title" : "A new LOV field name changed",
"description" : "",
"titles" : [ {
"languageId" : 2,
"title" : "A new LOV field name changed"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : ""
} ]
},
"facetable" : true,
"tileVisible" : false,
"sortType" : "occurrence"
}Update an asset lov field
A POST request updates an asset lov field.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
|
The identifier of the asset LOV field |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
True if the asset LOV field can be used as facet |
|
|
The sort type of the asset LOV field |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset LOV field |
|
|
The identifier of the LOV Field |
|
|
The identifier of the referenced LOV |
|
|
The title of the LOV field |
|
|
The description of the LOV field |
|
|
The different localized titles of the LOV field |
|
|
The different localized descriptions of the LOV field |
|
|
True if the LOV field is multi-valued, false otherwise. |
|
|
True if the asset LOV field is visible (displayed) in the tile |
|
|
True if the asset LOV field can be used as facet |
|
|
The sort type of the asset LOV field |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1/lovfield/1' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"facetable" : false,
"sortType" : "custom"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 406
{
"id" : 1,
"lovField" : {
"id" : 1,
"lovId" : 1,
"multi" : false,
"title" : "A new LOV field name changed",
"description" : "",
"titles" : [ {
"languageId" : 2,
"title" : "A new LOV field name changed"
} ],
"descriptions" : [ {
"languageId" : 2,
"title" : ""
} ]
},
"facetable" : false,
"tileVisible" : false,
"sortType" : "custom"
}Delete an asset lov field
A DELETE request deletes an asset lov field.
Request parameter
-
force: False by default. If true, all asset lov field values based on this lov field are deleted.
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
|
The identifier of the asset LOV field |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The identifier of the asset LOV field |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1/lovfield/1' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 1
}Retrieve layouts associated to an asset type
A GET request fetches layouts associated to an asset type.
There is one detail layout allowing to define the detailed view of an asset. There are three available layouts allowing to specify the tile view of an asset.
| Property | Description |
|---|---|
type |
The type of the tile (NO_IMAGE, BIG_IMAGE, SMALL_IMAGE) |
title |
The title displayed in the tile view that is bound to the field defined in the Hub structure |
title.id |
The identifier of the layout field |
title.type |
The type of the section field (always "field") |
title.value |
The value of the section field |
title.value.ref |
The identifier of the bound Hub structure field used to define the title |
title.emphasize |
Emphasizes the field (always "false") |
shortDescription |
Allows you to bind the short description displayed in the tile view to the field defined in the Hub structure |
shortDescription.id |
The identifier of the layout field |
shortDescription.type |
The type of the section field (always "field") |
shortDescription.value |
The value of the section field |
shortDescription.value.ref |
The identifier of the bound Hub structure field used to define the short description |
shortDescription.emphasize |
Emphasizes the field (always "false") |
| Property | Description |
|---|---|
title |
Allows you to bind the title displayed in the detail view to the field defined in the Hub structure |
title.id |
The identifier of the layout field |
title.type |
The type of the section field (always "field") |
title.value |
The value of the section field |
title.value.ref |
The identifier of the bound Hub structure field used to define the title |
title.emphasize |
Emphasizes the field (always "false") |
shortDescription |
Allows you to bind the short description displayed in the detailed view to the field defined in the Hub structure |
shortDescription.id |
The identifier of the layout field |
shortDescription.type |
The type of the section field (always "field") |
shortDescription.value |
The value of the section field |
shortDescription.value.ref |
The identifier of the bound Hub structure field used to define the short description |
shortDescription.emphasize |
Emphasizes the field (always "false") |
sections |
The list of sections that compose the layout |
overviewSideFields |
The list of fields that compose the overview |
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The list of layouts defined for an asset type |
|
|
The layout identifier |
|
|
The layout type (detail|tile) |
|
|
The identifier of the asset type |
|
|
The layout content |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1/layout' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 2128
[ {
"id" : 3,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "NO_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 4,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "BIG_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 5,
"type" : "tile",
"assetType" : 1,
"content" : {
"type" : "SMALL_IMAGE",
"title" : {
"id" : "fcc600b9-770d-4b3e-8dba-cd89fc82a242",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "2b4b35c4-3594-437f-a5f9-a9e99fe072fd",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
}
}
}, {
"id" : 6,
"type" : "detail",
"assetType" : 1,
"content" : {
"title" : {
"id" : "4482d667-b12f-4ff0-87a5-b1c4b5038cfc",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "84b14320-5969-4485-93bb-c0e529fe7585",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
},
"sections" : [ {
"id" : "aa7cb52b-f6d2-42cc-a745-1d4e744bfc0f",
"title" : "Description",
"fields" : [ {
"id" : "4483a2b0-61dc-4ec7-a38d-29d9504a35ae",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 2
}
} ]
} ],
"overviewSideFields" : [ ]
}
} ]Update the layout associated to an asset type
A POST request updates the layout associated to an asset type.
Only the layout used to display the asset in a detailed view can be updated. The layouts used to display the asset in a tile view cannot be modified.
The title and the short description of a layout are always present and they cannot be updated.
Modifiable parts of the layout are:
-
sections: create/remove/update/reorder
-
overviewSideFields: update the list of fields composing the overview
| Property | Description |
|---|---|
sections |
The list of sections that compose the layout |
overviewSideFields |
The list of fields that compose the overview |
| Property | Description | Note |
|---|---|---|
id |
The section identifier |
Only needed when updating an existing section |
title |
The section title |
|
fields |
The list of fields that compose the overview |
| Property | Description | Note |
|---|---|---|
id |
The identifier of the field in the section |
Only needed when updating an existing field |
type |
The type of the field in the section |
Used to defined the type of the bound Hub structure field (field or lovfield) |
value |
The value for the section field |
Allows you to bind the layout section field with a field defined in the Hub structure |
value.ref |
The identifier of the field defined in the Hub structure |
Only reference to an asset field or to an asset lov field is authorized |
emphasize |
Emphasizes the field |
"false" by default |
Path parameters
| Parameter | Description |
|---|---|
|
The identifier of the asset type |
|
The layout identifier |
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The layout content |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The layout identifier |
|
|
The layout type (detail|tile) |
|
|
The identifier of the asset type |
|
|
The layout content |
Example request
$ curl '{server hostname}/hub/api/v1/structure/assettype/1/layout/6' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"content" : {
"sections" : [ {
"title" : "Another section",
"fields" : [ {
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 2
}
} ]
} ],
"overviewSideFields" : [ ]
}
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 768
{
"id" : 6,
"type" : "detail",
"assetType" : 1,
"content" : {
"title" : {
"id" : "4482d667-b12f-4ff0-87a5-b1c4b5038cfc",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 1
}
},
"shortDescription" : {
"id" : "84b14320-5969-4485-93bb-c0e529fe7585",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 3
}
},
"sections" : [ {
"id" : "e5139b37-6fec-4a69-8ee4-ed3b612d0c2e",
"title" : "Another section",
"fields" : [ {
"id" : "8b0db4cd-11bc-412f-bd23-6ea9561fdd3f",
"type" : "field",
"emphasize" : false,
"value" : {
"ref" : 2
}
} ]
} ],
"overviewSideFields" : [ ]
}
}Create a new tag
A POST request creates a tag.
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The tag title |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The tag identifier |
|
|
The tag title |
Example request
$ curl '{server hostname}/hub/api/v1/structure/tag' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"title" : "My new tag"
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 40
{
"id" : 1,
"title" : "My new tag"
}List all existing tags
A GET request lists all tags.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The list of tags |
|
|
The tag identifier |
|
|
The tag title |
Example request
$ curl '{server hostname}/hub/api/v1/structure/tag' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 44
[ {
"id" : 1,
"title" : "My new tag"
} ]Delete a tag
A DELETE request deletes a specific tag.
Request parameter
-
force: False by default. If true, the tag is removed from assets and drafts.
Path parameters
| Parameter | Description |
|---|---|
|
The tag identifier |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The tag identifier |
Example request
$ curl '{server hostname}/hub/api/v1/structure/tag/1' -i -X DELETE -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 14
{
"id" : 1
}Update the facet order
A POST request updates the facet order.
Request structure
| Path | Type | Description |
|---|---|---|
|
|
The display order of the facets |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The display order of the facets |
Example request
$ curl '{server hostname}/hub/api/v1/structure/facet/order' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"order" : [ 2, 3 ]
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 24
{
"order" : [ 2, 3 ]
}Retrieve the facet order
A GET request fetches the facet order.
Response structure
| Path | Type | Description |
|---|---|---|
|
|
The display order of the facets |
Example request
$ curl '{server hostname}/hub/api/v1/structure/facet/order' -i -H 'Content-Type: application/json;charset=UTF-8'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 24
{
"order" : [ 2, 3 ]
}Impact Analysis
Since version 17.09
A POST request performs impact analysis.
Request structure
| Path | Type | Description |
|---|---|---|
|
|
From a list of values, set of identifiers for which impact analysis must be performed |
|
|
Set of asset LOV field identifiers for which impact analysis must be performed |
Response structure
| Path | Type | Description |
|---|---|---|
|
|
For each identifier, provides the number of assets and the number of drafts referencing the corresponding value |
|
|
Each identifier provides a set of lov values and for each one, the number of assets that reference it within the corresponding asset LOV field. |
Example request
$ curl '{server hostname}/hub/api/v1/structure/impactanalysis' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -H 'Accept: application/json' -d '{
"lovValues" : [ 1, 3 ],
"assetLovFields" : [ 1 ]
}'Example response
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Content-Type: application/json;charset=UTF-8
Content-Length: 290
{
"lovValues" : {
"1" : {
"nbAssets" : 0,
"nbDrafts" : 0
},
"3" : {
"nbAssets" : 0,
"nbDrafts" : 0
}
},
"assetLovFieldValues" : {
"1" : {
"1" : {
"nbAssets" : 0
},
"3" : {
"nbAssets" : 0
}
}
}
}