Skip to content

items.GetSiteByTitle

Overview

This is the "GetSiteByTitle method" of the "Items Object". It gets site information based on the specified title.

Limitations

1.5.10.0

  1. When run by a user who does not have the "Site Administration Permission" for the site to get (excluding Privileged Users), SiteSettings (the site settings, such as the labels and choices of the items) cannot be retrieved. This also applies to tenant managers who do not have the "Site Administration Permission". Site information such as SiteId and Title can be retrieved. In processing that refers to SiteSettings, make sure that it has a value before using it.

Syntax

items.GetSiteByTitle(title)

Parameters

Parameter Type Required Description
title object Yes Specify the site title

Return Value

Return an array of "apiModel" for the corresponding site.

In version 1.5.10.0 and later, the API key in the AI integration settings of SiteSettings is masked (********).

Usage Examples

The following example gets site information with the title "Division Master" and outputs it to the log.

const sites = Array.from(items.GetSiteByTitle('Division Master'));
if (sites.length) {
    sites.forEach(site => {
        context.Log(site.SiteId);
        context.Log(site.Title);
        context.Log(site.ReferenceType);
    })
}

Supported Versions

Supported Version Details
1.5.10.0 and later Changed so that SiteSettings cannot be retrieved when run by a user without the "Site Administration Permission"