Sites
Global Operations
This version 1.0 sites service represents a Sites resource with CQ operations on the users collection and CRUDPA operations available for the site item. Items can have server version 1.0 subresources.
Resource path:
/global-config/sites
Resource version: 1.0
create
Create new site entry
Usage
am> create Sites --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "$schema" : "http://json-schema.org/draft-04/schema#", "description" : "Site schema.", "type" : "object", "title" : "Site schema", "properties" : { "_id" : { "type" : "string", "title" : "Name", "description" : "Site name." }, "id" : { "type" : "string", "title" : "Site id", "description" : "Site's unique identifier.", "javaName" : "siteId" }, "url" : { "type" : "string", "title" : "Primary URL", "description" : "Site primary URL." }, "secondaryURLs" : { "type" : "array", "title" : "Secondary URLs", "description" : "Secondary URLs for this site.", "items" : { "type" : "string" } }, "servers" : { "type" : "array", "title" : "Assigned Servers", "description" : "Servers assigned to this site.", "items" : { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Server id", "description" : "Server's unique identifier for the site." }, "url" : { "type" : "string", "title" : "Server URL", "description" : "Server URL of the site" } } } } } }
delete
Delete site entry
Usage
am> delete Sites --global --id id
Parameters
- --id
-
The unique identifier for the resource.
query
Query the collection of site entries
Usage
am> query Sites --global --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all. Fields that can be queried: [_id, url]
read
Read a site entry
Usage
am> read Sites --global --id id
Parameters
- --id
-
The unique identifier for the resource.
schema
Sites schema action that returns the sites schema json
Usage
am> action Sites --global --actionName schema
template
Sites template action that returns a template json object for site insert
Usage
am> action Sites --global --actionName template
update
Update a site entry
Usage
am> update Sites --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "$schema" : "http://json-schema.org/draft-04/schema#", "description" : "Site schema.", "type" : "object", "title" : "Site schema", "properties" : { "_id" : { "type" : "string", "title" : "Name", "description" : "Site name." }, "id" : { "type" : "string", "title" : "Site id", "description" : "Site's unique identifier.", "javaName" : "siteId" }, "url" : { "type" : "string", "title" : "Primary URL", "description" : "Site primary URL." }, "secondaryURLs" : { "type" : "array", "title" : "Secondary URLs", "description" : "Secondary URLs for this site.", "items" : { "type" : "string" } }, "servers" : { "type" : "array", "title" : "Assigned Servers", "description" : "Servers assigned to this site.", "items" : { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Server id", "description" : "Server's unique identifier for the site." }, "url" : { "type" : "string", "title" : "Server URL", "description" : "Server URL of the site" } } } } } }