PackageResource Resource

GET /devtools/packages

List available packages.
The result can be filtered by

  • name
and sorted by
  • name
  • constructs
  • datasources
  • templates
  • objectProperties
  • crFragments
  • contentRepositories

Request Parameters
name type description default constraints
page query 1 int
pageSize query -1 int
q query    
sort query name  
Response Codes
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.
Response Body
media type data type description
application/json PackageListResponse (JSON) List of packages

Example

Request
GET /devtools/packages
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ABOVE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  }, {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ASIDE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "deletefolder", "wastebin" ],
    "property2" : [ "readtemplates", "updateconstructs" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /devtools/sync

Stop the sync, if it was started by the current user

Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/sync
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/sync

Get the current status information for the automatic synchronization.

Response Codes
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.
Response Body
media type data type description
application/json SyncInfo (JSON) Sync information

Example

Request
GET /devtools/sync
Content-Type: */*
Accept: application/json

                
...
Response
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" : "..."
  }
}

PUT /devtools/sync

Start the sync for the current user (if not started before)

Response Codes
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.
Response Body
media type data type description
application/json SyncInfo (JSON) sync info

Example

Request
PUT /devtools/sync
Content-Type: */*
Accept: application/json

                
...
Response
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" : "..."
  }
}

GET /devtools/autocomplete/constructs

Endpoint for autocomplete UI components for constructs. Returns at most 10 constructs matching the given term

Request Parameters
name type description
term query term to match
Response Codes
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.
Response Body
media type data type description
application/json array of AutocompleteItem (JSON) list of at most 10 constructs

Example

Request
GET /devtools/autocomplete/constructs
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "..."
} ]

GET /devtools/autocomplete/contentrepositories

Endpoint for autocomplete UI components for contentrepositories. Returns at most 10 contentrepositories matching the given term

Request Parameters
name type description
term query term to match
Response Codes
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.
Response Body
media type data type description
application/json array of AutocompleteItem (JSON) list of at most 10 contentrepositories

Example

Request
GET /devtools/autocomplete/contentrepositories
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "..."
} ]

GET /devtools/autocomplete/cr_fragments

Endpoint for autocomplete UI components for cr fragments. Returns at most 10 cr fragments matching the given term

Request Parameters
name type description
term query term to match
Response Codes
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.
Response Body
media type data type description
application/json array of AutocompleteItem (JSON) list of at most 10 cr fragments

Example

Request
GET /devtools/autocomplete/cr_fragments
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "..."
} ]

GET /devtools/autocomplete/datasources

Endpoint for autocomplete UI components for datasources. Returns at most 10 datasources matching the given term

Request Parameters
name type description
term query term to match
Response Codes
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.
Response Body
media type data type description
application/json array of AutocompleteItem (JSON) list of at most 10 datasources

Example

Request
GET /devtools/autocomplete/datasources
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "..."
} ]

GET /devtools/autocomplete/objectproperties

Endpoint for autocomplete UI components for object properties. Returns at most 10 object properties matching the given term

Request Parameters
name type description
term query term to match
Response Codes
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.
Response Body
media type data type description
application/json array of AutocompleteItem (JSON) list of at most 10 object properties

Example

Request
GET /devtools/autocomplete/objectproperties
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "..."
} ]

GET /devtools/autocomplete/templates

Endpoint for autocomplete UI components for templates. Returns at most 10 templates matching the given term

Request Parameters
name type description
term query term to match
Response Codes
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.
Response Body
media type data type description
application/json array of AutocompleteItem (JSON) list of at most 10 templates

Example

Request
GET /devtools/autocomplete/templates
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "..."
} ]

GET /devtools/listen/{uuid}

Listen on changes on dependencies with the given UUID

Request Parameters
name type description
uuid path UUID of the registration
Response Codes
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.
Response Body
media type data type description
text/event-stream object Events that are emitted, when a dependency changes.

Example

