Get Portal By Name

Get Portal By Name

Retrieves the portal corresponding to the name.

Request
URI
GET
https://{api_host}/api/portals/name/{name}
COPY
Path Parameters
string
name
Required

The name of the portal to get

Responses
200

successful operation

Returns Portal of type(s) */* 
{
    "portletConfigurations": [
        {
            "mode": "string",
            "id": "string",
            "state": "string",
            "extensionId": "string"
        }
    ],
    "columnLengths": [
        0
    ],
    "name": "string",
    "tenantId": "string",
    "layoutType": "string",
    "id": "string",
    "userId": "string"
}
array of PortletConfiguration
portletConfigurations
Optional

portletConfigurations

array of integer
columnLengths
Optional

columnLengths

string
name
Optional

name

string
tenantId
Optional

tenantId

string
layoutType
Optional

layoutType

Possible values are : SINGLE_COLUMN, TWO_COLUMN_EVEN, TWO_COLUMN_WIDE_RIGHT, TWO_COLUMN_WIDE_LEFT, THREE_COLUMN_EVEN, THREE_COLUMN_WIDE_CENTER, FOUR_COLUMN_EVEN,
string As uuid As uuid
id
Optional

id

string
userId
Optional

userId


On This Page
Portal Operations
POST
Create Portal
DELETE
Delete Portal
GET
Get Portal By Id
GET
Get Portal By Name
PUT
Update Or Create Portal