Jump to

• Request
• Response
• Examples

Get interface mapping

get

/km/api/v1/views/getInterfaceMapping

This method returns a list of RnInterfaces based on the parameters that are passed in. There are different ways the caller can call this method. First, the method can be called without specifying any parameters in which case all of the RnInterfaces will be returned. The user may also call the method while supplying the interfaceId or the viewId parameter. The user may not specify both the interfaceId and the viewId values.

Parameters for this service are:

• interfaceId - RN interface Id value for the RnInterface to be retrieved.

• viewId - All RN interfaces that contains the view specified by the view's record id is retrieved.

Yields Errors:

• OK-SEC0001 - If a user does not have required permission to call this service..
• OK-GEN0030 - When both interfaceId and viewId is not null and not empty.

Example URIs

The example URIs for this method are as follows:

• http://<IM_REST_API_HOST>/km/api/latest/views/getInterfaceMapping?interfaceId={id}&viewId={viewId}

  The request returns all RnInterfaces or ones that matches the passed in interfaceId or viewId.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• interfaceId(optional): integer
  $iqutil.fixForJSonString(${acParam.getDocumentation()})
• viewId: string
  $iqutil.fixForJSonString(${acParam.getDocumentation()})

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : ResultList RnInterface

Type: object

Title: ResultList RnInterface

Match All

Show Source

• allOf Collection Paging Resource
  Title: Collection Paging Resource

  Oracle base collection resource schema definition.
• object ResultList RnInterface-allOf[1]

{
    "title":"ResultList RnInterface",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/collectionPagedResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/RnInterface"
                    }
                }
            }
        }
    ]
}

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

Show Source

• allOf Base Collection Resource
  Title: Base Collection Resource

  Oracle base collection resource schema definition.
• object Collection Paging Resource-allOf[1]

{
    "title":"Collection Paging Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/collectionBaseResource"
        },
        {
            "properties":{
                "hasMore":{
                    "type":"boolean",
                    "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual paging size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Number of resource instances returned in the current range."
                },
                "offset":{
                    "type":"integer",
                    "description":"Offset value used in the current page. "
                }
            }
        }
    ]
}

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object Base Collection Resource-allOf[1]

{
    "title":"Base Collection Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : Base Collection Resource-allOf[1]

Type: object

Show Source

• items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

• count(optional): integer
  Number of resource instances returned in the current range.
• hasMore(optional): boolean
  Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
• limit(optional): integer
  Actual paging size used by the server.
• offset(optional): integer
  Offset value used in the current page.
• totalResults(optional): integer
  Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.

{
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
        },
        "limit":{
            "type":"integer",
            "description":"Actual paging size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Number of resource instances returned in the current range."
        },
        "offset":{
            "type":"integer",
            "description":"Offset value used in the current page. "
        }
    }
}

Nested Schema : ResultList RnInterface-allOf[1]

Type: object

Show Source

• items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RnInterface"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href: string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  HTTP method for requesting the target of the link.
• profile(optional): string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel: string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated(optional): boolean
  Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

• Array of: RnInterface

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RnInterface"
    }
}

Nested Schema : RnInterface

Match All

Show Source

• allOf RnInterfaceData
• object RnInterface-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RnInterfaceData"
        },
        {
            "properties":{
                "interfaceLocale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"Relationship to interfaceLocale"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"Relationship to Locale"
                },
                "view":{
                    "$ref":"#/definitions/ViewKey",
                    "description":"Relationship to View"
                },
                "ownswerSite":{
                    "$ref":"#/definitions/ViewKey",
                    "description":"Relationship to View"
                }
            }
        }
    ]
}

Nested Schema : RnInterfaceData

Match All

Show Source

• object RnInterfaceKey
  Title: RnInterfaceKey
• object RnInterfaceData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RnInterfaceKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the RnInterface object was created or added"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the RnInterface object was last modified."
                }
            }
        }
    ]
}

Nested Schema : RnInterfaceKey

Type: object

Title: RnInterfaceKey

