List available packages
name | type | description | default | constraints |
---|---|---|---|---|
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 | Package list is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | PackageListResponse (JSON) | List of packages |
GET /devtools/packages Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "FAILURE",
"responseMessage" : "...",
"property" : "..."
}
}
Get the package with given name
name | type | description |
---|---|---|
name | path | Package name |
code | condition |
---|---|
200 | Package {name} exists. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | Package (JSON) | package |
GET /devtools/packages/{name} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "...",
"description" : "...",
"constructs" : 12345,
"templates" : 12345,
"datasources" : 12345,
"objectProperties" : 12345,
"subPackages" : [ {
"name" : "...",
"description" : "...",
"constructs" : 12345,
"templates" : 12345,
"datasources" : 12345,
"objectProperties" : 12345,
"subPackages" : [ { }, { } ]
}, {
"name" : "...",
"description" : "...",
"constructs" : 12345,
"templates" : 12345,
"datasources" : 12345,
"objectProperties" : 12345,
"subPackages" : [ { }, { } ]
} ]
}
Add the package with given name
name | type | description |
---|---|---|
name | path | Package name |
code | condition |
---|---|
201 | Package {name} was created. |
409 | Package {name} already exists. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
PUT /devtools/packages/{name} Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
...
Delete the package with given name
name | type | description |
---|---|---|
name | path | Package name |
code | condition |
---|---|
204 | Package {name} was deleted. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /devtools/packages/{name} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Trigger synchronization of all objects in the given package to the filesystem
name | type | description | default | constraints |
---|---|---|---|---|
name | path | name of the package | ||
wait | query | wait timeout in ms. When set to 0, response will be sent, when the action completes | 0 | long |
code | condition |
---|---|
200 | Synchronization succeeded within timeout, or was sent to the background. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | response |
PUT /devtools/packages/{name}/cms2fs Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"responseMessage" : "...",
"property" : "..."
}
}
Trigger synchronization of all objects in the given package to the cms
name | type | description | default | constraints |
---|---|---|---|---|
name | path | name of the package | ||
wait | query | wait timeout in ms. When set to 0, response will be sent, when the action completes | 0 | long |
code | condition |
---|---|
200 | Synchronization succeeded within timeout, or was sent to the background. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | response |
PUT /devtools/packages/{name}/fs2cms Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "NOTFOUND",
"responseMessage" : "...",
"property" : "..."
}
}
Get the list of constructs assigned to the package
name | type | description | default | constraints |
---|---|---|---|---|
name | path | Package name | ||
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 constructs is returned. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | PagedConstructInPackageListResponse (JSON) | List of constructs |
GET /devtools/packages/{name}/constructs Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "MAINTENANCEMODE",
"responseMessage" : "...",
"property" : "..."
}
}
Get the construct from the package
name | type | description |
---|---|---|
construct | path | construct ID (internal or global) or keyword |
name | path | Package name |
code | condition |
---|---|
200 | Construct is returned for package. |
404 | Either package {name} does not exist, or it does not contain {construct}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | ConstructLoadResponse (JSON) | construct response |
GET /devtools/packages/{name}/constructs/{construct} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"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,
"parts" : [ {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "UNORDEREDLIST",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "NAVIGATION",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
} ],
"visibleInMenu" : true
},
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Add a construct to a package
name | type | description |
---|---|---|
construct | path | construct ID (internal or global) or keyword |
name | path | Package name |
code | condition |
---|---|
201 | The construct was added to the package. |
404 | Either the package {name} or the {construct} does not exist. |
409 | {construct} is already part of the package {name}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
PUT /devtools/packages/{name}/constructs/{construct} Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
...
Remove a construct from a package
name | type | description |
---|---|---|
construct | path | construct ID (internal or global) or keyword |
name | path | Package name |
code | condition |
---|---|
204 | The construct was removed from the package. |
404 | Either package {name} does not exist, or it does not contain {construct}. |
409 | {construct} is contained in a subpackage and cannot be removed. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /devtools/packages/{name}/constructs/{construct} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get the templates of a package
name | type | description | default | constraints |
---|---|---|---|---|
name | path | Package name | ||
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 templates is returned. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | PagedTemplateInPackageListResponse (JSON) | List of templates |
GET /devtools/packages/{name}/templates Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"responseMessage" : "...",
"property" : "..."
}
}
Get the template in the package
name | type | description |
---|---|---|
name | path | Package name |
template | path | global template ID (uuid) |
code | condition |
---|---|
200 | Template is returned for package. |
404 | Either package {name} does not exist, or it does not contain {template}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | TemplateLoadResponse (JSON) | template response |
GET /devtools/packages/{name}/templates/{template} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"template" : {
"inheritedFrom" : "...",
"masterNode" : "...",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"locked" : true,
"markupLanguage" : {
"id" : 12345,
"name" : "...",
"extension" : "...",
"contentType" : "..."
},
"inherited" : true,
"folderId" : 12345,
"masterId" : 12345,
"path" : "...",
"templateTags" : {
"property1" : {
"mandatory" : true,
"editableInPage" : true,
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"mandatory" : true,
"editableInPage" : true,
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"objectTags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"source" : "...",
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true
},
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Add a template to a package
name | type | description |
---|---|---|
name | path | Package name |
template | path | global template ID (uuid) |
code | condition |
---|---|
201 | The template was added to the package. |
404 | Either the package {name} or the {template} does not exist. |
409 | {template} is already part of the package {name}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
PUT /devtools/packages/{name}/templates/{template} Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
...
Remove a template from a package
name | type | description |
---|---|---|
name | path | Package name |
template | path | global template ID (uuid) |
code | condition |
---|---|
204 | The template was removed from the package. |
404 | Either package {name} does not exist, or it does not contain {template}. |
409 | {template} is contained in a subpackage and cannot be removed. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /devtools/packages/{name}/templates/{template} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get the datasources in a package
name | type | description | default | constraints |
---|---|---|---|---|
name | path | Package name | ||
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 datasources is returned. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | PagedDatasourceInPackageListResponse (JSON) | List of datasources |
GET /devtools/packages/{name}/datasources Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "MAINTENANCEMODE",
"responseMessage" : "...",
"property" : "..."
}
}
Get the datasource in a package
name | type | description |
---|---|---|
datasource | path | datasource name |
name | path | Package name |
code | condition |
---|---|
200 | Datasource is returned for package. |
404 | Either package {name} does not exist, or it does not contain {datasource}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | DatasourceLoadResponse (JSON) | datasource response |
GET /devtools/packages/{name}/datasources/{datasource} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"datasource" : {
"id" : 12345,
"globalId" : "...",
"type" : "STATIC",
"name" : "..."
},
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Add a datasource to a package
name | type | description |
---|---|---|
datasource | path | datasource name |
name | path | Package name |
code | condition |
---|---|
201 | The datasource was added to the package. |
404 | Either the package {name} or the {datasource} does not exist. |
409 | {datasource} is already part of the package {name}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
PUT /devtools/packages/{name}/datasources/{datasource} Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
...
Remove a datasource from a package
name | type | description |
---|---|---|
datasource | path | datasource name |
name | path | Package name |
code | condition |
---|---|
204 | The datasource was removed from the package. |
404 | Either package {name} does not exist, or it does not contain {datasource}. |
409 | {datasource} is contained in a subpackage and cannot be removed. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /devtools/packages/{name}/datasources/{datasource} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get the object properties in a package
name | type | description | default | constraints |
---|---|---|---|---|
name | path | Package name | ||
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 properties is returned. |
404 | Package {name} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | PagedObjectPropertyInPackageListResponse (JSON) | List of object properties |
GET /devtools/packages/{name}/objectproperties Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"responseMessage" : "...",
"property" : "..."
}
}
Get the object property in a package
name | type | description |
---|---|---|
name | path | Package name |
objectproperty | path | object property keyword |
code | condition |
---|---|
200 | Object property is returned for package. |
404 | Either package {name} does not exist, or it does not contain {objectproperty}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | ObjectPropertyLoadResponse (JSON) | object property response |
GET /devtools/packages/{name}/objectproperties/{objectproperty} 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,
"parts" : [ { }, { } ],
"visibleInMenu" : true
},
"required" : true,
"inheritable" : true
},
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "PERMISSION",
"responseMessage" : "...",
"property" : "..."
}
}
Add an object property to a package
name | type | description |
---|---|---|
name | path | Package name |
objectproperty | path | object property keyword |
code | condition |
---|---|
201 | The object property was added to the package. |
404 | Either the package {name} or the {objectproperty} does not exist. |
409 | {objectproperty} is already part of the package {name}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
PUT /devtools/packages/{name}/objectproperties/{objectproperty} Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
...
Remove an object property from a package
name | type | description |
---|---|---|
name | path | Package name |
objectproperty | path | object property keyword |
code | condition |
---|---|
204 | The object property was removed from the package. |
404 | Either package {name} does not exist, or it does not contain {objectproperty}. |
409 | {objectproperty} is contained in a subpackage and cannot be removed. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /devtools/packages/{name}/objectproperties/{objectproperty} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
List packages assigned to a node. It is not possible to get packages to channels
name | type | description | default | constraints |
---|---|---|---|---|
nodeId | path | Node ID (either global or local) | ||
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 packages is returned. |
404 | Node {nodeId} was not found. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | PackageListResponse (JSON) | List of packages in the node |
GET /devtools/nodes/{nodeId}/packages Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Remove the package from the node. It is not possible to remove packages from channels
name | type | description |
---|---|---|
nodeId | path | node ID (either global or local) |
packageName | path | Package name |
code | condition |
---|---|
204 | Package was removed from the node. |
404 | Node {nodeId} was not found. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | generic response |
DELETE /devtools/nodes/{nodeId}/packages/{packageName} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Add the package to the node. It is not possible to add packages to channels
name | type | description |
---|---|---|
nodeId | path | node ID (either global or local) |
packageName | path | Package name |
code | condition |
---|---|
201 | Package was added to the node. |
404 | Either node {nodeId} or package {packageName} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | generic response |
PUT /devtools/nodes/{nodeId}/packages/{packageName} Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
...
Add the package to the node. It is not possible to add packages to channels
name | type | description |
---|---|---|
nodeId | path | node ID (either global or local) |
media type | data type | description |
---|---|---|
application/json | Package (JSON) | Package to add |
code | condition |
---|---|
201 | Package was added to the node. |
404 | Either node {nodeId} or the package does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | generic response |
PUT /devtools/nodes/{nodeId}/packages
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"description" : "...",
"constructs" : 12345,
"templates" : 12345,
"datasources" : 12345,
"objectProperties" : 12345,
"subPackages" : [ {
"name" : "...",
"description" : "...",
"constructs" : 12345,
"templates" : 12345,
"datasources" : 12345,
"objectProperties" : 12345,
"subPackages" : [ { }, { } ]
}, {
"name" : "...",
"description" : "...",
"constructs" : 12345,
"templates" : 12345,
"datasources" : 12345,
"objectProperties" : 12345,
"subPackages" : [ { }, { } ]
} ]
}
HTTP/1.1 201 Created
Content-Type: application/json
...
Get self refreshing live preview of the given page
name | type | description |
---|---|---|
id | path | page ID |
nodeId | query | node ID |
code | condition |
---|---|
200 | Page preview is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
text/html | (custom) | HTML page that contains the live preview of the page was iframe. |
GET /devtools/preview/page/{id} Accept: text/html
HTTP/1.1 200 OK
Content-Type: text/html
...
Listen on changes on dependencies with the given UUID
name | type | description |
---|---|---|
uuid | path | UUID of the registration |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
text/event-stream | (custom) | Events that are emitted, when a dependency changes. |
GET /devtools/listen/{uuid} Accept: text/event-stream
HTTP/1.1 200 OK
Content-Type: text/event-stream
...
Render the live preview of the page, which was registered before
name | type | description |
---|---|---|
uuid | path | UUID of the registration |
code | condition |
---|---|
200 | Page preview is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
text/html | (custom) | Rendered page |
GET /devtools/preview/{uuid} Accept: text/html
HTTP/1.1 200 OK
Content-Type: text/html
...
Endpoint for autocomplete UI components for constructs. Returns at most 10 constructs matching the given term
name | type | description |
---|---|---|
term | query | term to match |
code | condition |
---|---|
200 | Autocomplete list is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | array of AutocompleteItem (JSON) | list of at most 10 constructs |
GET /devtools/autocomplete/constructs Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"label" : "...",
"value" : "..."
}
Endpoint for autocomplete UI components for templates. Returns at most 10 templates matching the given term
name | type | description |
---|---|---|
term | query | term to match |
code | condition |
---|---|
200 | Autocomplete list is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | array of AutocompleteItem (JSON) | list of at most 10 templates |
GET /devtools/autocomplete/templates Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"label" : "...",
"value" : "..."
}
Endpoint for autocomplete UI components for datasources. Returns at most 10 datasources matching the given term
name | type | description |
---|---|---|
term | query | term to match |
code | condition |
---|---|
200 | Autocomplete list is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | array of AutocompleteItem (JSON) | list of at most 10 datasources |
GET /devtools/autocomplete/datasources Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"label" : "...",
"value" : "..."
}
Endpoint for autocomplete UI components for object properties. Returns at most 10 object properties matching the given term
name | type | description |
---|---|---|
term | query | term to match |
code | condition |
---|---|
200 | Autocomplete list is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | array of AutocompleteItem (JSON) | list of at most 10 object properties |
GET /devtools/autocomplete/objectproperties Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"label" : "...",
"value" : "..."
}
Get the current status information for the automatic synchronization.
code | condition |
---|---|
200 | Autosync status is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | SyncInfo (JSON) | Sync information |
GET /devtools/sync Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"enabled" : true,
"user" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
}
}
Start the sync for the current user (if not started before)
code | condition |
---|---|
200 | Autosync was enabled. |
409 | Autosync already was enabled. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | SyncInfo (JSON) | sync info |
PUT /devtools/sync Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"enabled" : true,
"user" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
}
}
Stop the sync, if it was started by the current user
code | condition |
---|---|
204 | Autosync was disabled. |
409 | Autosync already was disabled. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions on the devtools. |
405 | Feature devtools is not activated. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /devtools/sync Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...