Site Folder Scalars

A site folder contains a set of scalars that store information about the site. Site folder scalars have read-only access. Therefore, an application cannot set scalar values for a site folder.

A site folder has the following scalars:

Site name

String. Read-only access. Name of the site. The site name is specified when the site is created and cannot be changed.

Parent site

String. Read-only access. Site code for the site's parent site. The parent site is directly above the child site in the site hierarchy. If the site has no parent site, the string is empty.

Depth

Integer. Read-only access. Number of levels that the site is nested beneath the current site. For example, a site directly beneath the current site would have a depth of 1, and a site directly below that site would have a depth of 2. The current site has a depth of 0.

Status

String. Read-only access. Last reported installation status for the site. Status can have the following values:

"Active"

Site is installed and running.

"Pending"

Site is in the process of being installed.

"Failed"

Site could not be installed.

"Deleted"

Site is in the process of being deleted.

"Upgrade"

Site is in the process of being upgraded.

Site type

String. Read-only access. Type of site. Site type can have the following values:

"Primary"

Site is a primary site.

"Secondary"

Site is a secondary site.