EavGroup

Management of individual Fields

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/cmn/eav-groups/{id}

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:28:47.596Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:28:47.596Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "description": "text",
  "attributes": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:28:47.596Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:28:47.596Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "key": "text",
      "label": "text",
      "description": "text",
      "position": 1,
      "type": "BOOLEAN",
      "textGroupRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "viewMode": "EDITABLE",
      "active": true,
      "fulltextField": false,
      "searchIndex": false,
      "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "uiSettings": {},
  "entities": [
    "text"
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

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

keystringOptional

group key

labelstringRequired

group label

descriptionstringRequired

group description

uiSettingsobjectOptional

Search-Dialog

entitiesstring[]Required

zugeordnet zu folgenden entities

appIdentifierstring · uuidOptional

appIdentifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/cmn/eav-groups/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/eav-groups/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 464

{
  "version": "text",
  "info": {},
  "id": "text",
  "key": "text",
  "label": "text",
  "description": "text",
  "attributes": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "key": "text",
      "label": "text",
      "description": "text",
      "type": "BOOLEAN",
      "textGroupRef": {
        "id": "text"
      },
      "viewMode": "EDITABLE",
      "active": true,
      "fulltextField": false,
      "searchIndex": false,
      "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "uiSettings": {},
  "entities": [
    "text"
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:28:47.596Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:28:47.596Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "description": "text",
  "attributes": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:28:47.596Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:28:47.596Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "key": "text",
      "label": "text",
      "description": "text",
      "position": 1,
      "type": "BOOLEAN",
      "textGroupRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "viewMode": "EDITABLE",
      "active": true,
      "fulltextField": false,
      "searchIndex": false,
      "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "uiSettings": {},
  "entities": [
    "text"
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

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

application/json

delete

/cmn/eav-groups/{id}

HTTPcURLJavaScriptPython

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

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

force deletion of data

post

Path parameters

idinteger · int64Required

an identifier

Body

application/json

entitiesstring[]Required

Entity-Assoziation, bei denen die Daten gelöscht werden sollen

attributeIdinteger · int64[]Optional

Attribute Key dessen daten gelöscht werden sollen (optional)

Responses

200

operation process successfully

No content

post

/cmn/eav-groups/{id}/remove-data

HTTPcURLJavaScriptPython

POST /api/cmn/eav-groups/{id}/remove-data HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "entities": [
    "text"
  ],
  "attributeId": [
    1
  ]
}

200

operation process successfully

No content

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringOptional

group key

labelstringRequired

group label

descriptionstringRequired

group description

uiSettingsobjectOptional

Search-Dialog

entitiesstring[]Required

zugeordnet zu folgenden entities

appIdentifierstring · uuidOptional

appIdentifier

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/cmn/eav-groups

HTTPcURLJavaScriptPython

POST /api/cmn/eav-groups HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 464

{
  "version": "text",
  "info": {},
  "id": "text",
  "key": "text",
  "label": "text",
  "description": "text",
  "attributes": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "key": "text",
      "label": "text",
      "description": "text",
      "type": "BOOLEAN",
      "textGroupRef": {
        "id": "text"
      },
      "viewMode": "EDITABLE",
      "active": true,
      "fulltextField": false,
      "searchIndex": false,
      "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "uiSettings": {},
  "entities": [
    "text"
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:28:47.596Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:28:47.596Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "description": "text",
  "attributes": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:28:47.596Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:28:47.596Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "key": "text",
      "label": "text",
      "description": "text",
      "position": 1,
      "type": "BOOLEAN",
      "textGroupRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "viewMode": "EDITABLE",
      "active": true,
      "fulltextField": false,
      "searchIndex": false,
      "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "uiSettings": {},
  "entities": [
    "text"
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

check if the group is in use e.g contains valid content in associated entities

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

OK

application/json

Responseboolean

get

/cmn/eav-groups/{id}/is-used

HTTPcURLJavaScriptPython

GET /api/cmn/eav-groups/{id}/is-used HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

true

check if the attribute is in use contains valid content in associated entities

get

Path parameters

idinteger · int64Required

group-id

attributeIdinteger · int64Required

attribute-id

Responses

200

OK

application/json

Responseboolean

get

/cmn/eav-groups/{id}/attribute/{attributeId}/is-used

HTTPcURLJavaScriptPython

GET /api/cmn/eav-groups/{id}/attribute/{attributeId}/is-used HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

true

return all custom field ids

get

Responses

200

OK

application/json

get

/cmn/eav-groups/entities

HTTPcURLJavaScriptPython

GET /api/cmn/eav-groups/entities HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "key": "text",
    "label": "text"
  }
]

return group by key

get

Path parameters

groupKeystringRequired

an identifier

Responses

200

OK

application/json

get

/cmn/eav-groups/by-key/{groupKey}

HTTPcURLJavaScriptPython

GET /api/cmn/eav-groups/by-key/{groupKey} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:28:47.596Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:28:47.596Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "description": "text",
  "attributes": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:28:47.596Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:28:47.596Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "key": "text",
      "label": "text",
      "description": "text",
      "position": 1,
      "type": "BOOLEAN",
      "textGroupRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "viewMode": "EDITABLE",
      "active": true,
      "fulltextField": false,
      "searchIndex": false,
      "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "uiSettings": {},
  "entities": [
    "text"
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}