EavGroup

Management of individual Fields

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
chevron-right
200

successful operation

application/json
get
/cmn/eav-groups/{id}

Update existing Resource

put
Path parameters
idinteger · int64Required

an identifier

Body
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
chevron-right
200

successful operation

application/json
put
/cmn/eav-groups/{id}

Delete an existing Resource

delete
Path parameters
idinteger · int64Required

an identifier

Responses
chevron-right
200

successful operation

application/json
delete
/cmn/eav-groups/{id}

force deletion of data

post
Path parameters
idinteger · int64Required

an identifier

Body
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
chevron-right
200

operation process successfully

No content

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

operation process successfully

No content

Create new Resource

post
Body
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
chevron-right
200

successful operation

application/json
post
/cmn/eav-groups

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

get
Path parameters
idinteger · int64Required

an identifier

Responses
chevron-right
200

OK

application/json
Responseboolean
get
/cmn/eav-groups/{id}/is-used
200

OK

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
chevron-right
200

OK

application/json
Responseboolean
get
/cmn/eav-groups/{id}/attribute/{attributeId}/is-used
200

OK

return all custom field ids

get
Responses
chevron-right
200

OK

application/json
get
/cmn/eav-groups/entities
200

OK

return group by key

get
Path parameters
groupKeystringRequired

an identifier

Responses
chevron-right
200

OK

application/json
get
/cmn/eav-groups/by-key/{groupKey}
200

OK

Last updated

Was this helpful?