1. REST API for Knowledge Management in Oracle Fusion Service
  2. Tasks
  3. Content (IM)
  4. Content

Get all content

get

/km/api/v1/content

This service returns a list of articles from the knowledge base.

This resource supports the orderBy request parameter, which allows you to sort the returned list of Content objects.

You can find the different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get schema and catalog information of the resource is as follows: http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/content

Response Errors

The possible error responses for this method are as follows:

  • OK-GEN0020

    The error occurs when the isForEdit parameter value is specified in the request.

  • $ERROR.General.BO_MODE_NOT_FOUND_CODE$

    The error occurs when an invalid mode is specified with the request. The valid mode values are KEY, DATA, EXTENDED, and FULL.

  • OKDOM-GEN0006

    The error occurs when you specify any invalid value with the contentState parameter in the HTTP service request.

    The valid values for contentState parameter are: PUBLISHED, LATEST, and LATESTVALID.

  • OKDOM-CONT0121

    The error occurs when you specify LATEST as the contentState value along with the HTTP request when you are logged in as a web user. The content resource does not allow the LATEST as contentState parameter value when you are logged in as a web user.

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/content

    The request returns a paginated list of Content objects in the DATA mode. By default, the list contains the published versions of the content by default.

  • http://<IM_REST_API_HOST>/km/api/content?mode=KEY

    The request returns a paginated list of Content objects in the key mode.

  • http://<IM_REST_API_HOST>/km/api/content?mode=EXTENDED

    The request returns a paginated list of Content objects in the extended mode.

  • http://<IM_REST_API_HOST>/km/api/content?mode=FULL

    The request returns a paginated list of Content objects in the full mode.

  • http://<IM_REST_API_HOST>/km/api/content?mode=KEY&limit=5&offset=10

    The request returns a paginated list of at most five Content objects in the key mode. The list starts with the tenth content of all contents.


Find by query

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


This method returns a list of knowledge articles that match the specified criteria.

Article Version

In general, the service returns the published and live version of the article.

To specify whether you want the published (and live) or the latest version of the article, you may use the contentState parameter and set the value to PUBLISHED or LATESTVALID, respectively. The default value is PUBLISHED.

Article Size

The service returns the knowledge article in a content business object (or content BO). The developer can select the size of the content BO returned by the application by using the mode parameter. The software supports four values, from smallest to largest: KEY, DATA, EXTENDED, and FULL. The information returned by the larger mode contains all of the information returned by the smaller mode. For example, the DATA content BO contains all of the information of the KEY content BO.

When the KEY mode is used, the software returns a limited amount of article information, e.g. title, document id, and date modified. The KEY mode can be used to create a list of articles.

When the DATA mode is used, the software returns much more information about the article, but not the contents of the article. This is the default value when requesting a list of articles.

When the EXTENDED mode is used, the software returns all the information about the content, except for security and visibility filtering fields attributes such as categories, userGroups and views. The EXTENDED mode can be used to display an article to an end-customer, agent or author.

When the FULL mode is used, the software returns all of the information about the article. The FULL mode can be used so that a user or a program can update the article. This is the default value of the mode parameter when requesting a single article.

For example, to retrieve all information about an article with a given documentId, submit a call using the URI:

GET http://<IM_REST_API_HOST>/km/api/latest/content/?q=documentId+eq+'id'&mode=FULL

Response Errors

The possible error responses for this method are as follows:

  • OK-GEN0020

    The error occurs when the isForEdit parameter value is given with the request

  • $ERROR.General.BO_MODE_NOT_FOUND_CODE$

    The error occurs when an invalid mode is specified with the request. The valid mode values are KEY, DATA, EXTENDED, and FULL.

  • OKDOM-GEN0006

    The error occurs when you specify any invalid value with the HTTP service request.

    The valid values for contentState parameter are: PUBLISHED and LATESTVALID.

  • OKDOM-CRIT0026

    The error occurs when you specify locale criteria parameter along with the langpref request parameter.

  • OKDOM-GEN0001

    The error occurs in any of the following cases:

    • No content is found by the specified record ID.
    • The kmauthtoken header contains an interface ID for which no interface is found.
    • The interface ID given with the interfaceId parameter is invalid.

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'

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

