Jump to

• Request
• Response
• Examples

Add subscription

post

/km/api/v1/users/{id}/subscriptions

This method creates a new user subscription for a specified user ID.

You can create either a Content-based or ContentType-based subscription for a specified user. For ContentType-based subscription, you can optionally specify one or more categories to restrict the content of your subscription.

Note: The logged in user must have the MODIFY_USER or MODIFY_WEB_USER privileges to create a subscription for another user.

Response Errors

The possible error responses for this method are as follows:

• OK-SEC0001

  The error occurs when a user does not have the MODIFY_USER or MODIFY_WEB_USER privileges but attempts to create a subscription for another user.

• OKDOM-GEN0001

  The error occurs when a userId, content versionId for content based subscriptions, or contentType recordId for contentType based subscriptions do not exist.

• OK-GEN0006

  The error occurs when a recordId, dateadded, datemodified, lastCrawl, or subscriptionType values are specified with the request.

• OK-GEN0005

  The error occurs when a subscription name is not set in the request.

• OKDOM-USER0015

  The error occurs when the specified userId value in the request does not match the userId value specified in the Business Object.

• OKDOM-USER0017

  The error occurs when both content and contentType are set on the Business Object.

• OKDOM-USER0018

  The error occurs when both content and categories are set on the Business Object.

• OKDOM-USER0016

  The error occurs when neither content nor contentType are set on the Business Object.

• OKDOM-USER0019

  The error occurs in one of the following instances:

  • A content-based subscription already exists for the same content and locale.
  • A ContentType-based subscription already exists for contenType set on the Business Object.
• OKDOM-USER0020

  The error occurs when a category in Business Object is not assigned to the contentType being used.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  The user identifier

Body ()

The subscription to be added

Root Schema : Subscription

Match All

Show Source

• allOf SubscriptionData
• object Subscription-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/SubscriptionData"
        },
        {
            "properties":{
                "contentType":{
                    "$ref":"#/definitions/ContentTypeKey",
                    "description":"Relationship to ContentChannel"
                },
                "content":{
                    "$ref":"#/definitions/ContentKey",
                    "description":"To One Relationship to Content"
                },
                "owner":{
                    "$ref":"#/definitions/UserKey",
                    "description":"Relationship to User"
                },
                "categories":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"To Many Relationship to Category"
                }
            }
        }
    ]
}

Nested Schema : SubscriptionData

Match All

Show Source

• allOf SubscriptionKey
• object SubscriptionData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/SubscriptionKey"
        },
        {
            "properties":{
                "active":{
                    "type":"boolean",
                    "description":"Active of the Subscription object"
                },
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the Subscription object was created or added"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the Subscription object was last modified."
                },
                "lastCrawl":{
                    "type":"string",
                    "format":"date-time",
                    "description":"LastCrawl of the Subscription object"
                },
                "name":{
                    "type":"string",
                    "description":"Name of the Subscription object"
                },
                "subscriptionType":{
                    "enum":[
                        "SUBSCRIPTIONTYPE_UNSPECIFIED",
                        "SUBSCRIPTIONTYPE_CHANNEL",
                        "SUBSCRIPTIONTYPE_CONTENT",
                        "SUBSCRIPTIONTYPE_FORUM",
                        "SUBSCRIPTIONTYPE_TOPIC",
                        "SUBSCRIPTIONTYPE_CATEGORY"
                    ],
                    "description":"SubscriptionType of the Subscription object"
                },
                "interfaceID":{
                    "type":"integer",
                    "description":"InterfaceID of the Subscription object"
                }
            }
        }
    ]
}

Nested Schema : SubscriptionKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the Subscription 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 : SubscriptionKey-allOf[1]

Type: object

Show Source

• recordId(optional): string
  The unique record ID of the Subscription object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the Subscription object."
        }
    }
}

Nested Schema : SubscriptionData-allOf[1]

Type: object

Show Source

• active(optional): boolean
  Active of the Subscription object
• dateAdded(optional): string(date-time)
  The date when the Subscription object was created or added
• dateModified(optional): string(date-time)
  The date when the Subscription object was last modified.
• interfaceID(optional): integer
  InterfaceID of the Subscription object
• lastCrawl(optional): string(date-time)
  LastCrawl of the Subscription object
• name(optional): string
  Name of the Subscription object
• subscriptionType(optional):
  Allowed Values: [ "SUBSCRIPTIONTYPE_UNSPECIFIED", "SUBSCRIPTIONTYPE_CHANNEL", "SUBSCRIPTIONTYPE_CONTENT", "SUBSCRIPTIONTYPE_FORUM", "SUBSCRIPTIONTYPE_TOPIC", "SUBSCRIPTIONTYPE_CATEGORY" ]

  SubscriptionType of the Subscription object

