Jump to

• Request
• Response
• Examples

Get a site interface

get

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

Request

Path Parameters

• id: integer
  The unique identifier of the site interface.

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

• createdTime(optional): string
  The date and time when the site interface was created. This attribute is read-only.
• displayName(optional): string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The display name of the site interface.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the site interface.
• language(optional): 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(optional): string
  Maximum Length: 255

  The name used to look up the site interface.
• name(optional): string
  Maximum Length: 40

  Pattern: ^[a-z0-9][a-z0-9_]*$

  The name of the site interface.
• updatedTime(optional): string
  The date and time when the site interface was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the site interface was last updated. This attribute is read-only."
        },
        "displayName":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The display name of the site interface.",
            "maxLength":40
        },
        "name":{
            "pattern":"^[a-z0-9][a-z0-9_]*$",
            "type":"string",
            "description":"The name of the site interface.",
            "maxLength":40
        },
        "language":{
            "type":"object",
            "description":"The language associated with the interface.",
            "$ref":"#/definitions/namedIDs-siteInterfaces-language"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the site interface.",
            "maxLength":255
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the site interface was created. This attribute is read-only."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the site interface.",
            "maximum":9.223372036854776E18
        }
    }
}

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(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

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