Sign in
Class Definition

Get class definition for data object class

Changed on

Get class definition for the given data object class

get/pimcore-studio/api/class/definition/{dataObjectClass}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/class/definition/{dataObjectClass}
  • Auth: none declared

Path parameters

dataObjectClassstring required
Example:CAR

Data object class

Response

Class definition

additionalAttributesobject

AdditionalAttributes

idstring required

Id of class definition

namestring required

Name of class definition

titlestring required

Title

descriptionstring required

Description

creationDateinteger nullable required

Creation date timestamp

modificationDateinteger nullable required

Modification date timestamp

userOwnerinteger nullable required

User id of owner

parentClassstring required

Namespace of parent class

implementsInterfacesstring required

Interface implementations

listingParentClassstring required

List of parent class

useTraitsstring required

Traits usage

listingUseTraitsstring required

Traits usage listing

encryptionboolean required

Whether encryption is ued

allowInheritboolean required

Whether inheritance is allowed

allowVariantsboolean required

Whether variants are allowed

showVariantsboolean required

Whether variants are visible in the tree

showAppLoggerTabboolean required

Show application logger tab

linkGeneratorReferencestring required

Namespace of link generator

previewGeneratorReferencestring required

Namespace of preview generator

compositeIndicesobject required

Composite indices

showFieldLookupboolean required

Show field lookup

propertyVisibilityobject required

Visibility of properties for grid, search, ...

enableGridLockingboolean required

Whether grid locking is enabled

blockedVarsForExportstring[] required

Blocked variables for export

isWriteableboolean required

Whether the class definition can be written to

groupstring nullable required

Group

Example response

{
  "id": "AP",
  "name": "AccessoryPart",
  "title": "Accessory Part",
  "description": "This class represents an accessory part",
  "creationDate": 1700000000,
  "modificationDate": 1700000000,
  "userOwner": 1,
  "parentClass": "App\\Model\\DataObject\\AccessoryPart",
  "implementsInterfaces": "App\\Model\\DataObject\\Interface",
  "listingParentClass": "App\\Model\\DataObject\\Listing",
  "useTraits": "App\\Model\\DataObject\\Trait",
  "listingUseTraits": "App\\Model\\DataObject\\ListingTrait",
  "encryption": true,
  "allowInherit": true,
  "allowVariants": true,
  "showVariants": true,
  "icon": {
    "type": "path",
    "value": "/path/to/icon"
  },
  "showAppLoggerTab": true,
  "linkGeneratorReference": "App\\Model\\DataObject\\LinkGenerator",
  "previewGeneratorReference": "App\\Model\\DataObject\\PreviewGenerator",
  "showFieldLookup": true,
  "enableGridLocking": true,
  "blockedVarsForExport": [],
  "isWriteable": true,
  "group": "system"
}

Changes