Ui Einstellungen

Verwaltung von UI-Einstellungen

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource with given ID was not found

*/*

get

/cmn/ui-settings/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/ui-settings/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.044Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.044Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "category": "text",
  "key": "text",
  "token": "text",
  "active": true,
  "mandatoryForUsers": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "mandatoryForGroups": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "value": {},
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:43:00.044Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:43:00.044Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:00.044Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:00.044Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "userRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "groupPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:00.044Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:00.044Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "groupRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "operationForAllUsers": "READ_ONLY"
  }
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

categorystringRequired

Kategorie

keystringRequired

Schlüssel

tokenstringRead-onlyOptional

Eindeutiger Import-Schlüssel

activebooleanOptional

Sind die Einstellungen aktiv?

Default: true

valueobjectOptional

Search-Dialog

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/ui-settings/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/ui-settings/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 489

{
  "version": "text",
  "info": {},
  "id": "text",
  "category": "text",
  "key": "text",
  "active": true,
  "mandatoryForUsers": [
    {
      "id": "text"
    }
  ],
  "mandatoryForGroups": [
    {
      "id": "text"
    }
  ],
  "value": {},
  "permissionAggregation": {
    "version": "text",
    "info": {},
    "id": "text",
    "userPermissions": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "userRef": {
          "id": "text"
        },
        "operation": "READ_ONLY"
      }
    ],
    "groupPermissions": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "groupRef": {
          "id": "text"
        },
        "operation": "READ_ONLY"
      }
    ],
    "operationForAllUsers": "READ_ONLY"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.044Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.044Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "category": "text",
  "key": "text",
  "token": "text",
  "active": true,
  "mandatoryForUsers": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "mandatoryForGroups": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "value": {},
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:43:00.044Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:43:00.044Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:00.044Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:00.044Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "userRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "groupPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:00.044Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:00.044Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "groupRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "operationForAllUsers": "READ_ONLY"
  }
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

409

unable to delete Resource, due to constraints, existing references or internal state

*/*

delete

/cmn/ui-settings/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/ui-settings/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

categorystringRequired

Kategorie

keystringRequired

Schlüssel

tokenstringRead-onlyOptional

Eindeutiger Import-Schlüssel

activebooleanOptional

Sind die Einstellungen aktiv?

Default: true

valueobjectOptional

Search-Dialog

Responses

200

successful operation

*/*

422

Resource was not valid to process

*/*

post

/cmn/ui-settings

HTTPcURLJavaScriptPython

POST /api/cmn/ui-settings HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 489

{
  "version": "text",
  "info": {},
  "id": "text",
  "category": "text",
  "key": "text",
  "active": true,
  "mandatoryForUsers": [
    {
      "id": "text"
    }
  ],
  "mandatoryForGroups": [
    {
      "id": "text"
    }
  ],
  "value": {},
  "permissionAggregation": {
    "version": "text",
    "info": {},
    "id": "text",
    "userPermissions": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "userRef": {
          "id": "text"
        },
        "operation": "READ_ONLY"
      }
    ],
    "groupPermissions": [
      {
        "version": "text",
        "info": {},
        "id": "text",
        "groupRef": {
          "id": "text"
        },
        "operation": "READ_ONLY"
      }
    ],
    "operationForAllUsers": "READ_ONLY"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.044Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.044Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "category": "text",
  "key": "text",
  "token": "text",
  "active": true,
  "mandatoryForUsers": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "mandatoryForGroups": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "value": {},
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:43:00.044Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:43:00.044Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:00.044Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:00.044Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "userRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "groupPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:00.044Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:00.044Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "groupRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "operationForAllUsers": "READ_ONLY"
  }
}

get

Path parameters

categorystringRequired

keystringRequired

Responses

200

OK

*/*

get

/cmn/ui-settings/{category}/{key}

HTTPcURLJavaScriptPython

GET /api/cmn/ui-settings/{category}/{key} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "id": "1",
    "value": {},
    "permissionAggregation": {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:00.044Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:00.044Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "userPermissions": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:43:00.044Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:43:00.044Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "userRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "operation": "READ_ONLY"
        }
      ],
      "groupPermissions": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:43:00.044Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:43:00.044Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "groupRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "operation": "READ_ONLY"
        }
      ],
      "operationForAllUsers": "READ_ONLY"
    }
  }
]