Resource for management of object property definitions
List object properties.
The result can be filtered by
id
globalId
name
description
keyword
id
globalId
name
description
keyword
type
required
inheritable
syncContentset
syncChannelset
syncVariants
construct.name
category.name
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
embed | query | Comma separated list of attributes that contain references to other objects, which shall be embedded into the returned objects. | no | ||
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int | no |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int | no |
q | query | Query string for filtering | no | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name | no | |
type | query | Filter by object type(s) | "file" or "folder" or "image" or "page" or "template" | yes |
code | condition |
---|---|
200 | List of object properties is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyListResponse (JSON) | response containing a list of object properties |
GET /objectproperty
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "read", "viewform" ],
"property2" : [ "createtemplates", "readitems" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new construct category.
If any of the following requirements are not met, the operation will fail with a 400 Bad Request status code:
keyword
field is missing or emptykeyword
field contains characters other than letters (A-Z and a-z), digits (0-9), minus ('-') and underscore ('_')type
field is missingmedia type | data type | description |
---|---|---|
application/json | ObjectProperty (JSON) | new object property REST model |
code | condition |
---|---|
200 | The object property has been created. |
400 | The provided object property data is invalid. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The created object property |
400 | The provided object property definition is invalid |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyLoadResponse (JSON) | response containing the object property |
POST /objectproperty
Content-Type: application/json
Accept: application/json
{
"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" : "CMSFORM",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "STRING",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
} ],
"visibleInMenu" : true,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"autoEnable" : true,
"liveEditorTagName" : "...",
"hopeditHook" : "...",
"categoryId" : 12345
},
"required" : true,
"inheritable" : true,
"syncContentset" : true,
"syncChannelset" : true,
"syncVariants" : true,
"categoryId" : 12345,
"category" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"objectProperty" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"keyword" : "...",
"type" : 12345,
"constructId" : 12345,
"construct" : {
"keyword" : "...",
"mayBeSubtag" : true,
"mayContainSubtags" : true,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"icon" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"editdo" : 12345,
"category" : "...",
"categorySortorder" : 12345,
"newEditor" : true,
"externalEditorUrl" : "...",
"parts" : [ { }, { } ],
"visibleInMenu" : true,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"autoEnable" : true,
"liveEditorTagName" : "...",
"hopeditHook" : "...",
"categoryId" : 12345
},
"required" : true,
"inheritable" : true,
"syncContentset" : true,
"syncChannelset" : true,
"syncVariants" : true,
"categoryId" : 12345,
"category" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
List all object property categories.
The result can be filtered by
id
globalId
name
sortOrder
id
globalId
name
sortOrder
name | type | description | default | constraints |
---|---|---|---|---|
embed | query | Comma separated list of attributes that contain references to other objects, which shall be embedded into the returned objects. | ||
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
q | query | Query string for filtering | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name |
code | condition |
---|---|
200 | List of object property categories is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The list is returned |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyCategoryListResponse (JSON) | response with list |
GET /objectproperty/category
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "deleteitems", "inheritance" ],
"property2" : [ "updateform", "deletetemplates" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new object property category
media type | data type | description |
---|---|---|
application/json | ObjectPropertyCategory (JSON) | new category REST model |
code | condition |
---|---|
200 | The object property category has been created. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The category |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyCategoryLoadResponse (JSON) | response containing the created category |
POST /objectproperty/category
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"objectPropertyCategory" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete the object property by its ID
name | type | description |
---|---|---|
id | path | object property ID |
code | condition |
---|---|
200 | The object property has been deleted. |
404 | The object property {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The object property is deleted |
404 | The object property with ID {id} does not exist |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | general success response |
DELETE /objectproperty/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load the object property by its ID
name | type | description |
---|---|---|
id | path | object property ID |
code | condition |
---|---|
200 | The object property has been loaded. |
404 | The object property {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The object property is returned. |
404 | The object property with ID {id} does not exist |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyLoadResponse (JSON) | response containing the updated object property |
GET /objectproperty/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"objectProperty" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"keyword" : "...",
"type" : 12345,
"constructId" : 12345,
"construct" : {
"keyword" : "...",
"mayBeSubtag" : true,
"mayContainSubtags" : true,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"icon" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"editdo" : 12345,
"category" : "...",
"categorySortorder" : 12345,
"newEditor" : true,
"externalEditorUrl" : "...",
"parts" : [ { }, { } ],
"visibleInMenu" : true,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"autoEnable" : true,
"liveEditorTagName" : "...",
"hopeditHook" : "...",
"categoryId" : 12345
},
"required" : true,
"inheritable" : true,
"syncContentset" : true,
"syncChannelset" : true,
"syncVariants" : true,
"categoryId" : 12345,
"category" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Edit the object property by its ID
name | type | description |
---|---|---|
id | path | object property ID |
media type | data type |
---|---|
application/json | ObjectProperty (JSON) |
code | condition |
---|---|
200 | The object property has been updated. |
404 | The object property {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The updated object property is returned. |
404 | The object property with ID {id} does not exist |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyLoadResponse (JSON) | response containing the updated object property |
PUT /objectproperty/{id}
Content-Type: application/json
Accept: application/json
{
"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" : "NODE",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
}, {
"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" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
} ],
"visibleInMenu" : true,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"autoEnable" : true,
"liveEditorTagName" : "...",
"hopeditHook" : "...",
"categoryId" : 12345
},
"required" : true,
"inheritable" : true,
"syncContentset" : true,
"syncChannelset" : true,
"syncVariants" : true,
"categoryId" : 12345,
"category" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"objectProperty" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"keyword" : "...",
"type" : 12345,
"constructId" : 12345,
"construct" : {
"keyword" : "...",
"mayBeSubtag" : true,
"mayContainSubtags" : true,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"icon" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"editdo" : 12345,
"category" : "...",
"categorySortorder" : 12345,
"newEditor" : true,
"externalEditorUrl" : "...",
"parts" : [ { }, { } ],
"visibleInMenu" : true,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"autoEnable" : true,
"liveEditorTagName" : "...",
"hopeditHook" : "...",
"categoryId" : 12345
},
"required" : true,
"inheritable" : true,
"syncContentset" : true,
"syncChannelset" : true,
"syncVariants" : true,
"categoryId" : 12345,
"category" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete the object property category by its ID
name | type | description |
---|---|---|
id | path | category ID |
code | condition |
---|---|
200 | The object property category has been loaded. |
404 | The object property category {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The object property category is deleted |
404 | The object property category with ID {id} does not exist |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | general success response |
DELETE /objectproperty/category/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load the object property category by its ID
name | type | description |
---|---|---|
id | path | category ID |
code | condition |
---|---|
200 | The object property category has been loaded. |
404 | The object property category {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The category is returned. |
404 | The category with ID {id} does not exist |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyCategoryLoadResponse (JSON) | response containing the category |
GET /objectproperty/category/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"objectPropertyCategory" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Edit the object property category by its ID
name | type | description |
---|---|---|
id | path | category ID |
media type | data type |
---|---|
application/json | ObjectPropertyCategory (JSON) |
code | condition |
---|---|
200 | The object property category has been loaded. |
404 | The object property category {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The updated category is returned. |
404 | The category with ID {id} does not exist |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyCategoryLoadResponse (JSON) | response containing the updated object property category |
PUT /objectproperty/category/{id}
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"objectPropertyCategory" : {
"id" : 12345,
"globalId" : "...",
"name" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"sortOrder" : 12345
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Link a set of object property definitions to the selected nodes
media type | data type | description |
---|---|---|
application/json | BulkLinkUpdateRequest (JSON) | POST body with source + target IDs |
code | condition |
---|---|
200 | The unlink succeeded for all the requested entities. |
404 | The distinct node or object property definition does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The link succeeded for all the requested entities. |
404 | The distinct node or object property definition does not exist |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | general success response |
POST /objectproperty/link/nodes
Content-Type: application/json
Accept: application/json
{
"ids" : [ 12345, 12345 ],
"targetIds" : [ "...", "..." ]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Unlink a set of object property definitions from the selected nodes
media type | data type | description |
---|---|---|
application/json | BulkLinkUpdateRequest (JSON) | POST body with source + target IDs |
code | condition |
---|---|
200 | The unlink succeeded for all the requested entities. |
404 | The distinct node or object property definition does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
200 | The unlink succeeded for all the requested entities. |
404 | The distinct node or object property definition does not exist |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | general success response |
POST /objectproperty/unlink/nodes
Content-Type: application/json
Accept: application/json
{
"ids" : [ 12345, 12345 ],
"targetIds" : [ "...", "..." ]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Return a list of constructs, utilizing the given Object Property
name | type | description |
---|---|---|
id | path |
code | condition |
---|---|
200 | The list of constructs for object property {id} is returned. |
404 | The object property {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ConstructListResponse (JSON) |
GET /objectproperty/{id}/constructs
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"constructs" : [ {
"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" : "TABLE",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
}, {
"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" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
} ],
"visibleInMenu" : true,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"autoEnable" : true,
"liveEditorTagName" : "...",
"hopeditHook" : "...",
"categoryId" : 12345
}, {
"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" : "BREADCRUMB",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "STRING",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { },
"markupLanguageId" : 12345,
"htmlClass" : "...",
"partOrder" : 12345,
"policy" : "...",
"nameI18n" : {
"property1" : "...",
"property2" : "..."
}
} ],
"visibleInMenu" : true,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"autoEnable" : true,
"liveEditorTagName" : "...",
"hopeditHook" : "...",
"categoryId" : 12345
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the implementation hash for an object property
name | type | description |
---|---|---|
id | path | object property ID |
code | condition |
---|---|
200 | Object Property {id} exists. |
404 | Object Property {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ImplementationHashResponse (JSON) | response with implementation hash |
GET /objectproperty/{id}/hash
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"hash" : "...",
"base" : "...",
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Return a list of nodes, linked to the the given Object Property
name | type | description |
---|---|---|
id | path |
code | condition |
---|---|
200 | The list of nodes for object property {id}, permitted for the reading for the current user, is returned. |
404 | The object property {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | NodeList (JSON) |
GET /objectproperty/{id}/nodes
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "create", "createform" ],
"property2" : [ "createfolder", "updateconstructs" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}