Jump to

• Request
• Response
• Examples

Create

post

/km/api/v1/contentRecommendations

This method creates a new ContentRecommendation object in the Oracle Knowledge Repository.

The request payload and URI for a singular resource must be given along with the POST method. The server creates a task for each recommendation.

Currently, there are two types of ContentRecommendation object:

• Content-Associated Recommendation - A ContentRecommendation object that is associated with a specific document.
• ContentType-Associated Recommendation - A ContentRecommendation object that is associated with a ContentType. Typically, it used to recommend that a new document be created.

When creating a Content-associated recommendation, no categories or views should be specified in the request payload. If either are specified, an error will be thrown and the recommendation will not be created.

When creating a ContentType-associated recommendation, the following rules are applied in regards to views:

For Console Users:

• If no views are specified during creation, all of the active user's views are assigned to the recommendation by default.
• If views are specified during creation, the active user must have access to the specified views. If not, an error will be thrown, and the recommendation will not be created.
• If the active user does not have any views assigned to them, an error will be thrown, and the recommendation will not be created.

For Web Users:

• Views are not required to be specified during creating. The active user's default view will automatically assigned to the recommendation.
• If a view is specified during creation, the specified view has to be the active user's default view. If not, an error will be thrown and the recommendation will not be created.
• If the active user does not have a default view assigned to them, an error will be thrown, and the recommendation will not be created.

Example URI

The example URI for this method is as follows:

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

Response Errors

The possible error responses for this method are as follows:

• OKDOM-CR0012

  The error occurs when an active user does not contain valid views to create the content recommendation.

Request

Supported Media Types

• application/json
• application/xml

Body ()

The object to be created.

Root Schema : ContentRecommendation

Match All

Show Source

• allOf ContentRecommendationData
• object ContentRecommendation-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/ContentRecommendationData"
        },
        {
            "properties":{
                "contentType":{
                    "$ref":"#/definitions/ContentTypeKey",
                    "description":"<p>The content type to which a recommendation is added.</p>"
                },
                "content":{
                    "$ref":"#/definitions/ContentKey",
                    "description":"<p>The content in the Oracle Knowledge Repository to which the user recommends modification.</p>"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The locale code of the content. For example, en_US is the locale for English (United States).</p>"
                },
                "views":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ViewKey"
                    },
                    "description":"<p>The list of views to which the recommendation is associated.</p>"
                },
                "categories":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"<p>The list of content categories to which the recommendation is associated.<p/>"
                }
            }
        }
    ]
}

Nested Schema : ContentRecommendationData

Match All

Show Source

• allOf ContentRecommendationKey
• object ContentRecommendationData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/ContentRecommendationKey"
        },
        {
            "properties":{
                "caseNumber":{
                    "type":"string",
                    "description":"<p>The incidentId to locate contentRecommendation object associated with a specific incident.</p>"
                },
                "comments":{
                    "type":"string",
                    "description":"<p>The comment from the user who recommended the content.</p>"
                },
                "completedByUserId":{
                    "type":"string",
                    "description":"<p>The userId associated with the completed content recommendations.</p> <p>To have a completedByUserId, the ContentRecommendation object must have status values as follows:</p> <ul> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
                },
                "completedByUserName":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user who added content recommendation.</p>"
                },
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the ContentRecommendation object was added.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the ContentRecommendation object was last modified.</p>"
                },
                "priority":{
                    "enum":[
                        "LOW",
                        "MEDIUM",
                        "HIGH"
                    ],
                    "description":"<p>The optional priority for the recommendation. The valid values are: LOW, MEDIUM, and HIGH."
                },
                "localizedPriority":{
                    "type":"string",
                    "description":"<p>The localized priority for the recommendation.</p>"
                },
                "requestedByUserId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user who recommended the content.</p>"
                },
                "requestedByUserName":{
                    "type":"string",
                    "description":"<p>The name of user who requested the content.</p>"
                },
                "status":{
                    "enum":[
                        "NEW",
                        "UNDER_REVIEW",
                        "REJECTED_DUPLICATE",
                        "REJECTED_NOT_ENOUGH_INFO",
                        "REJECTED_UNSUITABLE",
                        "REJECTED_OTHER",
                        "CONTENT_CREATED",
                        "CONTENT_MODIFIED"
                    ],
                    "description":"<p>The status of the recommendation.</p> <p>The valid status values are the following:</p> <ul> <li>NEW</li> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
                },
                "localizedStatus":{
                    "type":"string",
                    "description":"<p>The localized status of the recommendation.</p>"
                },
                "statusComments":{
                    "type":"string",
                    "description":"<p>The comment added by author about the status of the ContentRecommendation object.</p>"
                },
                "title":{
                    "type":"string",
                    "description":"<p>The title assigned to the recommendation by the user.</p>"
                }
            }
        }
    ]
}

