Retrieve an instance of siteInterfaces

get

/services/rest/connect/latest/siteInterfaces/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name.
Root Schema : siteInterfaces
Type: object
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name.
Show Source
Nested Schema : namedIDs-siteInterfaces-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use GET with the following syntax to retrieve data for a site interface:

https://your_site_interface/services/rest/connect/version/siteInterfaces/interface_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/2

Response body example

{
  "id": 2,
  "lookupName": "mysite_2",
  "displayName": "mysite_2",
  "language": {
    "id": 8,
    "lookupName": "fr_CA"
  },
  "name": "mysite_2",
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/2"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/2"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/siteInterfaces",
      "mediaType": "application/schema+json"
    }
  ]
}