Show Source

• interfaceId(optional): integer
  A RightNow interface Id.
• recordId(optional): string
  A GUID of the RnInterface record.

{
    "title":"RnInterfaceKey",
    "properties":{
        "recordId":{
            "type":"string",
            "description":"A GUID of the RnInterface record."
        },
        "interfaceId":{
            "type":"integer",
            "description":"A RightNow interface Id."
        }
    }
}

Nested Schema : RnInterfaceData-allOf[1]

Type: object

Show Source

• dateAdded(optional): string(date-time)
  The date when the RnInterface object was created or added
• dateModified(optional): string(date-time)
  The date when the RnInterface object was last modified.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the RnInterface object was created or added"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the RnInterface object was last modified."
        }
    }
}

Nested Schema : RnInterface-allOf[1]

Type: object

Show Source

• interfaceLocale(optional): LocaleKey
• locale(optional): LocaleKey
• ownswerSite(optional): ViewKey
• view(optional): ViewKey

{
    "properties":{
        "interfaceLocale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"Relationship to interfaceLocale"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"Relationship to Locale"
        },
        "view":{
            "$ref":"#/definitions/ViewKey",
            "description":"Relationship to View"
        },
        "ownswerSite":{
            "$ref":"#/definitions/ViewKey",
            "description":"Relationship to View"
        }
    }
}

Nested Schema : LocaleKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object LocaleKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : ViewKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object ViewKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"GUID of the SITE table containing the view definition"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"Non localized reference key for the view"
                },
                "name":{
                    "type":"string",
                    "description":"Localized name of the view"
                }
            }
        }
    ]
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

Nested Schema : ViewKey-allOf[1]

Type: object

Show Source

• name(optional): string
  Localized name of the view
• recordId(optional): string
  GUID of the SITE table containing the view definition
• referenceKey(optional): string
  Non localized reference key for the view

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"GUID of the SITE table containing the view definition"
        },
        "referenceKey":{
            "type":"string",
            "description":"Non localized reference key for the view"
        },
        "name":{
            "type":"string",
            "description":"Localized name of the view"
        }
    }
}

Back to Top

Examples

The following example shows how to find a list of Service Cloud interfaces or a specific interface depending upon on the parameters specified in the HTTP request by submitting a GET request on the REST resource using cURL.

cURL Command Example

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/views/getInterfaceMapping

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Response Body Example

The following shows an example of the response body in JSON format.

{
  "items" : [ {
    "interfaceLocale" : {
      "recordId" : "RECORDID_VALUE",
      "links" : [ {
        "rel" : "canonical",
        "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
        "mediaType" : "application/json, application/xml",
        "templated" : true,
        "method" : "GET",
        "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
      } ]
    },
    "locale" : {
      "recordId" : "RECORDID_VALUE",
      "links" : [ {
        "rel" : "canonical",
        "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
        "mediaType" : "application/json, application/xml",
        "templated" : true,
        "method" : "GET",
        "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
      } ]
    },
    "view" : {
      "recordId" : "RECORDID_VALUE",
      "referenceKey" : "REFERENCEKEY_VALUE",
      "name" : "NAME_VALUE",
      "links" : [ {
        "rel" : "canonical",
        "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
        "mediaType" : "application/json, application/xml",
        "templated" : true,
        "method" : "GET",
        "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
      } ]
    },
    "ownswerSite" : {
      "recordId" : "RECORDID_VALUE",
      "referenceKey" : "REFERENCEKEY_VALUE",
      "name" : "NAME_VALUE",
      "links" : [ {
        "rel" : "canonical",
        "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
        "mediaType" : "application/json, application/xml",
        "templated" : true,
        "method" : "GET",
        "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
      } ]
    },
    "recordId" : "RECORDID_VALUE",
    "interfaceId" : 1489437844511,
    "dateAdded" : "246907782-08-17T14:35:07-0500",
    "dateModified" : "8927405-06-27T13:57:46-0500"
  ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 1
}

Back to Top