Nested Schema : ContentRecommendationKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

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

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

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the contentRecommendation object.

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

Nested Schema : ContentRecommendationData-allOf[1]

Type: object

Show Source

• caseNumber(optional): string

  The incidentId to locate contentRecommendation object associated with a specific incident.

• comments(optional): string

  The comment from the user who recommended the content.

• completedByUserId(optional): string

  The userId associated with the completed content recommendations.

  To have a completedByUserId, the ContentRecommendation object must have status values as follows:

  • CONTENT_CREATED
  • CONTENT_MODIFIED
  • REJECTED_DUPLICATE
  • REJECTED_NOT_ENOUGH_INFO
  • REJECTED_UNSUITABLE
  • REJECTED_OTHER
• completedByUserName(optional): string

  The unique identifier of the user who added content recommendation.

• dateAdded(optional): string(date-time)

  The date when the ContentRecommendation object was added.

• dateModified(optional): string(date-time)

  The date when the ContentRecommendation object was last modified.

• localizedPriority(optional): string

  The localized priority for the recommendation.

• localizedStatus(optional): string

  The localized status of the recommendation.

• priority(optional):
  Allowed Values: [ "LOW", "MEDIUM", "HIGH" ]

  The optional priority for the recommendation. The valid values are: LOW, MEDIUM, and HIGH.

• requestedByUserId(optional): string

  The unique identifier of the user who recommended the content.

• requestedByUserName(optional): string

  The name of user who requested the content.

• status(optional):
  Allowed Values: [ "NEW", "UNDER_REVIEW", "REJECTED_DUPLICATE", "REJECTED_NOT_ENOUGH_INFO", "REJECTED_UNSUITABLE", "REJECTED_OTHER", "CONTENT_CREATED", "CONTENT_MODIFIED" ]

  The status of the recommendation.

  The valid status values are the following:

  • NEW
  • CONTENT_CREATED
  • CONTENT_MODIFIED
  • REJECTED_DUPLICATE
  • REJECTED_NOT_ENOUGH_INFO
  • REJECTED_UNSUITABLE
  • REJECTED_OTHER
• statusComments(optional): string

  The comment added by author about the status of the ContentRecommendation object.

• title(optional): string

  The title assigned to the recommendation by the user.

{
    "properties":{
        "caseNumber":{
            "type":"string",
            "description":"<p>The incidentId to locate contentRecommendation object associated with a specific incident.</p>"
        },
        "comments":{
            "type":"string",
            "description":"<p>The comment from the user who recommended the content.</p>"
        },
        "completedByUserId":{
            "type":"string",
            "description":"<p>The userId associated with the completed content recommendations.</p> <p>To have a completedByUserId, the ContentRecommendation object must have status values as follows:</p> <ul> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
        },
        "completedByUserName":{
            "type":"string",
            "description":"<p>The unique identifier of the user who added content recommendation.</p>"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the ContentRecommendation object was added.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the ContentRecommendation object was last modified.</p>"
        },
        "priority":{
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH"
            ],
            "description":"<p>The optional priority for the recommendation. The valid values are: LOW, MEDIUM, and HIGH."
        },
        "localizedPriority":{
            "type":"string",
            "description":"<p>The localized priority for the recommendation.</p>"
        },
        "requestedByUserId":{
            "type":"string",
            "description":"<p>The unique identifier of the user who recommended the content.</p>"
        },
        "requestedByUserName":{
            "type":"string",
            "description":"<p>The name of user who requested the content.</p>"
        },
        "status":{
            "enum":[
                "NEW",
                "UNDER_REVIEW",
                "REJECTED_DUPLICATE",
                "REJECTED_NOT_ENOUGH_INFO",
                "REJECTED_UNSUITABLE",
                "REJECTED_OTHER",
                "CONTENT_CREATED",
                "CONTENT_MODIFIED"
            ],
            "description":"<p>The status of the recommendation.</p> <p>The valid status values are the following:</p> <ul> <li>NEW</li> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
        },
        "localizedStatus":{
            "type":"string",
            "description":"<p>The localized status of the recommendation.</p>"
        },
        "statusComments":{
            "type":"string",
            "description":"<p>The comment added by author about the status of the ContentRecommendation object.</p>"
        },
        "title":{
            "type":"string",
            "description":"<p>The title assigned to the recommendation by the user.</p>"
        }
    }
}