Request
GET /devtools/listen/{uuid}
Content-Type: */*
Accept: text/event-stream

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/event-stream

                
...

DELETE /devtools/packages/{name}

Delete the package with given name

Request Parameters
name type description
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/packages/{name}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/packages/{name}

Get the package with given name

Request Parameters
name type description
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json Package (JSON) package

Example

Request
GET /devtools/packages/{name}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "constructs" : 12345,
  "templates" : 12345,
  "datasources" : 12345,
  "objectProperties" : 12345,
  "crFragments" : 12345,
  "contentRepositories" : 12345,
  "subPackages" : [ {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ASIDE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  }, {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ABOVE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  } ],
  "construct" : {
    "keyword" : "...",
    "mayBeSubtag" : true,
    "mayContainSubtags" : true,
    "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,
    "category" : {
      "name" : "...",
      "constructs" : {
        "property1" : { },
        "property2" : { }
      },
      "id" : 12345,
      "globalId" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "sortOrder" : 12345
    },
    "externalEditorUrl" : "...",
    "parts" : [ {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "PAGE",
      "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" : "LIST",
      "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" : "...",
    "openEditorOnInsert" : true,
    "editorControlStyle" : "CLICK",
    "editorControlsInside" : true,
    "categoryId" : 12345
  },
  "category" : "..."
}

PUT /devtools/packages/{name}

Add the package with given name

Request Parameters
name type description
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
PUT /devtools/packages/{name}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /devtools/preview/{uuid}

Render the live preview of the page, which was registered before

Request Parameters
name type description
uuid path UUID of the registration
Response Codes
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.
Response Body
media type data type description
text/html string Rendered page

Example

Request
GET /devtools/preview/{uuid}
Content-Type: */*
Accept: text/html

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/html

                
...

POST /devtools/stoplisten/{uuid}

Remove the listener with given UUID

Request Parameters
name type description
uuid path UUID of the registration
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) empty response

Example

Request
POST /devtools/stoplisten/{uuid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /devtools/nodes/{nodeId}/packages

List packages assigned to a node. It is not possible to get packages to channels.
The result can be filtered by

  • name
and sorted by
  • name
  • constructs
  • datasources
  • templates
  • objectProperties
  • crFragments
  • contentRepositories

Request Parameters
name type description default constraints
nodeId path Node ID (either global or local)    
page query 1 int
pageSize query -1 int
q query    
sort query name  
Response Codes
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.
Response Body
media type data type description
application/json PackageListResponse (JSON) List of packages in the node

Example

Request
GET /devtools/nodes/{nodeId}/packages
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ASIDE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  }, {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ASIDE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "formreport", "createform" ],
    "property2" : [ "wastebin", "delete" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/nodes/{nodeId}/packages

Add the package to the node. It is not possible to add packages to channels

Request Parameters
name type description
nodeId path node ID (either global or local)
Request Body
media type data type description
application/json Package (JSON) Package to add
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) generic response

Example

