Get a site interface
get
/services/rest/connect/v1.4/siteInterfaces/{id}
Request
Path Parameters
-
id(required): integer
The unique identifier of the site interface.
Response
Default Response
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
-
createdTime:
string
The date and time when the site interface was created. This attribute is read-only.
-
displayName:
string
Maximum Length:
40
Pattern:^[^ ]*$
The display name of the site interface. -
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the site interface. -
language:
object 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.
-
lookupName:
string
Maximum Length:
255
The name used to look up the site interface. -
name:
string
Maximum Length:
40
Pattern:^[a-z0-9][a-z0-9_]*$
The name of the site interface. -
updatedTime:
string
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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"
}
]
}