Nested Schema : ContentRecommendation-allOf[1]

Type: object

Show Source

• categories(optional): array categories

  The list of content categories to which the recommendation is associated.

• content(optional): ContentKey
• contentType(optional): ContentTypeKey
• locale(optional): LocaleKey
• views(optional): array views

  The list of views to which the recommendation is associated.

{
    "properties":{
        "contentType":{
            "$ref":"#/definitions/ContentTypeKey",
            "description":"<p>The content type to which a recommendation is added.</p>"
        },
        "content":{
            "$ref":"#/definitions/ContentKey",
            "description":"<p>The content in the Oracle Knowledge Repository to which the user recommends modification.</p>"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The locale code of the content. For example, en_US is the locale for English (United States).</p>"
        },
        "views":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"<p>The list of views to which the recommendation is associated.</p>"
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>The list of content categories to which the recommendation is associated.<p/>"
        }
    }
}

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

Type: array

The list of content categories to which the recommendation is associated.

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>The list of content categories to which the recommendation is associated.<p/>"
}

Nested Schema : ContentKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
                },
                "versionId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
                },
                "documentId":{
                    "type":"string",
                    "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
                },
                "title":{
                    "type":"string",
                    "description":"<p>The tittle of the document.</p>"
                },
                "version":{
                    "type":"string",
                    "description":"Version of the Content object"
                },
                "answerId":{
                    "type":"integer",
                    "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
                },
                "allTranslations":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ContentKey"
                    },
                    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
                }
            }
        }
    ]
}

Nested Schema : ContentTypeKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the ContentType object.</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
                },
                "description":{
                    "type":"string",
                    "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
                }
            }
        }
    ]
}

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

Type: array

The list of views to which the recommendation is associated.

Show Source

• Array of: ViewKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"<p>The list of views to which the recommendation is associated.</p>"
}

Nested Schema : CategoryKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique record ID of the Category object.</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
                },
                "objectId":{
                    "type":"string",
                    "description":"The hierarchichal position of the category"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name of the category.</p>"
                },
                "externalId":{
                    "type":"integer",
                    "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>"
                },
                "externalType":{
                    "type":"string",
                    "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>"
                },
                "responseLocale":{
                    "type":"string",
                    "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>"
                },
                "description":{
                    "type":"string",
                    "description":"Description of the Category object"
                },
                "childrenCount":{
                    "type":"integer",
                    "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>"
                },
                "parents":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
                }
            }
        }
    ]
}

Nested Schema : CategoryKey-allOf[1]

Type: object

Show Source

• childrenCount(optional): integer

  This field will return number of immediate children a category has.

  This field will only be populated if childrenCount query parameter is passed in with value true.

  Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
• description(optional): string
  Description of the Category object
• externalId(optional): integer

  The unique identifier used while integrating the repository data with the external system.

• externalType(optional): string

  The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.

• name(optional): string

  The name of the category.

• objectId(optional): string
  The hierarchichal position of the category
• parents(optional): array parents

  This field will return all parents of category.

  This field will only be populated if withParents query parameter is passed in with value true.

  Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
• recordId(optional): string

  The unique record ID of the Category object.