documentIdYY'type' : 'string'

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

titleYY'type' : 'string'

The tittle of the document.

answerIdYY'type' : 'integer'

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

localeYN'$ref' : '#/definitions/LocaleKey'

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:

  • 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:
    http://<IM_REST_API_HOST>/km/api/content?q=locale.recordId eq 'es_ES'
articleStatusYN'$ref' : '#/definitions/ArticleStatusKey'

The article status.

    The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the articleStatus.refKey parameter.

    Example URIs for the articleStatus parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')

    • The following example URIs returns Content objects whose contentState is LATEST:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'

    • The following example URI returns Content objects with no article status assigned:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'

    • The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')

    • If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.


    If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.

articleStatusRefKeyYN'type' : 'string'This parameter is to filter content by articleStatus refKey.
dateModifiedYY'type' : 'string', 'format' : 'date-time'

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

displayStartDateYY'type' : 'string', 'format' : 'date-time'

The date when the document will be available to display to end-users.

displayEndDateYY'type' : 'string', 'format' : 'date-time'

The date when the service stops the display of the document to the end users.

displayReviewDateYY'type' : 'string', 'format' : 'date-time'

The date when the document requires a review by an author capable of performing the review.

contentTypeYN'$ref' : '#/definitions/ContentTypeKey'

The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter:

  • contentType.recordId : The unique identifier of the ContentType object.
  • contentType.referenceKey : 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. For Example to request articles for content type FAQ, submit a call using the URI:
    http://<IM_REST_API_HOST>/km/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.
priorityYY'enum' : ['PRIORITY_0', 'PRIORITY_1', 'PRIORITY_2', 'PRIORITY_3', 'PRIORITY_4', 'PRIORITY_5', 'PRIORITY_6', 'PRIORITY_7', 'PRIORITY_8', 'PRIORITY_9', 'PRIORITY_10', 'PRIORITY_11', 'PRIORITY_12', 'PRIORITY_13', 'PRIORITY_14', 'PRIORITY_15', 'PRIORITY_16', 'PRIORITY_17', 'PRIORITY_18', 'PRIORITY_19', 'PRIORITY_20']

The priority assigned to the content.

The valid values are: PRIORITY_0 to PRIORITY_20. For example, PRIORITY_1 or PRIORITY_18 are valid values, but PRIORITY_21 is not.

createDateYY'type' : 'string', 'format' : 'date-time'

The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.

lastModifiedDateYY'type' : 'string', 'format' : 'date-time'

The date when the content was last modified. For legacy systems, the lastModifiedDate date is the date when the document was last modified in those systems.

dateAddedYY'type' : 'string', 'format' : 'date-time'

The date when the content was added to the content type. For legacy systems, the create date is the date when the document was migrated from the legacy system to the Oracle Knowledge Repository.

eventStartDateYY'type' : 'string', 'format' : 'date-time'

The date when the document's event begins.

eventEndDateYY'type' : 'string', 'format' : 'date-time'

The date when the document's event ends.

ownerYN'$ref' : '#/definitions/UserKey'

The user or author who owns or is responsible for the document. The following are the subfields that can be used with owner query parameter:

  • owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:
    http://<IM_REST_API_HOST>/km/api/content?q=owner.recordId eq '{id}'
  • owner.email : User's email.
  • owner.firstName : User's firstName.
  • owner.lastName : User's lastName.
  • owner.login : User's login.
lastModifierYN'$ref' : '#/definitions/UserKey'

The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter:

  • lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:
    http://<IM_REST_API_HOST>/km/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : User's firstName.
  • lastModifier.lastName : User's lastName.
  • lastModifier.login : User's login.
creatorYN'$ref' : '#/definitions/UserKey'

The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter:

  • creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:
    http://<IM_REST_API_HOST>/km/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : User's firstName.
  • creator.lastName : User's lastName.
  • creator.login : User's login.
publishDateYY'type' : 'string', 'format' : 'date-time'

The date when the document was first displayed to end users.

checkedOutYY'type' : 'boolean'

The date when an author has checked out or locked the document for editing.

