Get all content
/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.
The following table describes the query parameters for this resource.
Parameter | Queryable | Sortable | Type | Description |
---|---|---|---|---|
recordId | Y | Y | 'type' : 'string' | The unique identifier of the document. This ID is same in all versions in all locales of the document. |
documentId | Y | Y | 'type' : 'string' | The unique identifier of a document that indicates the content type in which the content is saved. |
title | Y | Y | 'type' : 'string' | The tittle of the document. |
answerId | Y | Y | 'type' : 'integer' | The unique identifier that enables mapping between an answer and the content. |
locale | Y | N | '$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:
|
articleStatus | Y | N | '$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 Example URIs for the articleStatus parameter are as follows: OR The following example URIs returns Content objects whose contentState is LATEST: The following example URI returns Content objects with no article status assigned: The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned: 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. |
articleStatusRefKey | Y | N | 'type' : 'string' | This parameter is to filter content by articleStatus refKey. |
dateModified | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the content was last modified in the Oracle Knowledge Repository. |
displayStartDate | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the document will be available to display to end-users. |
displayEndDate | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the service stops the display of the document to the end users. |
displayReviewDate | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the document requires a review by an author capable of performing the review. |
contentType | Y | N | '$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:
|
priority | Y | Y | '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. |
createDate | Y | Y | '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. |
lastModifiedDate | Y | Y | '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. |
dateAdded | Y | Y | '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. |
eventStartDate | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the document's event begins. |
eventEndDate | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the document's event ends. |
owner | Y | N | '$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:
|
lastModifier | Y | N | '$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:
|
creator | Y | N | '$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:
|
publishDate | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the document was first displayed to end users. |
checkedOut | Y | Y | 'type' : 'boolean' | The date when an author has checked out or locked the document for editing. |
checkedOutBy | Y | N | '$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:
|
mostPopular | Y | Y | '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:
Example URI combinations when the mostPopular sort filed is used with the Categories parameter are as follows:
|
mostRecent | Y | Y | '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:
|
expired | Y | N | 'type' : 'boolean' | Flag to return only expired documents. |
contentState | Y | N | '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:
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.
The contentState parameter used with latest valid. The following are the rules that determine which version of the document becomes the latest valid version:
|
workflowStep | Y | N | '$ref' : '#/definitions/WorkflowStepKey' | The step of the workflow in which the document version currently exist. |
wfStepNotificationOverride | Y | Y | '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. |
categories | Y | N | '$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.
The service matches any of the category specified in the request if you pass the Example URIs for the category parameter are as follows: OR The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects. OR The following example URIs returns Content objects that match the multiple criterion specified in the request.
The service matches all the categories specified in the request if you pass the |
userGroups | Y | N | '$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. |
views | Y | N | '$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
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
mode: string
This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.Allowed Values:
[ "KEY", "DATA", "EXTENDED", "FULL" ]
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
-
q: string
Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Response
- application/json
- application/xml
200 Response
object
ResultList ContentData
-
count:
integer
Number of resource instances returned in the current range.
-
hasMore:
boolean
Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
Actual paging size used by the server.
-
links:
array links
-
offset:
integer
Offset value used in the current page.
-
totalResults:
integer
Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
ContentData
-
allTranslations:
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:
integer
The unique identifier that enables mapping between an answer and the content.
-
articleStatus:
object ArticleStatusKey
Title:
ArticleStatusKey
-
basedLocale:
object LocaleKey
Title:
LocaleKey
-
basedOnVersion:
string
Version of the Content object
-
checkedOut:
boolean
The date when an author has checked out or locked the document for editing.
-
checkedOutBy:
object UserKey
Title:
UserKey
-
contentType:
object ContentTypeKey
Title:
ContentTypeKey
-
createDate:
string(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.
-
creator:
object UserKey
Title:
UserKey
-
dateAdded:
string(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.
-
dateModified:
string(date-time)
The date when the content was last modified in the Oracle Knowledge Repository.
-
displayEndDate:
string(date-time)
The date when the service stops the display of the document to the end users.
-
displayPosition:
Allowed Values:
[ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness -
displayReviewDate:
string(date-time)
The date when the document requires a review by an author capable of performing the review.
-
displayStartDate:
string(date-time)
The date when the document will be available to display to end-users.
-
documentId:
string
The unique identifier of a document that indicates the content type in which the content is saved.
-
eventEndDate:
string(date-time)
The date when the document's event ends.
-
eventStartDate:
string(date-time)
The date when the document's event begins.
-
lastModifiedDate:
string(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.
-
lastModifier:
object UserKey
Title:
UserKey
-
latestContent:
object ContentKey
Title:
ContentKey
-
links:
array links
-
locale:
object LocaleKey
Title:
LocaleKey
-
owner:
object UserKey
Title:
UserKey
-
pending:
boolean
The flag that indicates whether the document is pending for publication.
-
priority:
Allowed Values:
[ "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.
-
publishDate:
string(date-time)
The date when the document was first displayed to end users.
-
published:
boolean
The flag that indicates whether the document is published.
-
publishedContent:
object ContentKey
Title:
ContentKey
-
publishedVersion:
string
Version of the Content object
-
rating:
object DataForm
Title:
DataForm
-
ratingsAggregate:
object AggregateFormResults
Title:
AggregateFormResults
-
recordId:
string
The unique identifier of the document. This ID is same in all versions in all locales of the document.
-
schemaAttributes:
array schemaAttributes
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.
-
title:
string
The tittle of the document.
-
version:
string
Version of the Content object
-
versionId:
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.
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.
-
Array of:
object ContentKey
Title:
ContentKey
object
ArticleStatusKey
-
links:
array links
-
name:
string
The localized name of the ArticleStatus object. The name field can only be used for sorting.
-
recordId:
string
The unique identifier of the ArticleStatus object.
-
referenceKey:
string
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.
object
LocaleKey
-
links:
array links
-
recordId:
string
The unique identifier of the Locale object.
object
UserKey
-
email:
string
Email of the User object
-
externalId:
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:
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.
-
links:
array links
-
name:
string
User's full name
-
recordId:
string
The unique record ID of the User object.
object
ContentTypeKey
-
description:
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.
-
links:
array links
-
name:
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:
string
The unique identifier of the ContentType object.
-
referenceKey:
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.
-
stripeCd:
string
Lookup code that indicates the stripe code.
object
ContentKey
-
allTranslations:
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:
integer
The unique identifier that enables mapping between an answer and the content.
-
articleStatus:
object ArticleStatusKey
Title:
ArticleStatusKey
-
dateModified:
string(date-time)
The date when the content was last modified in the Oracle Knowledge Repository.
-
displayEndDate:
string(date-time)
The date when the service stops the display of the document to the end users.
-
displayReviewDate:
string(date-time)
The date when the document requires a review by an author capable of performing the review.
-
displayStartDate:
string(date-time)
The date when the document will be available to display to end-users.
-
documentId:
string
The unique identifier of a document that indicates the content type in which the content is saved.
-
latestContent:
object ContentKey
Title:
ContentKey
-
links:
array links
-
locale:
object LocaleKey
Title:
LocaleKey
-
publishedContent:
object ContentKey
Title:
ContentKey
-
rating:
object DataForm
Title:
DataForm
-
ratingsAggregate:
object AggregateFormResults
Title:
AggregateFormResults
-
recordId:
string
The unique identifier of the document. This ID is same in all versions in all locales of the document.
-
schemaAttributes:
array schemaAttributes
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.
-
title:
string
The tittle of the document.
-
version:
string
Version of the Content object
-
versionId:
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
DataForm
-
dateAdded:
string(date-time)
The date when the DataForm object was created or added
-
dateModified:
string(date-time)
The date when the DataForm object was last modified.
-
displayEndDate:
string(date-time)
DisplayEndDate of the DataForm object
-
displayStartDate:
string(date-time)
DisplayStartDate of the DataForm object
-
emailContent:
boolean
EmailContent of the DataForm object
-
links:
array links
-
name:
string
The name of the data form. The name field can only be used for sorting.
-
questions:
array questions
To Many Relationship to Question
-
ratingType:
integer
Determined whether it is a 5 star or Y/N type of rating
- CUSTOM(0)
- YES(1)
- YES_NO(2)
- THREE_STARS(3)
- FIVE_STARS(4)
-
recordId:
string
The unique record ID of the DataForm object.
-
referenceKey:
string
The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.
-
user:
object UserKey
Title:
UserKey
-
views:
array views
To Many Relationship to View
object
AggregateFormResults
-
links:
array links
-
questions:
array questions
To Many Relationship to AggregateQuestionResult
-
recordId:
string
The unique record ID of the AggregateFormResults object.
-
referenceKey:
string
The reference key for the AggregateFormResults object. AggregateFormResults objects support multiple languages. This field can be used to identify the associated objects for all languages.
-
totalResponses:
integer
TotalResponses of the AggregateFormResults object
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.
-
Array of:
object SchemaAttribute
Title:
SchemaAttribute
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
href(required):
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:
string
Media type, as defined by RFC 2046, describing the link target.
-
method:
string
HTTP method for requesting the target of the link.
-
profile:
string
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
-
rel(required):
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:
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
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.
-
Array of:
object ContentKey
Title:
ContentKey
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
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.
-
Array of:
object SchemaAttribute
Title:
SchemaAttribute
object
SchemaAttribute
-
allowMultipleNodes:
boolean
Flag indicating if multiple nodes are allowed of this type @since 8.3
-
allowPreselectedUserGroupChange:
boolean
Enable editors to modify preselected user group restrictions @since 8.3
-
children:
array children
List of child nodes of the current element
-
counter:
integer
This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType
-
counterPrefix:
string
This attribute contains the prefix that is appended to the front of the DOC ID counter
-
dateAdded:
string(date-time)
This attribute represents the timestamp when the SchemaAttribute definition was first created
-
dateModified:
string(date-time)
This attribute represents the timestamp when the SchemaAttribute definition was last modified
-
description:
string
Localized help text for the attribute. This text is displayed in the authoring view
-
enableAttributeLevelSearch:
boolean
Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This field was previously called searchable @since 8.3
-
enableFullTextSearch:
boolean
Flag indicating whether this field should be included in the full text index. This field was previously called indexable @since 8.3
-
includeInMasterIdentifier:
boolean
Flag indicating whether this field should be appended to the master identifier of the document
-
isNode:
boolean
Flag indicating if this element is a node @since 8.3
-
isRequired:
boolean
Make attribute a required field @since 8.3
-
links:
array links
-
localizedAttributes:
array localizedAttributes
List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
-
name:
string
Localized name of the attribute. This need NOT be unique within the Schema.
-
readOnly:
boolean
Flag indicating whether this field is editable
-
recordId:
string
Unique identifier for the SchemaAttribute object
-
referenceKey:
string
Non localized name of the attribute. SchemaAttribute's referenceKey need NOT be unique within its Schema. But its xpath will be unique within its Schema.
-
requireWorkflowApproval:
boolean
Attribute requires workflow approval if workflow is enabled
-
schemaAttributeUserGroupList:
array schemaAttributeUserGroupList
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
-
schemaAttrType:
Allowed Values:
[ "TEXT_AREA", "WYSIWYG_EDIT", "TEXT_FIELD", "FILE", "BOOLEAN", "LIST", "COUNTER", "DATE", "DATETIME", "TIME", "INTEGER", "FLOAT" ]
Enumerated type representing the type of attribute - i.e. text field, rich text area -
securedFileResource:
boolean
Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file
-
secureWithUserGroups:
boolean
Restrict attribute to selected user groups
-
securityRegex:
string
The regular expression used to validate the field against security attacks.
-
sortOrder:
integer
Display order of the schema attributes within the edit form
-
textHeight:
string
Specifies the text height for text areas and rich text fields
-
textWidth:
string
Specifies the max length for text fields
-
userGroupSelectionRequired:
boolean
User groups are required for attribute
-
wysiwygType:
Allowed Values:
[ "BASIC", "MEDIUM", "FULL" ]
Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM @since 8.3 -
xpath:
string
The XPATH of this attribute within the schema. This is unique within the Schema.
array
-
Array of:
object SchemaAttribute
Title:
SchemaAttribute
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object LocalizedAttributes
Title:
LocalizedAttributes
array
-
Array of:
object SchemaAttributeUserGroup
Title:
SchemaAttributeUserGroup
object
LocalizedAttributes
-
description:
string
Localized description in the above Locale
-
localeId:
string
RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
-
name:
string
Localized Name in the above Locale
object
SchemaAttributeUserGroup
-
defaultValue:
boolean
Flag indiacting whether the user group should be selected by default
-
recordId:
string
GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table
-
userGroup:
object UserGroupKey
Title:
UserGroupKey
object
UserGroupKey
-
externalId:
integer
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.
-
externalType:
string
The ExternalType is the type of the corresponding userGroup from an external system.
-
links:
array links
-
name:
string
The localized name of the user group. The name field can only be used for sorting.
-
recordId:
string
The unique identifier from the TAG table that represent a userGroups resource
-
referenceKey:
string
The non localized name of the user group
-
stripeCD:
string
Stripe for UserGroup
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object DataFormQuestion
Title:
DataFormQuestion
array
-
Array of:
object ViewKey
Title:
ViewKey
object
DataFormQuestion
-
answers:
array answers
To Many Relationship to Answer
-
dataForm:
object DataFormKey
Title:
DataFormKey
-
dateAdded:
string(date-time)
The date when the DataFormQuestion object was created or added
-
dateModified:
string(date-time)
The date when the DataFormQuestion object was last modified.
-
isMasterIdentifier:
boolean
IsMasterIdentifier of the DataFormQuestion object
-
links:
array links
-
name:
string
Name of the DataFormQuestion object
-
recordId:
string
The unique record ID of the DataFormQuestion object.
-
referenceKey:
string
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.
-
required:
boolean
Required of the DataFormQuestion object
-
sortOrder:
integer
SortOrder of the DataFormQuestion object
-
specialTypeIndicator:
integer
SpecialTypeIndicator of the DataFormQuestion object
array
-
Array of:
object DataFormAnswer
Title:
DataFormAnswer
object
DataFormKey
-
links:
array links
-
recordId:
string
The unique record ID of the DataForm object.
-
referenceKey:
string
The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
DataFormAnswer
-
dataFormQuestion:
object DataFormQuestionKey
Title:
DataFormQuestionKey
-
dateAdded:
string(date-time)
The date when the DataFormAnswer object was created or added
-
dateModified:
string(date-time)
The date when the DataFormAnswer object was last modified.
-
defaultAnswer:
boolean
DefaultAnswer of the DataFormAnswer object
-
links:
array links
-
name:
string
Name of the DataFormAnswer object
-
numberValue:
integer
NumberValue of the DataFormAnswer object
-
recordId:
string
The unique record ID of the DataFormAnswer object.
-
referenceKey:
string
The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.
-
sortOrder:
integer
SortOrder of the DataFormAnswer object
object
DataFormQuestionKey
-
links:
array links
-
recordId:
string
The unique record ID of the DataFormQuestion object.
-
referenceKey:
string
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
ViewKey
-
links:
array links
-
name:
string
Localized name of the view
-
recordId:
string
GUID of the SITE table containing the view definition
-
referenceKey:
string
Non localized reference key for the view
-
stripeCD:
string
Stripe of a view
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object AggregateQuestionResult
Title:
AggregateQuestionResult
object
AggregateQuestionResult
-
answers:
array answers
To Many Relationship to AggregateAnswerResult
-
averageResponse:
number
AverageResponse of the AggregateQuestionResult object
-
name:
string
Localized display name for the Question
-
recordId:
string
The unique record ID of the AggregateQuestionResult object.
-
referenceKey:
string
The reference key for the AggregateQuestionResult object. AggregateQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages.
-
totalResponses:
integer
TotalResponses of the AggregateQuestionResult object
array
-
Array of:
object AggregateAnswerResult
Title:
AggregateAnswerResult
object
AggregateAnswerResult
-
name:
string
Localized display name for the Answer
-
recordId:
string
The unique record ID of the AggregateAnswerResult object.
-
referenceKey:
string
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:
integer
TotalResponses of the AggregateAnswerResult object
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 }