• referenceKey(optional): string

  The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.

• responseLocale(optional): string

  This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique record ID of the Category object.</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
        },
        "objectId":{
            "type":"string",
            "description":"The hierarchichal position of the category"
        },
        "name":{
            "type":"string",
            "description":"<p>The name of the category.</p>"
        },
        "externalId":{
            "type":"integer",
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>"
        },
        "externalType":{
            "type":"string",
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>"
        },
        "responseLocale":{
            "type":"string",
            "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>"
        },
        "description":{
            "type":"string",
            "description":"Description of the Category object"
        },
        "childrenCount":{
            "type":"integer",
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>"
        },
        "parents":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
        }
    }
}

Nested Schema : parents

Type: array

This field will return all parents of category.

This field will only be populated if withParents query parameter is passed in with value true.

Example URIs for the this parameter are as follows:

• http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
}

Nested Schema : ContentKey-allOf[1]

Type: object

Show Source

• allTranslations(optional): array allTranslations

  This field will return list of all translated content that the user can view

  This field will only be populated if allTranslations query parameter is passed in with value true.

• answerId(optional): integer

  The unique identifier that enables mapping between an answer and the content.

• dateModified(optional): string(date-time)

  The date when the content was last modified in the Oracle Knowledge Repository.

• documentId(optional): string

  The unique identifier of a document that indicates the content type in which the content is saved.

• locale(optional): LocaleKey
• recordId(optional): string

  The unique identifier of the document. This ID is same in all versions in all locales of the document.

• title(optional): string

  The tittle of the document.

• version(optional): string
  Version of the Content object
• versionId(optional): string

  The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
        },
        "versionId":{
            "type":"string",
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
        },
        "documentId":{
            "type":"string",
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
        },
        "title":{
            "type":"string",
            "description":"<p>The tittle of the document.</p>"
        },
        "version":{
            "type":"string",
            "description":"Version of the Content object"
        },
        "answerId":{
            "type":"integer",
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
        },
        "allTranslations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
        }
    }
}

Nested Schema : allTranslations

Type: array

This field will return list of all translated content that the user can view

This field will only be populated if allTranslations query parameter is passed in with value true.

Show Source

• Array of: ContentKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
}

Nested Schema : ContentTypeKey-allOf[1]

Type: object

Show Source

• description(optional): string

  The description for the ContentType object. Content Types support multiple languages.

  This field identifies the object associated with the language specified by the user.

• name(optional): string

  The name for the ContentType object. The name field can only be used for sorting.

  Content Types support multiple languages. This field identifies the object associated with the language specified by the user.

• recordId(optional): string

  The unique identifier of the ContentType object.

• referenceKey(optional): string

  The reference key for the ContentType object.

  ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the ContentType object.</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
        },
        "description":{
            "type":"string",
            "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
        }
    }
}

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

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

Response

Supported Media Types

• application/json
• application/xml

201 Response

Created.

Body ()

Root Schema : ContentRecommendation

Match All

Show Source

• allOf ContentRecommendationData
• object ContentRecommendation-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/ContentRecommendationData"
        },
        {
            "properties":{
                "contentType":{
                    "$ref":"#/definitions/ContentTypeKey",
                    "description":"<p>The content type to which a recommendation is added.</p>"
                },
                "content":{
                    "$ref":"#/definitions/ContentKey",
                    "description":"<p>The content in the Oracle Knowledge Repository to which the user recommends modification.</p>"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The locale code of the content. For example, en_US is the locale for English (United States).</p>"
                },
                "views":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ViewKey"
                    },
                    "description":"<p>The list of views to which the recommendation is associated.</p>"
                },
                "categories":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"<p>The list of content categories to which the recommendation is associated.<p/>"
                }
            }
        }
    ]
}

Nested Schema : ContentRecommendationData

Match All

Show Source