checkedOutByYN'$ref' : '#/definitions/UserKey'

The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter:

  • checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:
    http://<IM_REST_API_HOST>/km/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : User's firstName.
  • checkedOutBy.lastName : User's lastName.
  • checkedOutBy.login : User's login.
mostPopularYY'type' : 'string'

This is a sort field that you can use to sort the Content objects in the returned list.

The mostPopular parameter value is determined by the number of times the document has been viewed by the end user. The value is sorted by the count in the contentmetrics table. The mostPopular sort field sorts the objects in the order of its popularity among the end-user. The most popular one appears in the top of the list.

Do not use the mostPopular as a value of the query, but use it as a sort field.

NOTE: The mostRecent and mostPopular sort fields cannot be used together.

Example URI combinations when the mostPopular sort filed is used with the contentState and Mode parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/content?q=&orderBy=mostPopular

    The request sort the Content objects by most popular in descending order. The most popular document appears in the top of the list.

  • http://<IM_REST_API_HOST>/km/api/content?q=&orderBy=mostPopular,dateAdded

    The request sort the Content objects by popularity in descending order and the date when they are added in ascending order.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATESTVALID'&orderBy=mostPopular,dateAdded&mode=KEY

    The request sort the Content objects by the mostPopular parameter value in descending order and the dateAdded parameter value in ascending order. The list contains only objects in KEY mode and which have the contentState parameter value as LATESTVALID.

Example URI combinations when the mostPopular sort filed is used with the Categories parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&orderBy=mostPopular&mode=KEY

    The request sort the Content objects in the content type agile_channel and the category world by mostPopular parameter value.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD') and filterMode.contentState eq 'LATESTVALID'&orderBy=mostPopular&mode=KEY

    The request sort the Content objects in the content type agile_channel and the category world by most popular on top of the list. The list contains the latest valid documents.

mostRecentYY'type' : 'string'

This is a sort field that you can use to sort the Content objects in the returned list in order of most recently authored.

Do not use the mostRecent as a value of the query, but use it as a sort field.

NOTE: The mostRecent and mostPopular sort fields cannot be used together.

Example URI combinations when the mostPopular sort filed is used with the contentState, Category object and Mode parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&orderBy=mostRecent&mode=KEY

    The request sort the Content objects in the content type agile_channel and the Category world by most recently authored document on the top of the list. As no content state is mentioned the service sorts the result by published date. The default value of the contentState parameter is PUBLISHED.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD') and filterMode.contentState eq 'LATESTVALID'&orderBy=mostRecent&mode=KEY

    The request sort the Content objects in the content type agile_channel and the category world by most recently authored document on the top of the list. The list contains the latest valid documents that do not need publishing. As the content state is LATESTVALID service sorts the list by dateModified parameter value instead of publishedDate parameter value.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD') and filterMode.contentState eq 'PUBLISHED'&orderBy=mostRecent&mode=KEY

    The request sort the Content objects in the content type agile_channel and the category world by most recently authored document on the top of the list. The list contains the published documents.

expiredYN'type' : 'boolean'Flag to return only expired documents.
contentStateYN'enum' : ['PUBLISHED', 'LATEST', 'LATESTVALID', 'EXPIRED', 'DRAFT']

The state of the content. The valid values are PUBLISHED and LATESTVALID.

Supply the contentState parameter value as filterMode.contentState and not as contentState. When traversing the content relationship from a resource other than content, it must also be provided as filterMode.contentState and not as content.contentState or filterMode.content.contentState as the relationship traversal pattern would allude to.

An author can publish a document in either of the two types; published live or published pending. Following are their definitions:

  • The published live is when the document is currently available to end-users.
  • The published pending is when the document is published to make it available to end user in the future.

NOTE: The published contentState parameter value only considers documents that are published live.

The displayStartDate and displayEndDate, referred to as the display dates, are the criteria that determine whether a document version meets the contentState requirments. The service considers the display dates as invalid if the date when the request is made does not fall between the range of the displayStartDate and the displayEndDate.

NOTE: If the document is not available to end-users when the request is made, the document is considered to have invalid display dates. This does not include published pending documents that have the displayStartDate in the future.