Request
PUT /devtools/nodes/{nodeId}/packages
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "...",
  "constructs" : 12345,
  "templates" : 12345,
  "datasources" : 12345,
  "objectProperties" : 12345,
  "crFragments" : 12345,
  "contentRepositories" : 12345,
  "subPackages" : [ {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ABOVE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  }, {
    "name" : "...",
    "description" : "...",
    "constructs" : 12345,
    "templates" : 12345,
    "datasources" : 12345,
    "objectProperties" : 12345,
    "crFragments" : 12345,
    "contentRepositories" : 12345,
    "subPackages" : [ { }, { } ],
    "construct" : {
      "keyword" : "...",
      "mayBeSubtag" : true,
      "mayContainSubtags" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ABOVE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "category" : "..."
  } ],
  "construct" : {
    "keyword" : "...",
    "mayBeSubtag" : true,
    "mayContainSubtags" : true,
    "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,
    "category" : {
      "name" : "...",
      "constructs" : {
        "property1" : { },
        "property2" : { }
      },
      "id" : 12345,
      "globalId" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "sortOrder" : 12345
    },
    "externalEditorUrl" : "...",
    "parts" : [ {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "TEMPLATETAG",
      "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" : "SELECT",
      "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" : "...",
    "openEditorOnInsert" : true,
    "editorControlStyle" : "CLICK",
    "editorControlsInside" : true,
    "categoryId" : 12345
  },
  "category" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /devtools/package/{name}/check

Checks the package for completeness

Request Parameters
name type description default constraints multivalued
name path name of the package to check     no
checkAll query if true, other packages are also searched false boolean no
filter query INCOMPLETE "ALL" or "INCOMPLETE" no
page query 1 int no
pageSize query -1 int no
type query   "CONSTRUCT" or "CONTENT_REPOSITORY" or "DATASOURCE" or "OBJECT_PROPERTY" or "OBJECT_TAG_DEFINITION" or "TEMPLATE" or "TEMPLATE_TAG" or "UNKNOWN" yes
wait query wait timeout in ms. When set to 0, response will be sent, when the action completes 0 long no
Response Codes
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.
Response Body
media type data type description
application/json GenericResponse (JSON) list of dependencies

Example

Request
GET /devtools/package/{name}/check
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/packages/{name}/cms2fs

Trigger synchronization of all objects in the given package to the filesystem

Request Parameters
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
Response Codes
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.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
PUT /devtools/packages/{name}/cms2fs
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /devtools/packages/{name}/constructs

Get the list of constructs assigned to the package.
The result can be filtered by

  • keyword
  • name
  • description
and sorted by
  • keyword
  • name
  • description

Request Parameters
name type description default constraints
name path Package name    
embed query    
page query 1 int
pageSize query -1 int
perms query false boolean
q query    
sort query name  
Response Codes
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.
Response Body
media type data type description
application/json PagedConstructInPackageListResponse (JSON) List of constructs

Example

Request
GET /devtools/packages/{name}/constructs
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "deletefolder", "linkoverview" ],
    "property2" : [ "update", "updateform" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /devtools/packages/{name}/contentrepositories

Get the ContentRepositories in a package.
The result can be filtered by

  • name
  • crType
and sorted by
  • name
  • crType

Request Parameters
name type description default constraints
name path Package name    
embed query    
page query 1 int
pageSize query -1 int
perms query false boolean
q query    
sort query name  
Response Codes
code condition
200 List of ContentRepositories 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.
Response Body
media type data type description
application/json PagedContentRepositoryInPackageListResponse (JSON) List of ContentRepositories

Example

Request
GET /devtools/packages/{name}/contentrepositories
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "createitems", "readitems" ],
    "property2" : [ "readtemplates", "updateconstructs" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /devtools/packages/{name}/cr_fragments

Get the ContentRepository Fragments in a package.
The result can be filtered by

  • name
and sorted by
  • name

Request Parameters
name type description default constraints
name path Package name    
embed query    
page query 1 int
pageSize query -1 int
perms query false boolean
q query    
sort query name  
Response Codes
code condition
200 List of ContentRepository Fragments 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.
Response Body
media type data type description
application/json PagedContentRepositoryFragmentInPackageListResponse (JSON) List of ContentRepository Fragments

Example

Request
GET /devtools/packages/{name}/cr_fragments
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "updateconstructs", "updateform" ],
    "property2" : [ "createtemplates", "wastebin" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /devtools/packages/{name}/datasources

Get the datasources in a package.
The result can be filtered by

  • name
and sorted by
  • name

Request Parameters
name type description default constraints
name path Package name    
page query 1 int
pageSize query -1 int
perms query false boolean
q query    
sort query name  
Response Codes
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.
Response Body
media type data type description
application/json PagedDatasourceInPackageListResponse (JSON) List of datasources

Example

Request
GET /devtools/packages/{name}/datasources
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "userassignment", "createitems" ],
    "property2" : [ "createfolder", "updateconstructs" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/packages/{name}/fs2cms

Trigger synchronization of all objects in the given package to the cms

Request Parameters
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
Response Codes
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.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
PUT /devtools/packages/{name}/fs2cms
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /devtools/packages/{name}/objectproperties

Get the object properties in a package.
The result can be filtered by

  • name
  • description
  • keyword
and sorted by
  • name
  • description
  • keyword
  • type
  • required
  • inheritable
  • construct.name

Request Parameters
name type description default constraints
name path Package name    
embed query    
page query 1 int
pageSize query -1 int
perms query false boolean
q query    
sort query name  
Response Codes
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.
Response Body
media type data type description
application/json PagedObjectPropertyInPackageListResponse (JSON) List of object properties

Example

Request
GET /devtools/packages/{name}/objectproperties
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "read", "updateconstructs" ],
    "property2" : [ "updateform", "updateitems" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /devtools/packages/{name}/templates

Get the templates of a package.
The result can be filtered by

  • name
  • description
and sorted by
  • name
  • description

Request Parameters
name type description default constraints
name path Package name    
page query 1 int
pageSize query -1 int
perms query false boolean
q query    
sort query name  
Response Codes
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.
Response Body
media type data type description
application/json PagedTemplateInPackageListResponse (JSON) List of templates

Example

Request
GET /devtools/packages/{name}/templates
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "translatepages", "updateinheritance" ],
    "property2" : [ "inheritance", "updatetemplates" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /devtools/preview/page/{id}

Get self refreshing live preview of the given page

Request Parameters
name type description
id path page ID
nodeId query node ID
Response Codes
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.
Response Body
media type data type description
text/html string HTML page that contains the live preview of the page was iframe.

Example

Request
GET /devtools/preview/page/{id}
Content-Type: */*
Accept: text/html

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/html

                
...

DELETE /devtools/nodes/{nodeId}/packages/{packageName}

Remove the package from the node. It is not possible to remove packages from channels

Request Parameters
name type description
nodeId path node ID (either global or local)
packageName path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) generic response

Example

Request
DELETE /devtools/nodes/{nodeId}/packages/{packageName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

PUT /devtools/nodes/{nodeId}/packages/{packageName}

Add the package to the node. It is not possible to add packages to channels

Request Parameters
name type description
nodeId path node ID (either global or local)
packageName path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) generic response

Example

Request
PUT /devtools/nodes/{nodeId}/packages/{packageName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /devtools/package/{name}/check/result

Get the result from the package consistency check if available

Request Parameters
name type description
name path name of the package
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) the result of the check

Example

Request
GET /devtools/package/{name}/check/result
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /devtools/packages/{name}/constructs/{construct}

Remove a construct from a package

Request Parameters
name type description
construct path construct ID (internal or global) or keyword
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/packages/{name}/constructs/{construct}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/packages/{name}/constructs/{construct}

Get the construct from the package

Request Parameters
name type description
construct path construct ID (internal or global) or keyword
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json ConstructLoadResponse (JSON) construct response

Example

Request
GET /devtools/packages/{name}/constructs/{construct}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "construct" : {
    "keyword" : "...",
    "mayBeSubtag" : true,
    "mayContainSubtags" : true,
    "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,
    "category" : {
      "name" : "...",
      "constructs" : {
        "property1" : { },
        "property2" : { }
      },
      "id" : 12345,
      "globalId" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "sortOrder" : 12345
    },
    "externalEditorUrl" : "...",
    "parts" : [ {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "DATASOURCE",
      "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" : "TEMPLATETAG",
      "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" : "...",
    "openEditorOnInsert" : true,
    "editorControlStyle" : "CLICK",
    "editorControlsInside" : true,
    "categoryId" : 12345
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/packages/{name}/constructs/{construct}

Add a construct to a package

Request Parameters
name type description
construct path construct ID (internal or global) or keyword
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
PUT /devtools/packages/{name}/constructs/{construct}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /devtools/packages/{name}/contentrepositories/{contentrepository}

Remove a ContentRepository from a package

Request Parameters
name type description
contentrepository path ContentRepository name, local ID or global ID
name path Package name
Response Codes
code condition
204 The ContentRepository was removed from the package.
404 Either package {name} does not exist, or it does not contain {contentrepository}.
409 {contentrepository} 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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/packages/{name}/contentrepositories/{contentrepository}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/packages/{name}/contentrepositories/{contentrepository}

Get the ContentRepository in a package

Request Parameters
name type description
contentrepository path ContentRepository name, local ID or global ID
name path Package name
Response Codes
code condition
200 ContentRepository is returned for package.
404 Either package {name} does not exist, or it does not contain {contentrepository}.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions on the devtools.
405 Feature devtools is not activated.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) ContentRepository response

Example

Request
GET /devtools/packages/{name}/contentrepositories/{contentrepository}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "contentRepository" : {
    "id" : 12345,
    "name" : "...",
    "crType" : "cr",
    "dbType" : "...",
    "username" : "...",
    "usernameProperty" : "...",
    "password" : "...",
    "passwordProperty" : "...",
    "http2" : true,
    "passwordType" : "none",
    "url" : "...",
    "urlProperty" : "...",
    "basepath" : "...",
    "basepathProperty" : "...",
    "instantPublishing" : true,
    "languageInformation" : true,
    "permissionInformation" : true,
    "permissionProperty" : "...",
    "defaultPermission" : "...",
    "diffDelete" : true,
    "elasticsearch" : {
      "page" : { },
      "file" : { },
      "folder" : { }
    },
    "projectPerNode" : true,
    "version" : "...",
    "checkDate" : 12345,
    "checkStatus" : "error",
    "checkResult" : "...",
    "statusDate" : 12345,
    "dataStatus" : "error",
    "dataCheckResult" : "...",
    "noFoldersIndex" : true,
    "noFilesIndex" : true,
    "noPagesIndex" : true,
    "noFormsIndex" : true,
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/packages/{name}/contentrepositories/{contentrepository}

Add a ContentRepository to a package

Request Parameters
name type description
contentrepository path ContentRepository name, local ID or global ID
name path Package name
Response Codes
code condition
201 The ContentRepository was added to the package.
404 Either the package {name} or the {contentrepository} does not exist.
409 {contentrepository} 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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
PUT /devtools/packages/{name}/contentrepositories/{contentrepository}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /devtools/packages/{name}/cr_fragments/{cr_fragment}

Remove a ContentRepository Fragment from a package

Request Parameters
name type description
cr_fragment path ContentRepository Fragment name, local ID or global ID
name path Package name
Response Codes
code condition
204 The ContentRepository Fragment was removed from the package.
404 Either package {name} does not exist, or it does not contain {cr_fragment}.
409 {cr_fragment} 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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/packages/{name}/cr_fragments/{cr_fragment}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/packages/{name}/cr_fragments/{cr_fragment}

Get the ContentRepository Fragment in a package

Request Parameters
name type description
cr_fragment path ContentRepository Fragment name, local ID or global ID
name path Package name
Response Codes
code condition
200 ContentRepository Fragment is returned for package.
404 Either package {name} does not exist, or it does not contain {cr_fragment}.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions on the devtools.
405 Feature devtools is not activated.
Response Body
media type data type description
application/json ContentRepositoryFragmentResponse (JSON) ContentRepository Fragment response

Example

Request
GET /devtools/packages/{name}/cr_fragments/{cr_fragment}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "contentRepositoryFragment" : {
    "id" : 12345,
    "name" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/packages/{name}/cr_fragments/{cr_fragment}

Add a ContentRepository Fragment to a package

Request Parameters
name type description
cr_fragment path ContentRepository Fragment name, local ID or global ID
name path Package name
Response Codes
code condition
201 The ContentRepository Fragment was added to the package.
404 Either the package {name} or the {cr_fragment} does not exist.
409 {cr_fragment} 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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
PUT /devtools/packages/{name}/cr_fragments/{cr_fragment}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /devtools/packages/{name}/datasources/{datasource}

Remove a datasource from a package

Request Parameters
name type description
datasource path datasource name
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/packages/{name}/datasources/{datasource}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/packages/{name}/datasources/{datasource}

Get the datasource in a package

Request Parameters
name type description
datasource path datasource name
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json DatasourceLoadResponse (JSON) datasource response

Example

Request
GET /devtools/packages/{name}/datasources/{datasource}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "datasource" : {
    "id" : 12345,
    "globalId" : "...",
    "type" : "SITEMINDER",
    "name" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/packages/{name}/datasources/{datasource}

Add a datasource to a package

Request Parameters
name type description
datasource path datasource name
name path Package name
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
PUT /devtools/packages/{name}/datasources/{datasource}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /devtools/packages/{name}/objectproperties/{objectproperty}

Remove an object property from a package

Request Parameters
name type description
name path Package name
objectproperty path object property keyword
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/packages/{name}/objectproperties/{objectproperty}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/packages/{name}/objectproperties/{objectproperty}

Get the object property in a package

Request Parameters
name type description
name path Package name
objectproperty path object property keyword
Response Codes
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.
Response Body
media type data type description
application/json ObjectPropertyLoadResponse (JSON) object property response

Example

Request
GET /devtools/packages/{name}/objectproperties/{objectproperty}
Content-Type: */*
Accept: application/json

                
...
Response
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" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "category" : { },
      "externalEditorUrl" : "...",
      "parts" : [ { }, { } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "openEditorOnInsert" : true,
      "editorControlStyle" : "ASIDE",
      "editorControlsInside" : true,
      "categoryId" : 12345
    },
    "required" : true,
    "inheritable" : true,
    "syncContentset" : true,
    "syncChannelset" : true,
    "syncVariants" : true,
    "restricted" : 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" : "..."
  }
}

PUT /devtools/packages/{name}/objectproperties/{objectproperty}

Add an object property to a package

Request Parameters
name type description
name path Package name
objectproperty path object property keyword
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
PUT /devtools/packages/{name}/objectproperties/{objectproperty}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /devtools/packages/{name}/templates/{template}

Remove a template from a package

Request Parameters
name type description
name path Package name
template path global template ID (uuid)
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
DELETE /devtools/packages/{name}/templates/{template}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /devtools/packages/{name}/templates/{template}

Get the template in the package

Request Parameters
name type description
name path Package name
template path global template ID (uuid)
Response Codes
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.
Response Body
media type data type description
application/json TemplateLoadResponse (JSON) template response

Example

Request
GET /devtools/packages/{name}/templates/{template}
Content-Type: */*
Accept: application/json

                
...
Response
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" : "...",
      "feature" : "...",
      "excludeFromPublishing" : true
    },
    "inherited" : true,
    "folderId" : 12345,
    "masterId" : 12345,
    "path" : "...",
    "templateTags" : {
      "property1" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "objectTags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "source" : "...",
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /devtools/packages/{name}/templates/{template}

Add a template to a package

Request Parameters
name type description
name path Package name
template path global template ID (uuid)
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response

Example

Request
PUT /devtools/packages/{name}/templates/{template}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...