{
    "properties":{
        "active":{
            "type":"boolean",
            "description":"Active of the Subscription object"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the Subscription object was created or added"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the Subscription object was last modified."
        },
        "lastCrawl":{
            "type":"string",
            "format":"date-time",
            "description":"LastCrawl of the Subscription object"
        },
        "name":{
            "type":"string",
            "description":"Name of the Subscription object"
        },
        "subscriptionType":{
            "enum":[
                "SUBSCRIPTIONTYPE_UNSPECIFIED",
                "SUBSCRIPTIONTYPE_CHANNEL",
                "SUBSCRIPTIONTYPE_CONTENT",
                "SUBSCRIPTIONTYPE_FORUM",
                "SUBSCRIPTIONTYPE_TOPIC",
                "SUBSCRIPTIONTYPE_CATEGORY"
            ],
            "description":"SubscriptionType of the Subscription object"
        },
        "interfaceID":{
            "type":"integer",
            "description":"InterfaceID of the Subscription object"
        }
    }
}

Nested Schema : Subscription-allOf[1]

Type: object

Show Source

• categories(optional): array categories
  To Many Relationship to Category
• content(optional): ContentKey
• contentType(optional): ContentTypeKey
• owner(optional): UserKey

{
    "properties":{
        "contentType":{
            "$ref":"#/definitions/ContentTypeKey",
            "description":"Relationship to ContentChannel"
        },
        "content":{
            "$ref":"#/definitions/ContentKey",
            "description":"To One Relationship to Content"
        },
        "owner":{
            "$ref":"#/definitions/UserKey",
            "description":"Relationship to User"
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"To Many Relationship to Category"
        }
    }
}

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

To Many Relationship to Category

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"To Many Relationship to Category"
}

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

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the User object."
                },
                "name":{
                    "type":"string",
                    "description":"User's full name"
                },
                "email":{
                    "type":"string",
                    "description":"Email of the User object"
                },
                "externalId":{
                    "type":"integer",
                    "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
                },
                "externalType":{
                    "type":"string",
                    "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
                }
            }
        }
    ]
}

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

Type: object

Show Source

• email(optional): string
  Email of the User object
• externalId(optional): integer
  The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
• externalType(optional): string
  The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
• name(optional): string
  User's full name
• recordId(optional): string
  The unique record ID of the User object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the User object."
        },
        "name":{
            "type":"string",
            "description":"User's full name"
        },
        "email":{
            "type":"string",
            "description":"Email of the User object"
        },
        "externalId":{
            "type":"integer",
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
        },
        "externalType":{
            "type":"string",
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Created.

Body ()

Root Schema : Subscription

Match All

Show Source

• allOf SubscriptionData
• object Subscription-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/SubscriptionData"
        },
        {
            "properties":{
                "contentType":{
                    "$ref":"#/definitions/ContentTypeKey",
                    "description":"Relationship to ContentChannel"
                },
                "content":{
                    "$ref":"#/definitions/ContentKey",
                    "description":"To One Relationship to Content"
                },
                "owner":{
                    "$ref":"#/definitions/UserKey",
                    "description":"Relationship to User"
                },
                "categories":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"To Many Relationship to Category"
                }
            }
        }
    ]
}

Nested Schema : SubscriptionData

Match All

Show Source

• allOf SubscriptionKey
• object SubscriptionData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/SubscriptionKey"
        },
        {
            "properties":{
                "active":{
                    "type":"boolean",
                    "description":"Active of the Subscription object"
                },
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the Subscription object was created or added"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the Subscription object was last modified."
                },
                "lastCrawl":{
                    "type":"string",
                    "format":"date-time",
                    "description":"LastCrawl of the Subscription object"
                },
                "name":{
                    "type":"string",
                    "description":"Name of the Subscription object"
                },
                "subscriptionType":{
                    "enum":[
                        "SUBSCRIPTIONTYPE_UNSPECIFIED",
                        "SUBSCRIPTIONTYPE_CHANNEL",
                        "SUBSCRIPTIONTYPE_CONTENT",
                        "SUBSCRIPTIONTYPE_FORUM",
                        "SUBSCRIPTIONTYPE_TOPIC",
                        "SUBSCRIPTIONTYPE_CATEGORY"
                    ],
                    "description":"SubscriptionType of the Subscription object"
                },
                "interfaceID":{
                    "type":"integer",
                    "description":"InterfaceID of the Subscription object"
                }
            }
        }
    ]
}

Nested Schema : SubscriptionKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the Subscription 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 : SubscriptionKey-allOf[1]

Type: object

Show Source

• recordId(optional): string
  The unique record ID of the Subscription object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the Subscription object."
        }
    }
}

Nested Schema : SubscriptionData-allOf[1]

Type: object

Show Source

• active(optional): boolean
  Active of the Subscription object
• dateAdded(optional): string(date-time)
  The date when the Subscription object was created or added
• dateModified(optional): string(date-time)
  The date when the Subscription object was last modified.
• interfaceID(optional): integer
  InterfaceID of the Subscription object
• lastCrawl(optional): string(date-time)
  LastCrawl of the Subscription object
• name(optional): string
  Name of the Subscription object