• allOf ContentRecommendationKey
• object ContentRecommendationData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/ContentRecommendationKey"
        },
        {
            "properties":{
                "caseNumber":{
                    "type":"string",
                    "description":"<p>The incidentId to locate contentRecommendation object associated with a specific incident.</p>"
                },
                "comments":{
                    "type":"string",
                    "description":"<p>The comment from the user who recommended the content.</p>"
                },
                "completedByUserId":{
                    "type":"string",
                    "description":"<p>The userId associated with the completed content recommendations.</p> <p>To have a completedByUserId, the ContentRecommendation object must have status values as follows:</p> <ul> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
                },
                "completedByUserName":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user who added content recommendation.</p>"
                },
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the ContentRecommendation object was added.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the ContentRecommendation object was last modified.</p>"
                },
                "priority":{
                    "enum":[
                        "LOW",
                        "MEDIUM",
                        "HIGH"
                    ],
                    "description":"<p>The optional priority for the recommendation. The valid values are: LOW, MEDIUM, and HIGH."
                },
                "localizedPriority":{
                    "type":"string",
                    "description":"<p>The localized priority for the recommendation.</p>"
                },
                "requestedByUserId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user who recommended the content.</p>"
                },
                "requestedByUserName":{
                    "type":"string",
                    "description":"<p>The name of user who requested the content.</p>"
                },
                "status":{
                    "enum":[
                        "NEW",
                        "UNDER_REVIEW",
                        "REJECTED_DUPLICATE",
                        "REJECTED_NOT_ENOUGH_INFO",
                        "REJECTED_UNSUITABLE",
                        "REJECTED_OTHER",
                        "CONTENT_CREATED",
                        "CONTENT_MODIFIED"
                    ],
                    "description":"<p>The status of the recommendation.</p> <p>The valid status values are the following:</p> <ul> <li>NEW</li> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
                },
                "localizedStatus":{
                    "type":"string",
                    "description":"<p>The localized status of the recommendation.</p>"
                },
                "statusComments":{
                    "type":"string",
                    "description":"<p>The comment added by author about the status of the ContentRecommendation object.</p>"
                },
                "title":{
                    "type":"string",
                    "description":"<p>The title assigned to the recommendation by the user.</p>"
                }
            }
        }
    ]
}

Nested Schema : ContentRecommendationKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

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

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

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the contentRecommendation object.

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

Nested Schema : ContentRecommendationData-allOf[1]

Type: object

Show Source

• caseNumber(optional): string

  The incidentId to locate contentRecommendation object associated with a specific incident.

• comments(optional): string

  The comment from the user who recommended the content.

• completedByUserId(optional): string

  The userId associated with the completed content recommendations.

  To have a completedByUserId, the ContentRecommendation object must have status values as follows:

  • CONTENT_CREATED
  • CONTENT_MODIFIED
  • REJECTED_DUPLICATE
  • REJECTED_NOT_ENOUGH_INFO
  • REJECTED_UNSUITABLE
  • REJECTED_OTHER
• completedByUserName(optional): string

  The unique identifier of the user who added content recommendation.

• dateAdded(optional): string(date-time)

  The date when the ContentRecommendation object was added.

• dateModified(optional): string(date-time)

  The date when the ContentRecommendation object was last modified.

• localizedPriority(optional): string

  The localized priority for the recommendation.

• localizedStatus(optional): string

  The localized status of the recommendation.

• priority(optional):
  Allowed Values: [ "LOW", "MEDIUM", "HIGH" ]

  The optional priority for the recommendation. The valid values are: LOW, MEDIUM, and HIGH.

• requestedByUserId(optional): string

  The unique identifier of the user who recommended the content.

• requestedByUserName(optional): string

  The name of user who requested the content.

• status(optional):
  Allowed Values: [ "NEW", "UNDER_REVIEW", "REJECTED_DUPLICATE", "REJECTED_NOT_ENOUGH_INFO", "REJECTED_UNSUITABLE", "REJECTED_OTHER", "CONTENT_CREATED", "CONTENT_MODIFIED" ]

  The status of the recommendation.

  The valid status values are the following:

  • NEW
  • CONTENT_CREATED
  • CONTENT_MODIFIED
  • REJECTED_DUPLICATE
  • REJECTED_NOT_ENOUGH_INFO
  • REJECTED_UNSUITABLE
  • REJECTED_OTHER
