createSite

Function

Create a new Hub Site

Minimum properties are name and org

Parameters

Parameter Type Default Notes
partialSite Required Partial<IHubSite>
requestOptions Required IHubRequestOptions

Available requestOptions

Property Type Notes
authentication Optional UserSession
hubApiUrl Optional string
isPortal Optional boolean
portalSelf Optional IHubRequestOptionsPortalSelf

Returns

Promise<IHubSite>
Property Type Notes
capabilities string[]

Array of capabilities enabled for the site

catalog {
groups:
string[]
} [key: string]: any

Currently not an actual ICatalog

clientId string

oAuth Client Id for the Site

contentViews Record<stringany>

Content Views settings

customHostname string

Custom Domain Name

defaultExtent IExtent

Default extent used when loading maps on the site

defaultHostname string

Full hostname Looks like<subdomain>-<org-key>.hub.arcgis.com

feeds Record<stringany>

Feed configurations

headerSass string

Header CSS

map Record<stringany>

Default map configuration for the site

pages Array<{
id:
string
slug:
string
title:
string
}>

Array of minimal page objects

subdomain string

Subdomain of the site Will be prepended to <org-key>.hub.arcgis.com

telemetry Record<stringany>

Site Telemetry Settings

theme Record<stringany>

Site Theme as json

createdDate Inherited Date

Date the entity was created

createdDateSource Inherited string

Source of the creation date as a property path e.q item.created

id Inherited string

Id of the entity as a string

name Inherited string

Name of the Entity For Entities backed by items, this is typically the title

orgUrlKey Inherited string

Organization urlKey used to construct the slug

owner Inherited string

Username of the owner of the item

tags Inherited string[]

User configurable tags

type Inherited string

For Item backed results, this will be item.type Otherwise it will be "Group", "User", "Event" etc

updatedDate Inherited Date

Date when the entity was last updated Depending on the entity, this could be derived in many different ways

updatedDateSource Inherited string

Source of the updated date

boundary Optional Inherited IHubGeography

boundary will default to the item extent but can be overwritten by enrichments from the Hub API (inline) or fetched from a location such as /resources/boundary.json

culture Optional Inherited string

Culture code of the content i.e. en-us

description Optional Inherited string

Description for the item

layout Optional Inherited IHubLayout

Layout property

slug Optional Inherited string

Slug that can be used to lookup an entity by something other than it's id

source Optional Inherited string

Source of the entity. Exact logic for this tbd, but the intent is to allow the result to be attributed to something other than "owner"

summary Optional Inherited string

Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc

thumbnailUrl Optional Inherited string

Thumbnail Uril (read-only)

typeKeywords Optional Inherited string[]

System configurable typekeywords

url Optional Inherited string

Canonical Url for the Entity


Function defined in common/src/sites/HubSites.ts:266