Get a site by name.
GET /users/site/name/{name}
Operation id: SiteService_GetSite
Description
This is a convenience level above GetWorkspace.
Permission Level: Read
Tags: SiteService
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the site, Required = true |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
includeUsers | boolean | No | Whether to include list of users who belong to the site. Required : false |
tenantId | string | No | TenantId of the site. Required: false (False as this can be inferred from the token) |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
name | string | No | |
parent | string | No | |
ancestors | array | No | |
descendants | array | No | |
displayName | string | No | |
creationTime | string (date-time) | No | |
attributes | array | No | |
users | array | No | |
domain | string | No | |
enabledScopes | object | No | |
description | string | No | |
siteType | string | No | |
siteTier | string | No | |
isHierarchyNode | boolean | No | True if is a Retail Operating Model "Hierarchy Node", false if it is a Retail Operating Model "Site". Defaults to a Retail Operating Model "Site" if not included. |
siteTypeDisplayName | string | No | |
siteTierDisplayName | string | No | |
siteTemplateFriendlyName | string | No |
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"type": "string"
},
"ancestors": {
"type": "array",
"items": {
"type": "string"
}
},
"descendants": {
"type": "array",
"items": {
"type": "string"
}
},
"displayName": {
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"scope": {
"type": "string"
},
"fieldName": {
"type": "string"
},
"value": {
"type": "string"
},
"domain": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"description": "The ID of the tenant. Required: false. Defaults to the tenant of the user making the call."
},
"userId": {
"type": "string",
"description": "The user ID. Required: true."
},
"firstName": {
"type": "string",
"description": "The first name. Required: false."
},
"lastName": {
"type": "string",
"description": "The last name. Required: false."
}
}
}
},
"domain": {
"type": "string"
},
"enabledScopes": {
"type": "object"
},
"description": {
"type": "string"
},
"siteType": {
"type": "string"
},
"siteTier": {
"type": "string"
},
"isHierarchyNode": {
"type": "boolean",
"description": "True if is a Retail Operating Model \"Hierarchy Node\", false if it is a Retail Operating Model \"Site\".\nDefaults to a Retail Operating Model \"Site\" if not included."
},
"siteTypeDisplayName": {
"type": "string"
},
"siteTierDisplayName": {
"type": "string"
},
"siteTemplateFriendlyName": {
"type": "string"
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}