• statusComments(optional): string

  The comment added by author about the status of the ContentRecommendation object.

• title(optional): string

  The title assigned to the recommendation by the user.

{
    "properties":{
        "caseNumber":{
            "type":"string",
            "description":"<p>The incidentId to locate contentRecommendation object associated with a specific incident.</p>"
        },
        "comments":{
            "type":"string",
            "description":"<p>The comment from the user who recommended the content.</p>"
        },
        "completedByUserId":{
            "type":"string",
            "description":"<p>The userId associated with the completed content recommendations.</p> <p>To have a completedByUserId, the ContentRecommendation object must have status values as follows:</p> <ul> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
        },
        "completedByUserName":{
            "type":"string",
            "description":"<p>The unique identifier of the user who added content recommendation.</p>"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the ContentRecommendation object was added.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the ContentRecommendation object was last modified.</p>"
        },
        "priority":{
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH"
            ],
            "description":"<p>The optional priority for the recommendation. The valid values are: LOW, MEDIUM, and HIGH."
        },
        "localizedPriority":{
            "type":"string",
            "description":"<p>The localized priority for the recommendation.</p>"
        },
        "requestedByUserId":{
            "type":"string",
            "description":"<p>The unique identifier of the user who recommended the content.</p>"
        },
        "requestedByUserName":{
            "type":"string",
            "description":"<p>The name of user who requested the content.</p>"
        },
        "status":{
            "enum":[
                "NEW",
                "UNDER_REVIEW",
                "REJECTED_DUPLICATE",
                "REJECTED_NOT_ENOUGH_INFO",
                "REJECTED_UNSUITABLE",
                "REJECTED_OTHER",
                "CONTENT_CREATED",
                "CONTENT_MODIFIED"
            ],
            "description":"<p>The status of the recommendation.</p> <p>The valid status values are the following:</p> <ul> <li>NEW</li> <li>CONTENT_CREATED</li> <li>CONTENT_MODIFIED</li> <li>REJECTED_DUPLICATE</li> <li>REJECTED_NOT_ENOUGH_INFO</li> <li>REJECTED_UNSUITABLE</li> <li>REJECTED_OTHER</li> </ul>"
        },
        "localizedStatus":{
            "type":"string",
            "description":"<p>The localized status of the recommendation.</p>"
        },
        "statusComments":{
            "type":"string",
            "description":"<p>The comment added by author about the status of the ContentRecommendation object.</p>"
        },
        "title":{
            "type":"string",
            "description":"<p>The title assigned to the recommendation by the user.</p>"
        }
    }
}

Nested Schema : ContentRecommendation-allOf[1]

Type: object

Show Source

• categories(optional): array categories

  The list of content categories to which the recommendation is associated.

• content(optional): ContentKey
• contentType(optional): ContentTypeKey
• locale(optional): LocaleKey
• views(optional): array views

  The list of views to which the recommendation is associated.

{
    "properties":{
        "contentType":{
            "$ref":"#/definitions/ContentTypeKey",
            "description":"<p>The content type to which a recommendation is added.</p>"
        },
        "content":{
            "$ref":"#/definitions/ContentKey",
            "description":"<p>The content in the Oracle Knowledge Repository to which the user recommends modification.</p>"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The locale code of the content. For example, en_US is the locale for English (United States).</p>"
        },
        "views":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"<p>The list of views to which the recommendation is associated.</p>"
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>The list of content categories to which the recommendation is associated.<p/>"
        }
    }
}

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

Type: array

The list of content categories to which the recommendation is associated.

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>The list of content categories to which the recommendation is associated.<p/>"
}

Nested Schema : ContentKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
                },
                "versionId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
                },
                "documentId":{
                    "type":"string",
                    "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
                },
                "title":{
                    "type":"string",
                    "description":"<p>The tittle of the document.</p>"
                },
                "version":{
                    "type":"string",
                    "description":"Version of the Content object"
                },
                "answerId":{
                    "type":"integer",
                    "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
                },
                "allTranslations":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ContentKey"
                    },
                    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
                }
            }
        }
    ]
}

