ObjectPropertyInPackage Data Type

Object property definition in a package

Properties
name data type description
packageName string Name of the package that contains the object
Properties inherited from ObjectProperty
id number Internal ID of the object property definition
globalId string Global ID
name string Name in the current language
description string Description in the current language
keyword string Keyword
type number Type of objects, this object property definition is for
constructId number Internal construct ID
construct Construct Construct used by the object property (may be null, if not embedded in the response)
required boolean True if the object property is required, false if not
inheritable boolean True if the object property is inheritable, false if not

Example

{
  "packageName" : "...",
  "id" : 12345,
  "globalId" : "...",
  "name" : "...",
  "description" : "...",
  "keyword" : "...",
  "type" : 12345,
  "constructId" : 12345,
  "construct" : {
    "keyword" : "...",
    "mayBeSubtag" : true,
    "mayContainSubtags" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "description" : "...",
    "icon" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "editdo" : 12345,
    "category" : "...",
    "categorySortorder" : 12345,
    "newEditor" : true,
    "externalEditorUrl" : "...",
    "parts" : [ {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "UNKNOWN",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { }
    }, {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "LIST",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { }
    } ],
    "visibleInMenu" : true
  },
  "required" : true,
  "inheritable" : true
}