Jump to

• Request
• Response
• Examples

Find all

get

/km/api/v1/replacementTokens

The replacement text value displays the token's replacement text translation for the specified Locale object. If the token does not have a translation for the specified Locale, then the method displays the token's name as the replacement text to indicate to the user that the token exists, but that there is no translation for the specified Locale.

You can specify the Locale by setting the localeId parameter of the kmauthtoken header when making requests to the Oracle Knowledge REST API. Alternatively, if no localeId parameter value is supplied, then the method interprets the specified Locale as the default Locale object assigned to the logged in user. In both the cases, the specified Locale is referred to as the session's Locale. The logged in user is the user for which the userToken attribute on the kmauthtoken header was created. Additionally, the Locale can be specified by the Accept-Language header value or by the langpref request parameter. In both the cases, we refer to specified Locale as the request's Locale. If both the Accept-Language header and the langpref request parameter are present, the Accept-Language header is used as the specified Locale.

This resource supports the orderBy request parameter. You can use this parameter along with the HTTP service request to sort the returned list.

You must get the schema and catalog of the resource for additional values that you can use with the orderBy parameter. To get the schema and catalog of the resource, you must use the GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get the schema and catalog of the resource is as follows:

• http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/replacmentTokens

Example URIs

The example URIs for this method are as follows:

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens

  The request returns a paginated list of ReplacementToken objects in FULL mode, with the replacement text displayed for the session's Locale.

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens?mode=KEY&limit=20&offset=0

  The request returns a paginated list of twenty ReplacementToken objects in KEY mode, starting with the ReplacementToken object at position 0 in the returned list, with the replacement text displayed for the session's Locale.

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens?langpref=es_ES

  The request returns a paginated list of ReplacementToken objects in FULL mode, with the replacement text displayed for the request's Locale, which was specified as Spanish.

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens, with Accept-Language header value 'it-IT'

  The request returns a paginated list of ReplacementToken objects in FULL mode, with the replacement text displayed for the request's Locale, which was specified as Italian.

---

---

Find by query

Supported Media Types: 'application/json', 'application/xml'

---

This method returns a list of ReplacementToken objects in the Oracle Knowledge Repository matching the specified criteria.

The replacement text value displays the token's replacement text translation for the specified Locale object. If the token does not have a translation for the specified Locale, then the method displays the token's name as the replacement text. This indicates to the user that the token exists, but that there is no translation for the specified Locale.

You can specify the Locale by setting the localeId parameter of the kmauthtoken header when making requests to the Oracle Knowledge REST API. Alternatively, if no localeId parameter value is supplied, then the method interprets the specified Locale as the default Locale object assigned to the logged in user. In both the cases, the specified Locale is referred to as the session's Locale. The logged in user is the user for which the userToken attribute on the kmauthtoken header was created. Additionally, the Locale can be specified by the Accept-Language header value or by the langpref request parameter. In both the cases, we refer to specified Locale as the request's Locale. If both the Accept-Language header and the langpref request parameter are present, the Accept-Language header is used as the specified Locale.

This resource supports the orderBy request parameter. You can use this parameter along with the HTTP service request to sort the returned list.

You must get the schema and catalog of the resource for additional values that you can use with the orderBy parameter. To get the schema and catalog of the resource, you must use the GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get the schema and catalog of the resource is as follows:

• http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/replacmentTokens/

Example URIs

The example URIs for this method are as follows:

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens?q=tokenName eq 'ORACLE_KNOWLEDGE'

  The request returns a paginated list of ReplacementToken objects in FULL mode with the tokenName ORACLE_KNOWLEDGE with the replacement text displayed for the session's Locale.

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens?q=tokenName in ('ORACLE_KNOWLEDGE', 'COPYRIGHT')

  The request returns a paginated list of ReplacementToken objects in FULL mode with the tokenName ORACLE_KNOWLEDGE or COPYRIGHT with the replacement text displayed for the session's Locale.

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens?q=replacementText likeAny ('*Oracle*')

  The request returns a paginated list of ReplacementToken objects in FULL mode with replacementText values that contain the word Oracle with the replacement text displayed for the session's Locale.

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens?q=tokenName eq 'ORACLE_KNOWLEDGE'&langpref=it_IT

  The request returns a paginated list of ReplacementToken objects in FULL mode with tokenName ORACLE_KNOWLEDGE with the replacement text displayed for the request's Locale, which was specified as Italian.

• http://<IM_REST_API_HOST>/km/api/latest/replacementTokens?q=tokenName in ('ORACLE_KNOWLEDGE', 'COPYRIGHT'), with Accept-Language header value fr_FR

  The request returns a paginated list of ReplacementToken objects in FULL mode with tokenName ORACLE_KNOWLEDGE or COPYRIGHT with the replacement text displayed for the request's Locale, which was specified as French.