• subscriptionType(optional):
  Allowed Values: [ "SUBSCRIPTIONTYPE_UNSPECIFIED", "SUBSCRIPTIONTYPE_CHANNEL", "SUBSCRIPTIONTYPE_CONTENT", "SUBSCRIPTIONTYPE_FORUM", "SUBSCRIPTIONTYPE_TOPIC", "SUBSCRIPTIONTYPE_CATEGORY" ]

  SubscriptionType of the Subscription object

{
    "properties":{
        "active":{
            "type":"boolean",
            "description":"Active of the Subscription object"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the Subscription object was created or added"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the Subscription object was last modified."
        },
        "lastCrawl":{
            "type":"string",
            "format":"date-time",
            "description":"LastCrawl of the Subscription object"
        },
        "name":{
            "type":"string",
            "description":"Name of the Subscription object"
        },
        "subscriptionType":{
            "enum":[
                "SUBSCRIPTIONTYPE_UNSPECIFIED",
                "SUBSCRIPTIONTYPE_CHANNEL",
                "SUBSCRIPTIONTYPE_CONTENT",
                "SUBSCRIPTIONTYPE_FORUM",
                "SUBSCRIPTIONTYPE_TOPIC",
                "SUBSCRIPTIONTYPE_CATEGORY"
            ],
            "description":"SubscriptionType of the Subscription object"
        },
        "interfaceID":{
            "type":"integer",
            "description":"InterfaceID of the Subscription object"
        }
    }
}

Nested Schema : Subscription-allOf[1]

Type: object

Show Source

• categories(optional): array categories
  To Many Relationship to Category
• content(optional): ContentKey
• contentType(optional): ContentTypeKey
• owner(optional): UserKey

{
    "properties":{
        "contentType":{
            "$ref":"#/definitions/ContentTypeKey",
            "description":"Relationship to ContentChannel"
        },
        "content":{
            "$ref":"#/definitions/ContentKey",
            "description":"To One Relationship to Content"
        },
        "owner":{
            "$ref":"#/definitions/UserKey",
            "description":"Relationship to User"
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"To Many Relationship to Category"
        }
    }
}

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

To Many Relationship to Category

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"To Many Relationship to Category"
}

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

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the User object."
                },
                "name":{
                    "type":"string",
                    "description":"User's full name"
                },
                "email":{
                    "type":"string",
                    "description":"Email of the User object"
                },
                "externalId":{
                    "type":"integer",
                    "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
                },
                "externalType":{
                    "type":"string",
                    "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
                }
            }
        }
    ]
}

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

Type: object

Show Source

• email(optional): string
  Email of the User object
• externalId(optional): integer
  The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
• externalType(optional): string
  The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
• name(optional): string
  User's full name
• recordId(optional): string
  The unique record ID of the User object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the User object."
        },
        "name":{
            "type":"string",
            "description":"User's full name"
        },
        "email":{
            "type":"string",
            "description":"Email of the User object"
        },
        "externalId":{
            "type":"integer",
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
        },
        "externalType":{
            "type":"string",
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
        }
    }
}

Back to Top

Examples

Example 1

The following example shows how to create a content subscription for a specified user ID by submitting a post request on the REST resource using cURL.

cURL Command

curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/users/{id}/subscriptions"

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.

{
  "content" : {
    "versionId" : "VERSIONID_VALUE"
  },
  "active" : true,
  "name" : "NAME_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>/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "content" : {
    "versionId" : "VERSIONID_VALUE",
    "documentId" : "DOCUMENTID_VALUE",
    "title" : "TITLE_VALUE",
    "version" : "VERSION_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "owner" : {
    "name" : "NAME_VALUE",
    "externalId" : 1428417269295,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "categories" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "externalId" : 1428417269305,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET"
  } ],
  "active" : true,
  "dateAdded" : "2013-04-30T14:37:11-0600",
  "dateModified" : "2013-04-30T14:37:11-0600",
  "lastCrawl" : "2013-04-30T14:37:11-0600",
  "name" : "NAME_VALUE",
  "subscriptionType" : "SUBSCRIPTIONTYPE_CONTENT"
}

Example 2

The following example shows how to create a content-type subscription for a specified user ID by submitting a post request on the REST resource using cURL.

cURL Command

curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/users/{id}/subscriptions"

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" : {
    "recordId" : "01234567890A",
     "referenceKey" : "REFERENCEKEY_VALUE",
     "name" : "NAME_VALUE"
  },
  "active" : true,
  "name" : "NAME_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>/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "owner" : {
    "name" : "NAME_VALUE",
    "externalId" : 1428417269295,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "categories" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "externalId" : 1428417269305,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET"
  } ],
  "active" : true,
  "dateAdded" : "2013-04-30T14:37:11-0600",
  "dateModified" : "2013-04-30T14:37:11-0600",
  "lastCrawl" : "2013-04-30T14:37:11-0600",
  "name" : "NAME_VALUE",
  "subscriptionType" : "SUBSCRIPTIONTYPE_CONTENT"
}

Back to Top