1. REST API for Sites Management
  2. Tasks
  3. Settings

Get an Example Request Body for Editing Sites Management Settings Resources

get

/sites/management/api/v1/settings/edit-form

EDIT FORM

Get a template request body suitable for editing sites management settings instances.The edit-form resource is used as a template for clients to determine which properties are updateable when editing a Sites Management Settings.The response will contain all the property values that can be edited. These properties can either be edited or discarded and then used as the request body to edit a Sites Management Settings.

Introduced in release 20.1.2.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK

Request

GET https://api.example.com/sites/management/api/v1/settings/edit-form

Response Body

{
  "allowSiteCreation": false,
  "governanceEnabled": false,
  "siteSecurityPolicy": {
    "level": "service",
    "appliesTo": "named"
  },
  "siteAdminOnlyOperations": {
    "siteCreation": false,
    "templateCreation": false,
    "themeCreation": false,
    "componentCreation": false
  },
  "prerender": {
    "enabled": false,
    "userAgents": "AdsBot-Google,AdsBot-Google-Mobile-Apps,AppEngine-Google"
  },
  "expiration": {
    "action": "nothing",
    "deleteAfter": 30
  }
}

Request

Query Parameters

  • Comma-delimited string of field names that should not be included in the response.

  • Comma-separated list of link relation names to exclude from the response.

  • Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

  • Comma-separated list of link relation names to include in the response. By default, all links are returned.

    The following links are provided by this resource:

    Link RelationshipDescription
    parentDescribes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
    selfDescribes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
    canonicalDescribes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
    editDescribes where the resource can be edited. Used on singular resources to indicate where a patch can be performed to edit an existing resource.
    describedByDescribes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Type: object
Show Source

  • Allow your service users to create sites. When you enable the ability to create sites, you allow all users to create templates and sites. If you disable site creation, users can still see and work with templates and other folders in the hierarchy. Users can also still work with an existing site if the site is shared with them. They can view, edit, and manage the site, depending on their role. When you enable sites functionality, users have the ability to publish any content they have access to, including confidential information. You might want to limit your users to creating only secured sites, so that users have to sign in before they can see the site content. For even more security, you can limit site creation to administrators.

    Introduced in release 20.1.2.
  • expiration

    Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.

    Introduced in release 20.3.1.

  • Enable governance for sites to simplify and accelerate site delivery for business users, who are not site administrators, while giving site administrators an easy way to control and track sites from a centralized location.

    Introduced in release 20.1.2.
  • links

    HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

  • prerender

    Prerender service settings such as whether the prerender service is enabled.

    Introduced in release 20.1.2.
  • siteAdminOnlyOperations

    Restrict site, template, theme and component creation to site administrators.

    Introduced in release 20.1.2.
  • siteSecurityPolicy

    Specify the minimum security allowed for online sites.

    Introduced in release 20.1.2.
Nested Schema : expiration
Type: object

Site expiration settings such as whether sites are automatically taken offline and deleted when the site expires.

Introduced in release 20.3.1.
Show Source

  • What action to take when the site expires. This can be do nothing. If the site is online the site will remain online. The deactivate action takes the site offline after the site expires. The delete action takes the site offline after the site expires and also deletes the site. The site is deleted using the days after to determine how long after expiration before the site is deleted.

    Valid values are:

    • nothing - Site is left online and is not deleted
    • deactivate - Site is taken offline when the site expires
    • delete - Site is taken offline when the site expires and deleted after a configurable number of days after expiration

    Introduced in release 20.3.1.
  • Minimum Value: 3
    Maximum Value: 90

    Number of days to wait after a site expires before deleting the site. This setting is only used if the action selected is to delete expired sites. This setting can still be set if site deletion is disabled; the setting value will just be ignored.

    Introduced in release 20.3.1.
Nested Schema : links
Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source
Nested Schema : prerender
Type: object

Prerender service settings such as whether the prerender service is enabled.

Introduced in release 20.1.2.
Show Source

  • Enable or disable the Prerender Service.

    Introduced in release 20.1.2.

  • Comma-separated list of user-agent product names that, if detected, will cause the client (crawlers and bots) to be redirected to the pre-render generated cached site content. Oracle Content Management has a built in list of crawlers and bots with is combined with this custom user-agent product names.

    Introduced in release 20.1.2.
Nested Schema : siteAdminOnlyOperations
Type: object

Restrict site, template, theme and component creation to site administrators.

Introduced in release 20.1.2.
Show Source
Nested Schema : siteSecurityPolicy
Type: object

Specify the minimum security allowed for online sites.

Introduced in release 20.1.2.
Show Source

  • Define which types of users may access a site. Can include all users or be restricted to named users only.

    Valid values are:

    • named - Only named users within a specified level can access
    • all - All users within a specified level can access

  • Maximum open security level that can be set on a site.

    Valid values are:

    • service - Only service users
    • cloud - Only cloud users who can sign in to your domain
    • everyone - Anyone without signing in

Nested Schema : items
Match All
Show Source
  • Link
Example Response ()
{
    "allowSiteCreation":false,
    "governanceEnabled":false,
    "siteSecurityPolicy":{
        "level":"service",
        "appliesTo":"named"
    },
    "siteAdminOnlyOperations":{
        "siteCreation":false,
        "templateCreation":false,
        "themeCreation":false,
        "componentCreation":false
    },
    "prerender":{
        "enabled":false,
        "userAgents":"AdsBot-Google,AdsBot-Google-Mobile-Apps,AppEngine-Google"
    },
    "expiration":{
        "action":"nothing",
        "deleteAfter":30
    }
}

400 Response

Bad Request

401 Response

Unauthorized

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top