Example URI combinations, when the contentState parameter is used with its valid values are as follows:

The contentState parameter used with published.

  • http://<IM_REST_API_HOST>/km/api/content?q=filterMode.contentState eq 'PUBLISHED'

    The request returns the published live versions of documents that are published live.

    The contentState parameter used with latest valid.

  • http://<IM_REST_API_HOST>/km/api/content?q=filterMode.contentState eq 'LATESTVALID'

    The request returns the documents that have a latest valid version.

The following are the rules that determine which version of the document becomes the latest valid version:

  • If both published live and published pending versions exist, then the service returns the published live version.
  • If only published pending version exist, then return nothing.
  • If no published pending version exists, then the service returns the latest version if the display dates are valid.
  • If no published pending version exists and the latest version has invalid display dates, then the service returns the published live version.
  • If no published versions exist and the latest version has invalid display dates, then returns nothing.
workflowStepYN'$ref' : '#/definitions/WorkflowStepKey'

The step of the workflow in which the document version currently exist.

wfStepNotificationOverrideYY'type' : 'string', 'format' : 'date-time'

The date when the service sends notification to the author involved in the review. Once the workflow notification is given, the service updates the next review date.

categoriesYN'$ref' : '#/definitions/ListCategoryKey'

The Category object or list of Category objects assigned to the Content.

For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.

The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.

    Match Any

    The service matches any of the category specified in the request if you pass the contentType.refKey eq parameter or contentType.refKey in parameter with the request.

    Example URIs for the category parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

    • The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

    • The following example URIs returns Content objects that match the multiple criterion specified in the request.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular

    The following example URIs returns Content objects that match the multiple criterion specified in the request

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent

    The objects in the returned list are sorted by the published Date.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

    The objects in the returned list are sorted by the dateModified.

    Match ALL

    The service matches all the categories specified in the request if you pass the andcategories.refKey matchAll parameter with the request.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY

    The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular

    The objects in the returned list are sorted by the view in descending order.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

    The objects in the returned list are sorted by the published date descending order.

userGroupsYN'$ref' : '#/definitions/ListUserGroupKey'

The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.

viewsYN'$ref' : '#/definitions/ListViewKey'

The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.

Request

Query Parameters
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.
    Allowed Values: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
  • Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList ContentData
Type: object
Title: ResultList ContentData
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : ContentData
Type: object
Title: ContentData
Show Source
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
Nested Schema : ArticleStatusKey
Type: object
Title: ArticleStatusKey
Show Source
  • links

  • The localized name of the ArticleStatus object. The name field can only be used for sorting.

  • The unique identifier of the ArticleStatus object.

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

Nested Schema : LocaleKey
Type: object
Title: LocaleKey
Show Source
Nested Schema : UserKey
Type: object
Title: UserKey
Show Source
  • Email of the User object
  • 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.
  • 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.
  • links
  • User's full name
  • The unique record ID of the User object.
Nested Schema : ContentTypeKey
Type: object
Title: ContentTypeKey
Show Source

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

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

  • links

  • 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.

  • The unique identifier of the ContentType object.

  • 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.

  • Lookup code that indicates the stripe code.

Nested Schema : ContentKey
Type: object
Title: ContentKey
Show Source
Nested Schema : DataForm
Type: object
Title: DataForm
Show Source
Nested Schema : AggregateFormResults
Type: object
Title: AggregateFormResults
Show Source
Nested Schema : schemaAttributes
Type: array

This field will return list of schema attributes associated with the content type of this content.

This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

Show Source
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
Nested Schema : schemaAttributes
Type: array

This field will return list of schema attributes associated with the content type of this content.

This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

