Get all content types
/contentTypes
Request
-
indexStatus: boolean
Filters the list of contentTypes based on whether or not indexStatus is enabled.
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
object-
count: integer
(int32)
-
hasMore(required): boolean
Title:
Has MoreDefault Value:falseBoolean indicating whether or not the collection contains more items than were returned in this request. Defaults to false. -
items(required): array
Items
Title:
ItemsThe collection of of the requested resources meeting your criteria. -
limit(required): integer
(int32)
Title:
LimitThe number of items this result is limited to. Used in conjunction with offset for pagination. -
links: array
Links
Title:
LinksREST API canonical and/or collection links for this Singular Resource -
offset(required): integer
(int32)
Title:
OffsetThe item index at which this resultset starts. Used in conjunction with limit for pagination. -
totalResults: integer
(int64)
Title:
Total ResultsThe number of available items that meet the criteria used. This attribute must be explicitly requested by adding totalResults=true to the querystring.
arrayItems-
Array of:
object ContentTypeDataBO
Documentation for BO mode: ContentTypeDataBO
arrayLinksobject-
allowUnsafeHTMLAndJS(required): boolean
Title:
Allow Unsafe HTML and JavaScriptWhen set to true, allows Authors to create Articles with JavaScript and unsafe HTML in this ContentType. Applies only to this ContentType. This defaults to false for all newly created ContentTypes and existing ContentTypes which do have any Articles.
-
articleGroup: object
Type of articles
Title:
Type of articlesRead Only:trueArticle group identify type of article this conten type will have.
The valid values are:
- ARTICLE
- REUSABLE_ARTICLE
-
contentSourceType: string
Title:
content source TypeRead Only:truecontentSourceType to distinguish if it is a content type for external content -
counterPrefix(required): string
Title:
Counter PrefixMinimum Length:1Maximum Length:50The prefix used with all document IDs in a content type. For example, FA is the contentPrefix of the content type FAQ. All document IDs in the content type FAQ begins with the affix FA. -
dateAdded: string
(date)
Title:
Date AddedRead Only:trueThe date when the content type was created.Example:2022-03-10 -
dateModified: string
(date)
Title:
Date ModifiedRead Only:trueThe date when the content type was last modified.
Example:2022-03-10 -
description: string
Title:
DescriptionMaximum Length:255The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user. -
enableIndexing(required): boolean
Title:
Enable IndexingThe flag indicates whether the Oracle Knowledge Search Indexing is enabled for the content type. -
extendReviewDate: boolean
-
family: string
Title:
FamilyRead Only:trueThe Fusion family that this content type belongs to -
indexStatus(required): string
Title:
Index StatusThe status of the documents assigned to have Oracle Knowledge Search indexing.
The valid values are:
- LIVE
- LATEST_VALID_DRAFT
- LIVE_AND_LATEST_VALID_DRAFT
- NONE
-
jobStatus: object
ContentTypeJobStatus
-
links: array
Links
Title:
LinksRead Only:trueREST API canonical and/or collection links for this Singular Resource -
name(required): string
Title:
NameMinimum Length:1Maximum Length:255The 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. -
namespaceFromStripe: string
-
product: string
Title:
ProductRead Only:trueThe Fusion product that this content type belongs to -
recordId: string
Title:
Record IdRead Only:trueThe unique identifier of the ContentType object. -
referenceKey(required): string
Title:
Reference KeyMinimum Length:1Maximum Length:255The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages. -
reviewDate: integer
(int32)
Title:
Review DateThe date on which the document requires review. When the date approaches, the system generates a task for the appropriate author to review the content. -
stripeCd(required): string
Title:
Stripe CdMaximum Length:100Lookup code that indicates the stripe code. -
usageCode: string
Title:
Usage CodeRead Only:trueMaximum Length:30Lookup code that indicates the product usage code. -
validateHtml: boolean
Title:
Validate HtmlThe flag indicates whether the content should be validated to adhere to HTML standards while content authoring. -
workflow: object
Workflow
Title:
WorkflowThe workflow definition that the author can use while content authoring in a content type.
objectType of articlestrueArticle group identify type of article this conten type will have.
The valid values are:
- ARTICLE
- REUSABLE_ARTICLE
[
"ARTICLE",
"REUSABLE_ARTICLE"
]object-
contentType: object
ContentTypeKeyBO
Documentation for BO mode: ContentTypeKeyBO
-
contentTypeId: string
-
dateAdded: string
(date)
Example:
2022-03-10 -
dateModified: string
(date)
Example:
2022-03-10 -
failedCount: integer
(int32)
-
jobId: integer
(int32)
-
processedCount: integer
(int32)
-
recordId: integer
(int32)
-
status: string
Allowed Values:
[ "QUEUED", "SPLIT_AND_QUEUED", "OBJECT_NOT_FOUND_FOR_ID", "RELATED_OBJECT_NOT_FOUND_FOR_ID", "OPTIONAL_RELATED_OBJECT_NOT_FOUND_FOR_ID", "PROCESSING", "CLEANED_AND_PROCESSING", "PROCESSED", "NOTHING_FOUND_TO_PROCESS", "ERROR_RETRY_LATER", "ERROR_REPROCESSING", "ERROR_CANNOT_RETRY", "CLEAN_ERROR_CANNOT_RETRY", "SPLIT_BECAUSE_CHILD_HAD_ERROR", "WAITING_TO_GET_BACKUP_FROM_LEADER", "CHILD_ITEMS_WILL_BE_HANDLED", "CANCELLED", "PROCESSED_VIA_RESTORE", "INDEX_INVALID_ERROR", "INDEX_BACKUP_ZIP_ERROR", "INDEX_BACKUP_FMS_UPLOAD_ERROR", "INDEX_BACKUP_DELETED", "INDEX_BACKUP_NOT_DELETABLE", "INDEX_OPERATION_NOT_FOUND", "INDEX_DIR_CANNOT_BE_DELETED", "INDEX_RESTORE_ATTEMPT_FAILED", "INDEX_RESTORE_CREATE_EMPTY_INDEXES", "FOLLOWER_IGNORED", "RESTORING", "RESTORED", "REINDEX_INITIALIZING", "REINDEX_ES_COPY_STARTED", "REINDEX_ES_COPY_FAILED", "REINDEX_QUEUING", "REINDEX_QUEUED", "REINDEX_QUEUING_FAILED", "REINDEX_PROCESSING", "REINDEX_PROCESSED", "REINDEX_FAILED", "REINDEX_PROCESSING_BATCH", "REINDEX_SKIPPED", "INDEX_UPGRADE_STARTED", "INDEX_UPGRADE_PROCESSING_DYNAMIC", "INDEX_UPGRADE_DYNAMIC_MAPPING_UPDATED", "INDEX_UPGRADE_DYNAMIC_MAPPING_UPDATED_PENDING_FULL_INDEXING", "INDEX_UPGRADE_PROCESSING_STATIC", "INDEX_UPGRADE_PROCESSING_STATIC_SUBMITTING_ES_COPY", "INDEX_UPGRADE_PROCESSING_STATIC_SUBMITTING_ES_COPY_PENDING_FULL_INDEXING", "INDEX_UPGRADE_PROCESSING_STATIC_ES_COPY_COMPLETED", "INDEX_UPGRADE_PROCESSING_STATIC_ES_COPY_COMPLETED_PENDING_FULL_INDEXING", "INDEX_UPGRADE_PROCESSED", "INDEX_UPGRADE_FAILED", "INDEX_UPGRADE_PROCESSING_FULL_INDEXING", "CONTENT_BATCH_INDEXING_QUEUED", "REINDEX_BATCH_QUEUEING_IN_PROGRESS", "REINDEX_BATCH_QUEUEING_COMPLETED", "REINDEX_INDEXING_JOB_LAUNCHED", "REINDEX_CANCELLING", "REINDEX_CANCELLED", "REINDEX_PROCESSED_WITH_WARNINGS" ] -
totalCount: integer
(int32)
arrayLinkstrueobjectWorkflowobject-
articleGroup: object
Type of articles
Title:
Type of articlesRead Only:trueArticle group identify type of article this conten type will have.
The valid values are:
- ARTICLE
- REUSABLE_ARTICLE
-
contentSourceType: string
Title:
content source TypeRead Only:truecontentSourceType to distinguish if it is a content type for external content -
description: string
Title:
DescriptionMaximum Length:255The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user. -
family: string
Title:
FamilyRead Only:trueThe Fusion family that this content type belongs to -
links: array
Links
Title:
LinksRead Only:trueREST API canonical and/or collection links for this Singular Resource -
name(required): string
Title:
NameMinimum Length:1Maximum Length:255The 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. -
namespaceFromStripe: string
-
product: string
Title:
ProductRead Only:trueThe Fusion product that this content type belongs to -
recordId: string
Title:
Record IdRead Only:trueThe unique identifier of the ContentType object. -
referenceKey(required): string
Title:
Reference KeyMinimum Length:1Maximum Length:255The 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(required): string
Title:
Stripe CdMaximum Length:100Lookup code that indicates the stripe code. -
usageCode: string
Title:
Usage CodeRead Only:trueMaximum Length:30Lookup code that indicates the product usage code. -
workflow: object
Workflow
Title:
WorkflowThe workflow definition that the author can use while content authoring in a content type.
objectType of articlestrueArticle group identify type of article this conten type will have.
The valid values are:
- ARTICLE
- REUSABLE_ARTICLE
[
"ARTICLE",
"REUSABLE_ARTICLE"
]arrayLinkstrueobjectWorkflowobject-
enabled: boolean
-
links: array
links
-
name: string
Maximum Length:
255 -
recordId: string
-
referenceKey: string
Minimum Length:
0Maximum Length:100 -
workflowVersion: integer
(int32)