Get a site interface

get

/services/rest/connect/v1.4/siteInterfaces/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
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
  • The date and time when the site interface was created. This attribute is read-only.
  • Maximum Length: 40
    Pattern: ^[^ ]*$
    The display name of the site interface.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the site interface.
  • namedIDs-siteInterfaces-language
    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.
  • Maximum Length: 255
    The name used to look up the site interface.
  • Maximum Length: 40
    Pattern: ^[a-z0-9][a-z0-9_]*$
    The name of the site interface.
  • The date and time when the site interface was last updated. This attribute is read-only.
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
Back to Top

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"
    }
  ]
}
Back to Top