Show Source
Nested Schema : SchemaAttribute
Type: object
Title: SchemaAttribute
Show Source
Nested Schema : children
Type: array
List of child nodes of the current element
Show Source
Nested Schema : localizedAttributes
Type: array
List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
Show Source
Nested Schema : schemaAttributeUserGroupList
Type: array
List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType
Show Source
Nested Schema : LocalizedAttributes
Type: object
Title: LocalizedAttributes
Show Source
Nested Schema : SchemaAttributeUserGroup
Type: object
Title: SchemaAttributeUserGroup
Show Source
Nested Schema : UserGroupKey
Type: object
Title: UserGroupKey
Show Source

  • The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.

  • The ExternalType is the type of the corresponding userGroup from an external system.

  • links

  • The localized name of the user group. The name field can only be used for sorting.

  • The unique identifier from the TAG table that represent a userGroups resource

  • The non localized name of the user group

  • Stripe for UserGroup

Nested Schema : questions
Type: array
To Many Relationship to Question
Show Source
Nested Schema : views
Type: array
To Many Relationship to View
Show Source
Nested Schema : DataFormQuestion
Type: object
Title: DataFormQuestion
Show Source
Nested Schema : answers
Type: array
To Many Relationship to Answer
Show Source
Nested Schema : DataFormKey
Type: object
Title: DataFormKey
Show Source
Nested Schema : DataFormAnswer
Type: object
Title: DataFormAnswer
Show Source
Nested Schema : DataFormQuestionKey
Type: object
Title: DataFormQuestionKey
Show Source
  • links
  • The unique record ID of the DataFormQuestion object.
  • The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.
Nested Schema : ViewKey
Type: object
Title: ViewKey
Show Source
Nested Schema : questions
Type: array
To Many Relationship to AggregateQuestionResult
Show Source
Nested Schema : AggregateQuestionResult
Type: object
Title: AggregateQuestionResult
Show Source
Nested Schema : answers
Type: array
To Many Relationship to AggregateAnswerResult
Show Source
Nested Schema : AggregateAnswerResult
Type: object
Title: AggregateAnswerResult
Show Source
  • Localized display name for the Answer
  • The unique record ID of the AggregateAnswerResult object.
  • The reference key for the AggregateAnswerResult object. AggregateAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.
  • TotalResponses of the AggregateAnswerResult object
Back to Top

Examples

The following example shows how to find all content record objects from Oracle Knowledge repository.

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/content" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "contentType": {
        "recordId": "BC015169991F49738196682D57E7C5E3",
        "referenceKey": "SOLUTION",
        "name": "Solution",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/contentTypes/BC015169991F49738196682D57E7C5E3",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "priority": "PRIORITY_0",
      "createDate": "2016-10-19T07:48:11-0600",
      "dateAdded": "2017-03-07T16:06:08-0700",
      "displayStartDate": "2016-10-19T07:45:47-0600",
      "displayEndDate": "9999-12-31T00:00:00-0700",
      "owner": {
        "recordId": "040036719791200157210710b5007f80",
        "name": "John Baird",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/040036719791200157210710b5007f80",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "lastModifier": {
        "recordId": "0400864aa0bf1015796a9cbbf007fea",
        "name": "autocsoadm1 svc",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/0400864aa0bf1015796a9cbbf007fea",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "creator": {
        "recordId": "040036719791200157210710b5007f80",
        "name": "John Baird",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/040036719791200157210710b5007f80",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "published": true,
      "publishDate": "2017-03-07T16:06:08-0700",
      "checkedOut": false,
      "publishedVersion": "3.0",
      "recordId": "0400362a57eb0e0157d88fc1db007f16",
      "versionId": "040036745e3985015aaa717506007f48",
      "documentId": "SOL64",
      "title": "Problems Caused When Service Item Flexfield is not Defined Correctly",
      "version": "3.0",
      "answerId": 1000147,
      "locale": {
        "recordId": "en_US",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/locales/en_US",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "dateModified": "2017-03-07T16:06:08-0700",
      "links": [
        {
          "rel": "canonical",
          "href": "https://IM_REST_API_HOST/km/api/latest/content/0400362a57eb0e0157d88fc1db007f16",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "https://IM_REST_API_HOST/km/api/latest/content",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "https://IM_REST_API_HOST/km/api/latest/metadata-catalog/content"
        }
      ]
    }
  ]
  "hasMore": true,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "https://IM_REST_API_HOST/km/api/latest/content?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "next",
      "href": "https://IM_REST_API_HOST/km/api/latest/content?limit=20&offset=20",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}
Back to Top