user-interface and user-interfaces
This relation targets the collection of user-interfaces configured for the dam instance.
4.0.8+
Get user-interfaces
GET /api/dam/user-interfaces
{
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces?page=1&size=20"
},
"curies": [
{
"name": "kpk",
"href": "http://dev.local/api/doc/rels/{rel}",
"templated": true
}
]
},
"_embedded": {
"ui": [
{
"id": 0,
"title": "Backoffice",
"uri": "http://dev.local",
"clientId": "edb5ff11-96b8-11eb-b24f-000c2924996a",
"type": "BACKOFFICE",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/0"
}
}
},
{
"id": 1,
"title": "Frontoffice",
"uri": "http://frontoffice.dev.local",
"clientId": "7cafbdc6-a6e9-11ed-8346-0242ac130004",
"type": "FRONTOFFICE",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/1"
}
}
},
{
"id": 2,
"title": "Refront",
"uri": "http://refront.dev.local",
"clientId": "7cafbdc6-a6e9-11ed-8346-0242ac130005",
"type": "REFRONT",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/2"
}
}
},
{
"id": 3,
"title": "AppliTiers",
"uri": "http://applitiers.dev.local",
"clientId": "7cafbdc6-a6e9-11ed-8346-0242ac130006",
"type": "APPLICATION_TIERS",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/3"
}
}
},
{
"id": 6,
"title": "RefrontBis",
"uri": "http://refront.dev.local",
"clientId": "7cafbdc6-a6e9-11ed-8346-0242ac130007",
"type": "REFRONT",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/6"
}
}
},
{
"id": 7,
"title": "myapp",
"uri": "http://localhost:8686",
"clientId": "myapp",
"type": "REFRONT",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/7"
}
}
}
]
},
"totalCount": 6
}
user-interface
This relation targets a user-interface configured for the dam instance.
4.0.8+
Get a specific user-interface
GET /api/dam/user-interfaces/{uiId}
{
"id": 2,
"title": "Refront",
"uri": "http://refront.dev.local",
"gdprUpdateDate": "2023-07-27T08:00:00.000Z",
"gdprCurrentResources": "{\"DE\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_DE.pdf\",\"EN\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_EN.pdf\",\"ES\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_ES.pdf\",\"FR\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_FR.pdf\",\"IT\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_IT.pdf\",\"default\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_EN.pdf\"}",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/2"
},
"curies": [
{
"name": "kpk",
"href": "http://dev.local/api/doc/rels/{rel}",
"templated": true
}
]
}
}
4.94.0+
Get a specific user-interface by its client id
GET /api/dam/user-interfaces/by-clientId/{clientId}
{
"id": 2,
"title": "Refront",
"uri": "http://refront.dev.local",
"gdprUpdateDate": "2023-07-27T08:00:00.000Z",
"gdprCurrentResources": "{\"DE\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_DE.pdf\",\"EN\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_EN.pdf\",\"ES\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_ES.pdf\",\"FR\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_FR.pdf\",\"IT\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_IT.pdf\",\"default\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_EN.pdf\"}",
"_links": {
"self": {
"href": "http://dev.local/api/dam/user-interfaces/2"
},
"curies": [
{
"name": "kpk",
"href": "http://dev.local/api/doc/rels/{rel}",
"templated": true
}
]
}
}
If the requested clientId exists then the request will return 200
The possible error are :
-
401
the user try to request with bad credentials -
404
the requested ui does not exists -
500
for an unknown server error
4.94.0+
Update gdpr information of a specific user_interface
PUT /api/dam/user_interfaces/{uiId}
{
"gdprUpdateDate": "2023-07-27T08:00:00",
"gdprCurrentResources": "{\"DE\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_DE.pdf\",\"EN\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_EN.pdf\",\"ES\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_ES.pdf\",\"FR\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_FR.pdf\",\"IT\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_IT.pdf\",\"default\":\"privacy-policy/RGPD-Politique_de_confidentialite_des_donnees_EN.pdf\"}"
}
4.94.0+