Nested Schema : ContentTypeKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the ContentType object.</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
                },
                "description":{
                    "type":"string",
                    "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
                }
            }
        }
    ]
}

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

Type: array

The list of views to which the recommendation is associated.

Show Source

• Array of: ViewKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"<p>The list of views to which the recommendation is associated.</p>"
}

Nested Schema : CategoryKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique record ID of the Category object.</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
                },
                "objectId":{
                    "type":"string",
                    "description":"The hierarchichal position of the category"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name of the category.</p>"
                },
                "externalId":{
                    "type":"integer",
                    "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>"
                },
                "externalType":{
                    "type":"string",
                    "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>"
                },
                "responseLocale":{
                    "type":"string",
                    "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>"
                },
                "description":{
                    "type":"string",
                    "description":"Description of the Category object"
                },
                "childrenCount":{
                    "type":"integer",
                    "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>"
                },
                "parents":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
                }
            }
        }
    ]
}

Nested Schema : CategoryKey-allOf[1]

Type: object

Show Source

• childrenCount(optional): integer

  This field will return number of immediate children a category has.

  This field will only be populated if childrenCount query parameter is passed in with value true.

  Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
• description(optional): string
  Description of the Category object
• externalId(optional): integer

  The unique identifier used while integrating the repository data with the external system.

• externalType(optional): string

  The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.

• name(optional): string

  The name of the category.

• objectId(optional): string
  The hierarchichal position of the category
• parents(optional): array parents

  This field will return all parents of category.

  This field will only be populated if withParents query parameter is passed in with value true.

  Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
• recordId(optional): string

  The unique record ID of the Category object.

• referenceKey(optional): string

  The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.

• responseLocale(optional): string

  This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique record ID of the Category object.</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
        },
        "objectId":{
            "type":"string",
            "description":"The hierarchichal position of the category"
        },
        "name":{
            "type":"string",
            "description":"<p>The name of the category.</p>"
        },
        "externalId":{
            "type":"integer",
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>"
        },
        "externalType":{
            "type":"string",
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>"
        },
        "responseLocale":{
            "type":"string",
            "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>"
        },
        "description":{
            "type":"string",
            "description":"Description of the Category object"
        },
        "childrenCount":{
            "type":"integer",
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>"
        },
        "parents":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
        }
    }
}

Nested Schema : parents

Type: array

This field will return all parents of category.

This field will only be populated if withParents query parameter is passed in with value true.

Example URIs for the this parameter are as follows:

• http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
}

Nested Schema : ContentKey-allOf[1]

Type: object

Show Source

• allTranslations(optional): array allTranslations

  This field will return list of all translated content that the user can view

  This field will only be populated if allTranslations query parameter is passed in with value true.

• answerId(optional): integer

  The unique identifier that enables mapping between an answer and the content.

• dateModified(optional): string(date-time)

  The date when the content was last modified in the Oracle Knowledge Repository.

• documentId(optional): string

  The unique identifier of a document that indicates the content type in which the content is saved.

• locale(optional): LocaleKey
• recordId(optional): string

  The unique identifier of the document. This ID is same in all versions in all locales of the document.

• title(optional): string

  The tittle of the document.

• version(optional): string
  Version of the Content object
• versionId(optional): string

  The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
        },
        "versionId":{
            "type":"string",
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
        },
        "documentId":{
            "type":"string",
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
        },
        "title":{
            "type":"string",
            "description":"<p>The tittle of the document.</p>"
        },
        "version":{
            "type":"string",
            "description":"Version of the Content object"
        },
        "answerId":{
            "type":"integer",
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
        },
        "allTranslations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
        }
    }
}

Nested Schema : allTranslations

Type: array

This field will return list of all translated content that the user can view

This field will only be populated if allTranslations query parameter is passed in with value true.

Show Source

• Array of: ContentKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
}

Nested Schema : ContentTypeKey-allOf[1]

Type: object

Show Source

• description(optional): string

  The description for the ContentType object. Content Types support multiple languages.

  This field identifies the object associated with the language specified by the user.

• name(optional): string

  The name for the ContentType object. The name field can only be used for sorting.

  Content Types support multiple languages. This field identifies the object associated with the language specified by the user.