Query Parameters

The following table describes the query parameters for this resource.

Parameter	Queryable	Sortable	Type	Description
recordId	Y	Y	'type' : 'string'	The replacement token's record Id.
tokenName	Y	Y	'type' : 'string'	The replacement token's name.
dateAdded	Y	Y	'type' : 'string', 'format' : 'date-time'	The date added for the replacement token for the specified locale.
dateModified	Y	Y	'type' : 'string', 'format' : 'date-time'	The date modified for the replacement token for the specified locale.
replacementText	Y	Y	'type' : 'string'	The HTML formatted replacement text.
replacementTextNonFormatted	Y	Y	'type' : 'string'	The non-HTML formatted replacement text.

Request

Query Parameters

• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• mode:
  This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.

  Allowed Values: [ "KEY", "DATA", "EXTENDED", "FULL" ]
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
• q: string
  Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : ResultList ReplacementToken

Type: object

Title: ResultList ReplacementToken

Match All

Show Source

• allOf Collection Paging Resource
  Title: Collection Paging Resource

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

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

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 ReplacementToken-allOf[1]

Type: object

Show Source

• items(optional): array items

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

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: ReplacementToken

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

Nested Schema : ReplacementToken

Match All

Show Source

• allOf ReplacementTokenKey
• object ReplacementToken-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/ReplacementTokenKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date added for the replacement token for the specified locale."
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date modified for the replacement token for the specified locale."
                },
                "replacementText":{
                    "type":"string",
                    "description":"The HTML formatted replacement text."
                },
                "replacementTextNonFormatted":{
                    "type":"string",
                    "description":"The non-HTML formatted replacement text."
                },
                "tokenType":{
                    "type":"string",
                    "description":"The token type of the token. Used to specify what kind of text editor was used to create/edit this token:  rich text('RICH_TEXT') or plain text('PLAIN_TEXT')."
                }
            }
        }
    ]
}

Nested Schema : ReplacementTokenKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The replacement token's record Id."
                },
                "tokenName":{
                    "type":"string",
                    "description":"The replacement token's name."
                }
            }
        }
    ]
}

Nested Schema : ReplacementTokenKey-allOf[1]

Type: object

Show Source

• recordId(optional): string
  The replacement token's record Id.
• tokenName(optional): string
  The replacement token's name.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The replacement token's record Id."
        },
        "tokenName":{
            "type":"string",
            "description":"The replacement token's name."
        }
    }
}

Nested Schema : ReplacementToken-allOf[1]

Type: object

Show Source

• dateAdded(optional): string(date-time)
  The date added for the replacement token for the specified locale.
• dateModified(optional): string(date-time)
  The date modified for the replacement token for the specified locale.
• replacementText(optional): string
  The HTML formatted replacement text.
• replacementTextNonFormatted(optional): string
  The non-HTML formatted replacement text.
• tokenType(optional): string
  The token type of the token. Used to specify what kind of text editor was used to create/edit this token: rich text('RICH_TEXT') or plain text('PLAIN_TEXT').

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The date added for the replacement token for the specified locale."
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date modified for the replacement token for the specified locale."
        },
        "replacementText":{
            "type":"string",
            "description":"The HTML formatted replacement text."
        },
        "replacementTextNonFormatted":{
            "type":"string",
            "description":"The non-HTML formatted replacement text."
        },
        "tokenType":{
            "type":"string",
            "description":"The token type of the token. Used to specify what kind of text editor was used to create/edit this token:  rich text('RICH_TEXT') or plain text('PLAIN_TEXT')."
        }
    }
}

Back to Top

Examples

The following example shows how to find the token replacement text-translation for the specified locale object by submitting a get request on the REST resource using cURL.

cURL Command

Command: curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/replacementTokens"

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"

Example of Response Body

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

{
  "items" : [ {
    "dateAdded" : "2013-04-30T21:35:18EDT",
    "dateModified" : "2013-04-30T21:35:18EDT",
    "replacementText" : "\n    \t<p><a href=\"http://www.oracle.com/us/products/applications/knowledge-management/index.html\">Oracle Knowledge</a></p>\n\t\t<p> </p>\n\t",
    "replacementTextNonFormatted" : "Oracle Knowledge",
    "tokenType" : "RICH_TEXT",
    "recordId" : "0121040772e9a860142e278b51501243",
    "tokenName" : "ORACLE_KNOWLEDGE",
    "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}"
    } ]
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/replacementTokens?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}

Back to Top