• recordId(optional): string

  The unique identifier of the ContentType object.

• referenceKey(optional): string

  The reference key for the ContentType object.

  ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the ContentType object.</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
        },
        "description":{
            "type":"string",
            "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
        }
    }
}

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

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 : 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 create a Content Recommendation object in Oracle Knowledge repository by submitting a post request on the REST resource using cURL.

cURL Command

Command: curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/contentRecommendations"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \
-H "Accept: application/json"

Example of Request Body

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

{
  "contentType" : {
    "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}"
    } ]
  },
  "content" : {
    "versionId" : "VERSIONID_VALUE",
    "documentId" : "DOCUMENTID_VALUE",
    "title" : "TITLE_VALUE",
    "version" : "VERSION_VALUE",
    "answerId" : 0,
    "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" : {
    "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}"
    } ]
  },
  "views" : [ {
    "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}"
    } ]
  } ],
  "categories" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "externalId" : 1428416791401,
    "externalType" : "EXTERNALTYPE_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}"
    } ]
  } ],
  "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}"
  } ],
  "caseNumber" : "CASENUMBER_VALUE",
  "comments" : "COMMENTS_VALUE",
  "completedByUserId" : "COMPLETEDBYUSERID_VALUE",
  "completedByUserName" : "COMPLETEDBYUSERNAME_VALUE",
  "dateAdded" : "2013-04-23T21:06:35EDT",
  "dateModified" : "2013-04-23T21:06:35EDT",
  "requestedByUserId" : "REQUESTEDBYUSERID_VALUE",
  "requestedByUserName" : "REQUESTEDBYUSERNAME_VALUE",
  "statusComments" : "STATUSCOMMENTS_VALUE",
  "title" : "TITLE_VALUE"
}

Example of Response Body

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

{
  "contentType" : {
    "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}"
    } ]
  },
  "content" : {
    "versionId" : "VERSIONID_VALUE",
    "documentId" : "DOCUMENTID_VALUE",
    "title" : "TITLE_VALUE",
    "version" : "VERSION_VALUE",
    "answerId" : 0,
    "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" : {
    "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}"
    } ]
  },
  "views" : [ {
    "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}"
    } ]
  } ],
  "categories" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "externalId" : 1428416791401,
    "externalType" : "EXTERNALTYPE_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}"
    } ]
  } ],
  "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}"
  } ],
  "caseNumber" : "CASENUMBER_VALUE",
  "comments" : "COMMENTS_VALUE",
  "completedByUserId" : "COMPLETEDBYUSERID_VALUE",
  "completedByUserName" : "COMPLETEDBYUSERNAME_VALUE",
  "dateAdded" : "2013-04-23T21:06:35EDT",
  "dateModified" : "2013-04-23T21:06:35EDT",
  "requestedByUserId" : "REQUESTEDBYUSERID_VALUE",
  "requestedByUserName" : "REQUESTEDBYUSERNAME_VALUE",
  "statusComments" : "STATUSCOMMENTS_VALUE",
  "title" : "TITLE_VALUE"
}
  "items" : [ {
    "contentRecommendation" : {
    },
    "comments" : "COMMENTS_VALUE",
    "priority" : "LOW",
    "taskStatus" : "IGNORED",
    "taskType" : "TRANSLATION",
    "age" : "AGE_VALUE",
    "taskTypeDisplay" : "TASKTYPEDISPLAY_VALUE",
    "taskPriorityDisplay" : "TASKPRIORITYDISPLAY_VALUE",
    "taskName" : "TASKNAME_VALUE",
    "ownerSiteId" : "OWNERSITEID_VALUE",
    "userAssignedName" : "USERASSIGNEDNAME_VALUE",
    "userModifiedName" : "USERMODIFIEDNAME_VALUE",
    "startDate" : "2013-05-23T19:30:15EDT",
    "sysComments" : "SYSCOMMENTS_VALUE",
    "resolution" : "RESOLUTION_VALUE",
    "taskIdNumber" : 0,
    "localeCode" : "LOCALECODE_VALUE"
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/tasks/contentRecommendationTasks?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}

Back to Top