REST API for Knowledge Management in Oracle Fusion Service

Root Schema : Content

Type: object

Title: Content

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.
articleStatus(optional): object ArticleStatusKey

Title: ArticleStatusKey
basedLocale(optional): object LocaleKey

Title: LocaleKey
basedOnVersion(optional): string

Version of the Content object
categories(optional): array categories
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.
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY
- 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.
- 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.
checkedOut(optional): boolean

The date when an author has checked out or locked the document for editing.
checkedOutBy(optional): object UserKey

Title: UserKey
contentType(optional): object ContentTypeKey

Title: ContentTypeKey
createDate(optional): 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(optional): object UserKey

Title: UserKey
dateAdded(optional): 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(optional): string(date-time)

The date when the content was last modified in the Oracle Knowledge Repository.
displayEndDate(optional): string(date-time)

The date when the service stops the display of the document to the end users.
displayPosition(optional):

Allowed Values: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]

LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness
displayReviewDate(optional): string(date-time)

The date when the document requires a review by an author capable of performing the review.
displayStartDate(optional): string(date-time)

The date when the document will be available to display to end-users.
documentId(optional): string

The unique identifier of a document that indicates the content type in which the content is saved.
eventEndDate(optional): string(date-time)

The date when the document's event ends.
eventStartDate(optional): string(date-time)

The date when the document's event begins.
isForEdit(optional): boolean

The parameter to request editable content.
lastModifiedDate(optional): 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(optional): object UserKey

Title: UserKey
latestContent(optional): object ContentKey

Title: ContentKey
links(optional): array links
locale(optional): object LocaleKey

Title: LocaleKey
metaDataResourcePath(optional): string

MetaDataResourcePath of the Content object
metaDataXml(optional): string

MetaDataXml of the Content object
owner(optional): object UserKey

Title: UserKey
pending(optional): boolean

The flag that indicates whether the document is pending for publication.
priority(optional):

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(optional): string(date-time)

The date when the document was first displayed to end users.
published(optional): boolean

The flag that indicates whether the document is published.
publishedContent(optional): object ContentKey

Title: ContentKey
publishedVersion(optional): string

Version of the Content object
rating(optional): object DataForm

Title: DataForm
ratingsAggregate(optional): object AggregateFormResults

Title: AggregateFormResults
reasonForEdit(optional): string

Reasons for editing or creating a content. This will only be used when creating or updating the document.
recordId(optional): string

The unique identifier of the document. This ID is same in all versions in all locales of the document.
replacementTokens(optional): array replacementTokens

The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.
resourcePath(optional): string

EXAMPLE URL : http://<IM_REST_API_HOST>/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. If the user name is not passed then it will be defaulted to 'guest' user.
schemaAttributes(optional): 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(optional): string

The tittle of the document.
userGroups(optional): array userGroups

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.
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.
views(optional): array views

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.
wfStepNotificationOverride(optional): string(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.
workflowStep(optional): object WorkflowStepKey

Title: WorkflowStepKey
xml(optional): string

Xml of the Content object

{
    "title":"Content",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>",
            "type":"string"
        },
        "basedOnVersion":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "eventEndDate":{
            "description":"<p>The date when the document's event ends.</p>",
            "format":"date-time",
            "type":"string"
        },
        "contentType":{
            "description":"<p>The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter: </p> <ul> <li>contentType.recordId : The unique identifier of the ContentType object.</li> <li>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: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.referenceKey eq 'FAQ'</code></li> <li>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.</li> </ul>",
            "$ref":"#/definitions/ContentTypeKey"
        },
        "displayReviewDate":{
            "description":"<p>The date when the document requires a review by an author capable of performing the review.</p>",
            "format":"date-time",
            "type":"string"
        },
        "displayPosition":{
            "description":"LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness",
            "enum":[
                "FIXED_AT_TOP",
                "PLACE_AT_TOP",
                "HISTORICAL_USEFULNESS"
            ]
        },
        "priority":{
            "description":"<p>The priority assigned to the content.</p><p>The valid values are: PRIORITY_0 to PRIORITY_20. For example, PRIORITY_1 or PRIORITY_18 are valid values, but PRIORITY_21 is not.</p>",
            "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"
            ]
        },
        "pending":{
            "description":"<p>The flag that indicates whether the document is pending for publication.</p>",
            "type":"boolean"
        },
        "lastModifier":{
            "description":"<p>The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter: </p> <ul> <li>lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=lastModifier.recordId eq '{id}'</code></li> <li>lastModifier.email : User's email.</li>  <li>lastModifier.firstName : User's firstName.</li>  <li>lastModifier.lastName : User's lastName.</li>  <li>lastModifier.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "articleStatus":{
            "description":"<p>The article status.</p> <ul> <p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p> <p>Example URIs for the articleStatus parameter are as follows:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li>    <br/>    <p>The following example URIs returns Content objects whose contentState is LATEST:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li> </br>       <p>The following example URI returns Content objects with no article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li>    </br>       <p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li>    </br>       <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>    <br/>    <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>  </ul>",
            "$ref":"#/definitions/ArticleStatusKey"
        },
        "reasonForEdit":{
            "description":"Reasons for editing or creating a content. This will only be used when creating or updating the document.",
            "type":"string"
        },
        "publishDate":{
            "description":"<p>The date when the document was first displayed to end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "replacementTokens":{
            "items":{
                "$ref":"#/definitions/ReplacementToken"
            },
            "description":"<p>The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.</p>",
            "type":"array"
        },
        "metaDataXml":{
            "description":"MetaDataXml of the Content object",
            "type":"string"
        },
        "eventStartDate":{
            "description":"<p>The date when the document's event begins.</p>",
            "format":"date-time",
            "type":"string"
        },
        "xml":{
            "description":"Xml of the Content object",
            "type":"string"
        },
        "ratingsAggregate":{
            "description":"<p>The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "$ref":"#/definitions/AggregateFormResults"
        },
        "metaDataResourcePath":{
            "description":"MetaDataResourcePath of the Content object",
            "type":"string"
        },
        "owner":{
            "description":"<p>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: </p> <ul> <li>owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=owner.recordId eq '{id}'</code></li> <li>owner.email : User's email.</li>  <li>owner.firstName : User's firstName.</li>  <li>owner.lastName : User's lastName.</li>  <li>owner.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "checkedOut":{
            "description":"<p>The date when an author has checked out or locked the document for editing.</p>",
            "type":"boolean"
        },
        "workflowStep":{
            "description":"<p>The step of the workflow in which the document version currently exist.</p>",
            "$ref":"#/definitions/WorkflowStepKey"
        },
        "locale":{
            "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>",
            "$ref":"#/definitions/LocaleKey"
        },
        "checkedOutBy":{
            "description":"<p>The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter: </p> <ul> <li>checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=checkedOutBy.recordId eq '{id}'</code></li> <li>checkedOutBy.email : User's email.</li>  <li>checkedOutBy.firstName : User's firstName.</li>  <li>checkedOutBy.lastName : User's lastName.</li>  <li>checkedOutBy.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "dateAdded":{
            "description":"<p>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.</p>",
            "format":"date-time",
            "type":"string"
        },
        "isForEdit":{
            "description":"<p>The parameter to request editable content.",
            "type":"boolean"
        },
        "latestContent":{
            "description":"<p>Latest BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "basedLocale":{
            "description":"<p>The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.</p>",
            "$ref":"#/definitions/LocaleKey"
        },
        "creator":{
            "description":"<p>The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter: </p> <ul> <li>creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=creator.recordId eq '{id}'</code></li> <li>creator.email : User's email.</li>  <li>creator.firstName : User's firstName.</li>  <li>creator.lastName : User's lastName.</li>  <li>creator.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "version":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "resourcePath":{
            "description":"EXAMPLE URL : http://&lt;IM_REST_API_HOST&gt;/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. If the user name is not passed then it will be defaulted to <b>'guest'</b> user.",
            "type":"string"
        },
        "title":{
            "description":"<p>The tittle of the document.</p>",
            "type":"string"
        },
        "displayStartDate":{
            "description":"<p>The date when the document will be available to display to end-users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "createDate":{
            "description":"<p>The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.</p>",
            "format":"date-time",
            "type":"string"
        },
        "published":{
            "description":"<p>The flag that indicates whether the document is published.</p>",
            "type":"boolean"
        },
        "publishedContent":{
            "description":"<p>Published BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "wfStepNotificationOverride":{
            "description":"<p>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.</p>",
            "format":"date-time",
            "type":"string"
        },
        "allTranslations":{
            "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>",
            "type":"array"
        },
        "schemaAttributes":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "userGroups":{
            "items":{
                "$ref":"#/definitions/UserGroupKey"
            },
            "description":"<p>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. </p>",
            "type":"array"
        },
        "views":{
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"<p>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.</p>",
            "type":"array"
        },
        "publishedVersion":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "displayEndDate":{
            "description":"<p>The date when the service stops the display of the document to the end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "lastModifiedDate":{
            "description":"<p>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.</p>",
            "format":"date-time",
            "type":"string"
        },
        "versionId":{
            "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>",
            "type":"string"
        },
        "categories":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>The Category object or list of Category objects assigned to the Content.</p> <p>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.</p> <p>The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.</p> <ul>  <b>Match Any</b>  <p>The service matches any of the category specified in the request if you pass the<code> contentType.refKey eq</code> parameter or <code>contentType.refKey in</code> parameter with the request.</p> <p>Example URIs for the category parameter are as follows:</p>   <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY</code></li>    <br/>    <p>The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY</code></li> <br/> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular</code> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the published Date.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the dateModified.</p></li>  </ul>  <ul> <b>Match  ALL</b> <p>The service matches all the categories specified in the request if you pass the<code> andcategories.refKey matchAll </code> parameter with the request.</code></p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY</code> <p>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.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular</code> <p>The objects in the returned list are sorted by the view in descending order.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent</code> <p>The objects in the returned list are sorted by the published date descending order.</p></li> </ul>",
            "type":"array"
        },
        "answerId":{
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>",
            "type":"integer"
        },
        "rating":{
            "description":"<p>Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>.",
            "$ref":"#/definitions/DataForm"
        },
        "documentId":{
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>",
            "type":"string"
        }
    }
}

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

Title: ContentKey

{
    "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>",
    "type":"array"
}

Nested Schema : ArticleStatusKey

Type: object

Title: ArticleStatusKey

Show Source

links(optional): array links
name(optional): string

The localized name of the ArticleStatus object. The name field can only be used for sorting.
recordId(optional): string

The unique identifier of the ArticleStatus object.
referenceKey(optional): 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.

{
    "title":"ArticleStatusKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ArticleStatus object.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ArticleStatus object. <br/>ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the ArticleStatus object. The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : LocaleKey

Type: object

Title: LocaleKey

Show Source

links(optional): array links
recordId(optional): string

The unique identifier of the Locale object.

{
    "title":"LocaleKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : categories

Type: array

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.

Show Source

Array of: object CategoryKey

Title: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>The Category object or list of Category objects assigned to the Content.</p> <p>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.</p> <p>The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.</p> <ul>  <b>Match Any</b>  <p>The service matches any of the category specified in the request if you pass the<code> contentType.refKey eq</code> parameter or <code>contentType.refKey in</code> parameter with the request.</p> <p>Example URIs for the category parameter are as follows:</p>   <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY</code></li>    <br/>    <p>The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY</code></li> <br/> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular</code> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the published Date.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the dateModified.</p></li>  </ul>  <ul> <b>Match  ALL</b> <p>The service matches all the categories specified in the request if you pass the<code> andcategories.refKey matchAll </code> parameter with the request.</code></p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY</code> <p>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.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular</code> <p>The objects in the returned list are sorted by the view in descending order.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent</code> <p>The objects in the returned list are sorted by the published date descending order.</p></li> </ul>",
    "type":"array"
}

Nested Schema : UserKey

Type: object

Title: UserKey

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.
links(optional): array links
name(optional): string

User's full name
recordId(optional): string

The unique record ID of the User object.

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "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.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "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.",
            "type":"integer"
        }
    }
}

Nested Schema : ContentTypeKey

Type: object

Title: ContentTypeKey

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.
links(optional): array links
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.
stripeCd(optional): string

Lookup code that indicates the stripe code.

{
    "title":"ContentTypeKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ContentType object.</p>",
            "type":"string"
        },
        "stripeCd":{
            "description":"<p>Lookup code that indicates the stripe code.</p>",
            "type":"string"
        },
        "referenceKey":{
            "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>",
            "type":"string"
        },
        "description":{
            "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>",
            "type":"string"
        },
        "name":{
            "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>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : ContentKey

Type: object

Title: ContentKey

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.
articleStatus(optional): object ArticleStatusKey

Title: ArticleStatusKey
dateModified(optional): string(date-time)

The date when the content was last modified in the Oracle Knowledge Repository.
displayEndDate(optional): string(date-time)

The date when the service stops the display of the document to the end users.
displayReviewDate(optional): string(date-time)

The date when the document requires a review by an author capable of performing the review.
displayStartDate(optional): string(date-time)

The date when the document will be available to display to end-users.
documentId(optional): string

The unique identifier of a document that indicates the content type in which the content is saved.
latestContent(optional): object ContentKey

Title: ContentKey
links(optional): array links
locale(optional): object LocaleKey

Title: LocaleKey
publishedContent(optional): object ContentKey

Title: ContentKey
rating(optional): object DataForm

Title: DataForm
ratingsAggregate(optional): object AggregateFormResults

Title: AggregateFormResults
recordId(optional): string

The unique identifier of the document. This ID is same in all versions in all locales of the document.
schemaAttributes(optional): 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(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.

{
    "title":"ContentKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "locale":{
            "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>",
            "$ref":"#/definitions/LocaleKey"
        },
        "allTranslations":{
            "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>",
            "type":"array"
        },
        "schemaAttributes":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "latestContent":{
            "description":"<p>Latest BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "version":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "displayReviewDate":{
            "description":"<p>The date when the document requires a review by an author capable of performing the review.</p>",
            "format":"date-time",
            "type":"string"
        },
        "title":{
            "description":"<p>The tittle of the document.</p>",
            "type":"string"
        },
        "ratingsAggregate":{
            "description":"<p>The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "$ref":"#/definitions/AggregateFormResults"
        },
        "displayStartDate":{
            "description":"<p>The date when the document will be available to display to end-users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "displayEndDate":{
            "description":"<p>The date when the service stops the display of the document to the end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "articleStatus":{
            "description":"<p>The article status.</p> <ul> <p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p> <p>Example URIs for the articleStatus parameter are as follows:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li>    <br/>    <p>The following example URIs returns Content objects whose contentState is LATEST:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li> </br>       <p>The following example URI returns Content objects with no article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li>    </br>       <p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li>    </br>       <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>    <br/>    <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>  </ul>",
            "$ref":"#/definitions/ArticleStatusKey"
        },
        "versionId":{
            "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>",
            "type":"string"
        },
        "answerId":{
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>",
            "type":"integer"
        },
        "rating":{
            "description":"<p>Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>.",
            "$ref":"#/definitions/DataForm"
        },
        "documentId":{
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>",
            "type":"string"
        },
        "publishedContent":{
            "description":"<p>Published BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : DataForm

Type: object

Title: DataForm

Show Source

dateAdded(optional): string(date-time)

The date when the DataForm object was created or added
dateModified(optional): string(date-time)

The date when the DataForm object was last modified.
displayEndDate(optional): string(date-time)

DisplayEndDate of the DataForm object
displayStartDate(optional): string(date-time)

DisplayStartDate of the DataForm object
emailContent(optional): boolean

EmailContent of the DataForm object
links(optional): array links
name(optional): string

The name of the data form. The name field can only be used for sorting.
questions(optional): array questions

To Many Relationship to Question
ratingType(optional): 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(optional): string

The unique record ID of the DataForm object.
referenceKey(optional): 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(optional): object UserKey

Title: UserKey
views(optional): array views

To Many Relationship to View

{
    "title":"DataForm",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataForm object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "displayStartDate":{
            "description":"DisplayStartDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "emailContent":{
            "description":"EmailContent of the DataForm object",
            "type":"boolean"
        },
        "views":{
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"To Many Relationship to View",
            "type":"array"
        },
        "name":{
            "description":"The name of the data form.  The name field can only be used for sorting.",
            "type":"string"
        },
        "displayEndDate":{
            "description":"DisplayEndDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataForm object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "ratingType":{
            "description":"Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>",
            "type":"integer"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/DataFormQuestion"
            },
            "description":"To Many Relationship to Question",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "user":{
            "description":"Relationship to User",
            "$ref":"#/definitions/UserKey"
        }
    }
}

Nested Schema : AggregateFormResults

Type: object

Title: AggregateFormResults

Show Source

links(optional): array links
questions(optional): array questions

To Many Relationship to AggregateQuestionResult
recordId(optional): string

The unique record ID of the AggregateFormResults object.
referenceKey(optional): 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(optional): integer

TotalResponses of the AggregateFormResults object

{
    "title":"AggregateFormResults",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateFormResults object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateFormResults object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/AggregateQuestionResult"
            },
            "description":"To Many Relationship to AggregateQuestionResult",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : replacementTokens

Type: array

The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.

Show Source

Array of: object ReplacementToken

Title: ReplacementToken

{
    "items":{
        "$ref":"#/definitions/ReplacementToken"
    },
    "description":"<p>The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.</p>",
    "type":"array"
}

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

Array of: object SchemaAttribute

Title: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
    "type":"array"
}

Nested Schema : userGroups

Type: array

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.

Show Source

Array of: object UserGroupKey

Title: UserGroupKey

{
    "items":{
        "$ref":"#/definitions/UserGroupKey"
    },
    "description":"<p>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. </p>",
    "type":"array"
}

Nested Schema : views

Type: array

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.

Show Source

Array of: object ViewKey

Title: ViewKey

{
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"<p>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.</p>",
    "type":"array"
}

Nested Schema : WorkflowStepKey

Type: object

Title: WorkflowStepKey

Show Source

links(optional): array links
name(optional): string

Localized name of the workflow step
recordId(optional): string

GUID from the WORKFLOWSTEP table
referenceKey(optional): string

Non localized name of the workflow step

{
    "title":"WorkflowStepKey",
    "properties":{
        "recordId":{
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized name of the workflow step",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the workflow step",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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.

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "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"
    ],
    "type":"object"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : CategoryKey

Type: object

Title: CategoryKey

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.
inventoryOrgId(optional): integer

The inventory organization id of the specific product.
links(optional): array links
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.

{
    "title":"CategoryKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</p>",
            "type":"string"
        },
        "responseLocale":{
            "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>",
            "type":"string"
        },
        "childrenCount":{
            "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>",
            "type":"integer"
        },
        "externalType":{
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>",
            "type":"string"
        },
        "parents":{
            "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>",
            "type":"array"
        },
        "referenceKey":{
            "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>",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

Title: CategoryKey

{
    "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>",
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

Title: ContentKey

{
    "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>",
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

Array of: object SchemaAttribute

Title: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
    "type":"array"
}

Nested Schema : SchemaAttribute

Type: object

Title: SchemaAttribute

Show Source

allowMultipleNodes(optional): boolean

Flag indicating if multiple nodes are allowed of this type @since 8.3
allowPreselectedUserGroupChange(optional): boolean

Enable editors to modify preselected user group restrictions @since 8.3
children(optional): array children

List of child nodes of the current element
counter(optional): 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(optional): string

This attribute contains the prefix that is appended to the front of the DOC ID counter
dateAdded(optional): string(date-time)

This attribute represents the timestamp when the SchemaAttribute definition was first created
dateModified(optional): string(date-time)

This attribute represents the timestamp when the SchemaAttribute definition was last modified
description(optional): string

Localized help text for the attribute. This text is displayed in the authoring view
enableAttributeLevelSearch(optional): 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(optional): boolean

Flag indicating whether this field should be included in the full text index. This field was previously called indexable @since 8.3
includeInMasterIdentifier(optional): boolean

Flag indicating whether this field should be appended to the master identifier of the document
isNode(optional): boolean

Flag indicating if this element is a node @since 8.3
isRequired(optional): boolean

Make attribute a required field @since 8.3
links(optional): array links
localizedAttributes(optional): array localizedAttributes

List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
name(optional): string

Localized name of the attribute. This need NOT be unique within the Schema.
readOnly(optional): boolean

Flag indicating whether this field is editable
recordId(optional): string

Unique identifier for the SchemaAttribute object
referenceKey(optional): 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(optional): boolean

Attribute requires workflow approval if workflow is enabled
schemaAttributeUserGroupList(optional): 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(optional):

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(optional): 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(optional): boolean

Restrict attribute to selected user groups
securityRegex(optional): string

The regular expression used to validate the field against security attacks.
sortOrder(optional): integer

Display order of the schema attributes within the edit form
textHeight(optional): string

Specifies the text height for text areas and rich text fields
textWidth(optional): string

Specifies the max length for text fields
userGroupSelectionRequired(optional): boolean

User groups are required for attribute
wysiwygType(optional):

Allowed Values: [ "BASIC", "MEDIUM", "FULL" ]

Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM @since 8.3
xpath(optional): string

The XPATH of this attribute within the schema. This is unique within the Schema.

{
    "title":"SchemaAttribute",
    "properties":{
        "recordId":{
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string"
        },
        "textHeight":{
            "description":"Specifies the text height for text areas and rich text fields",
            "type":"string"
        },
        "dateModified":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was last modified",
            "format":"date-time",
            "type":"string"
        },
        "wysiwygType":{
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM          @since 8.3",
            "enum":[
                "BASIC",
                "MEDIUM",
                "FULL"
            ]
        },
        "includeInMasterIdentifier":{
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean"
        },
        "allowMultipleNodes":{
            "description":"Flag indicating if multiple nodes are allowed of this type          @since 8.3",
            "type":"boolean"
        },
        "dateAdded":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was first created",
            "format":"date-time",
            "type":"string"
        },
        "children":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"List of child nodes of the current element",
            "type":"array"
        },
        "securedFileResource":{
            "description":"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",
            "type":"boolean"
        },
        "xpath":{
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "type":"string"
        },
        "description":{
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "type":"string"
        },
        "secureWithUserGroups":{
            "description":"Restrict attribute to selected user groups",
            "type":"boolean"
        },
        "userGroupSelectionRequired":{
            "description":"User groups are required for attribute",
            "type":"boolean"
        },
        "securityRegex":{
            "description":"The regular expression used to validate the field against security attacks.",
            "type":"string"
        },
        "sortOrder":{
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer"
        },
        "counter":{
            "description":"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",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "counterPrefix":{
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "type":"string"
        },
        "textWidth":{
            "description":"Specifies the max length for text fields",
            "type":"string"
        },
        "allowPreselectedUserGroupChange":{
            "description":"Enable editors to modify preselected user group restrictions          @since 8.3",
            "type":"boolean"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array"
        },
        "isNode":{
            "description":"Flag indicating if this element is a node          @since 8.3",
            "type":"boolean"
        },
        "readOnly":{
            "description":"Flag indicating whether this field is editable",
            "type":"boolean"
        },
        "enableFullTextSearch":{
            "description":"Flag indicating whether this field should be included in the full text index. This field was previously           called indexable          @since 8.3",
            "type":"boolean"
        },
        "isRequired":{
            "description":"Make attribute a required field          @since 8.3",
            "type":"boolean"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "schemaAttributeUserGroupList":{
            "items":{
                "$ref":"#/definitions/SchemaAttributeUserGroup"
            },
            "description":"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",
            "type":"array"
        },
        "requireWorkflowApproval":{
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean"
        },
        "schemaAttrType":{
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "enum":[
                "TEXT_AREA",
                "WYSIWYG_EDIT",
                "TEXT_FIELD",
                "FILE",
                "BOOLEAN",
                "LIST",
                "COUNTER",
                "DATE",
                "DATETIME",
                "TIME",
                "INTEGER",
                "FLOAT"
            ]
        },
        "enableAttributeLevelSearch":{
            "description":"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",
            "type":"boolean"
        }
    }
}

Nested Schema : children

Type: array

List of child nodes of the current element

Show Source

Array of: object SchemaAttribute

Title: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"List of child nodes of the current element",
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : localizedAttributes

Type: array

List of LocalizedAttributes of this SchemaAttribute name and description in various Locales

Show Source

Array of: object LocalizedAttributes

Title: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array"
}

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

Array of: object SchemaAttributeUserGroup

Title: SchemaAttributeUserGroup

{
    "items":{
        "$ref":"#/definitions/SchemaAttributeUserGroup"
    },
    "description":"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",
    "type":"array"
}

Nested Schema : LocalizedAttributes

Type: object

Title: LocalizedAttributes

Show Source

description(optional): string

Localized description in the above Locale
localeId(optional): string

RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
name(optional): string

Localized Name in the above Locale

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

Nested Schema : SchemaAttributeUserGroup

Type: object

Title: SchemaAttributeUserGroup

Show Source

defaultValue(optional): boolean

Flag indiacting whether the user group should be selected by default
recordId(optional): string

GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table
userGroup(optional): object UserGroupKey

Title: UserGroupKey

{
    "title":"SchemaAttributeUserGroup",
    "properties":{
        "recordId":{
            "description":"GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table",
            "type":"string"
        },
        "userGroup":{
            "description":"Reference to the user group associated with this schema attribute",
            "$ref":"#/definitions/UserGroupKey"
        },
        "defaultValue":{
            "description":"Flag indiacting whether the user group should be selected by default",
            "type":"boolean"
        }
    }
}

Nested Schema : UserGroupKey

Type: object

Title: UserGroupKey

Show Source

externalId(optional): 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(optional): string

The ExternalType is the type of the corresponding userGroup from an external system.
links(optional): array links
name(optional): string

The localized name of the user group. The name field can only be used for sorting.
recordId(optional): string

The unique identifier from the TAG table that represent a userGroups resource
referenceKey(optional): string

The non localized name of the user group
stripeCD(optional): string

Stripe for UserGroup

{
    "title":"UserGroupKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>",
            "type":"string"
        },
        "externalType":{
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The non localized name of the user group</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe for UserGroup</p>",
            "type":"string"
        },
        "externalId":{
            "description":"<p>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.</p>",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : questions

Type: array

To Many Relationship to Question

Show Source

Array of: object DataFormQuestion

Title: DataFormQuestion

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

Nested Schema : views

Type: array

To Many Relationship to View

Show Source

Array of: object ViewKey

Title: ViewKey

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

Nested Schema : DataFormQuestion

Type: object

Title: DataFormQuestion

Show Source

answers(optional): array answers

To Many Relationship to Answer
dataForm(optional): object DataFormKey

Title: DataFormKey
dateAdded(optional): string(date-time)

The date when the DataFormQuestion object was created or added
dateModified(optional): string(date-time)

The date when the DataFormQuestion object was last modified.
isMasterIdentifier(optional): boolean

IsMasterIdentifier of the DataFormQuestion object
links(optional): array links
name(optional): string

Name of the DataFormQuestion object
recordId(optional): string

The unique record ID of the DataFormQuestion object.
referenceKey(optional): 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(optional): boolean

Required of the DataFormQuestion object
sortOrder(optional): integer

SortOrder of the DataFormQuestion object
specialTypeIndicator(optional): integer

SpecialTypeIndicator of the DataFormQuestion object

{
    "title":"DataFormQuestion",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormQuestion object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "isMasterIdentifier":{
            "description":"IsMasterIdentifier of the DataFormQuestion object",
            "type":"boolean"
        },
        "specialTypeIndicator":{
            "description":"SpecialTypeIndicator of the DataFormQuestion object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormQuestion object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormQuestion object",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/DataFormAnswer"
            },
            "description":"To Many Relationship to Answer",
            "type":"array"
        },
        "dataForm":{
            "description":"Relationship to Rating",
            "$ref":"#/definitions/DataFormKey"
        },
        "dateAdded":{
            "description":"The date when the DataFormQuestion object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "required":{
            "description":"Required of the DataFormQuestion object",
            "type":"boolean"
        }
    }
}

Nested Schema : answers

Type: array

To Many Relationship to Answer

Show Source

Array of: object DataFormAnswer

Title: DataFormAnswer

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

Nested Schema : DataFormKey

Type: object

Title: DataFormKey

Show Source

links(optional): array links
recordId(optional): string

The unique record ID of the DataForm object.
referenceKey(optional): 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.

{
    "title":"DataFormKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : DataFormAnswer

Type: object

Title: DataFormAnswer

Show Source

dataFormQuestion(optional): object DataFormQuestionKey

Title: DataFormQuestionKey
dateAdded(optional): string(date-time)

The date when the DataFormAnswer object was created or added
dateModified(optional): string(date-time)

The date when the DataFormAnswer object was last modified.
defaultAnswer(optional): boolean

DefaultAnswer of the DataFormAnswer object
links(optional): array links
name(optional): string

Name of the DataFormAnswer object
numberValue(optional): integer

NumberValue of the DataFormAnswer object
recordId(optional): string

The unique record ID of the DataFormAnswer object.
referenceKey(optional): 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(optional): integer

SortOrder of the DataFormAnswer object

{
    "title":"DataFormAnswer",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormAnswer object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormAnswer object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormAnswer object",
            "type":"integer"
        },
        "numberValue":{
            "description":"NumberValue of the DataFormAnswer object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormAnswer object",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataFormAnswer object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "defaultAnswer":{
            "description":"DefaultAnswer of the DataFormAnswer object",
            "type":"boolean"
        },
        "dataFormQuestion":{
            "description":"Relationship to Question",
            "$ref":"#/definitions/DataFormQuestionKey"
        }
    }
}

Nested Schema : DataFormQuestionKey

Type: object

Title: DataFormQuestionKey

Show Source

links(optional): array links
recordId(optional): string

The unique record ID of the DataFormQuestion object.
referenceKey(optional): 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.

{
    "title":"DataFormQuestionKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : ViewKey

Type: object

Title: ViewKey

Show Source

links(optional): array links
name(optional): string

Localized name of the view
recordId(optional): string

GUID of the SITE table containing the view definition
referenceKey(optional): string

Non localized reference key for the view
stripeCD(optional): string

Stripe of a view

{
    "title":"ViewKey",
    "properties":{
        "recordId":{
            "description":"GUID of the SITE table containing the view definition",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized reference key for the view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the view",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe of a view</p>",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : questions

Type: array

To Many Relationship to AggregateQuestionResult

Show Source

Array of: object AggregateQuestionResult

Title: AggregateQuestionResult

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

Nested Schema : AggregateQuestionResult

Type: object

Title: AggregateQuestionResult

Show Source

answers(optional): array answers

To Many Relationship to AggregateAnswerResult
averageResponse(optional): number

AverageResponse of the AggregateQuestionResult object
name(optional): string

Localized display name for the Question
recordId(optional): string

The unique record ID of the AggregateQuestionResult object.
referenceKey(optional): 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(optional): integer

TotalResponses of the AggregateQuestionResult object

{
    "title":"AggregateQuestionResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateQuestionResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateQuestionResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Question",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/AggregateAnswerResult"
            },
            "description":"To Many Relationship to AggregateAnswerResult",
            "type":"array"
        },
        "averageResponse":{
            "description":"AverageResponse of the AggregateQuestionResult object",
            "type":"number"
        }
    }
}

Nested Schema : answers

Type: array

To Many Relationship to AggregateAnswerResult

Show Source

Array of: object AggregateAnswerResult

Title: AggregateAnswerResult

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

Nested Schema : AggregateAnswerResult

Type: object

Title: AggregateAnswerResult

Show Source

name(optional): string

Localized display name for the Answer
recordId(optional): string

The unique record ID of the AggregateAnswerResult object.
referenceKey(optional): 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(optional): integer

TotalResponses of the AggregateAnswerResult object

{
    "title":"AggregateAnswerResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateAnswerResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateAnswerResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"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.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Answer",
            "type":"string"
        }
    }
}

Nested Schema : ReplacementToken

Type: object

Title: ReplacementToken

Show Source

dateAdded(optional): string(date-time)

The date added for the replacement token for the specified locale.
dateModified(optional): string(date-time)

The date modified for the replacement token for the specified locale.
links(optional): array links
recordId(optional): string

The replacement token's record Id.
replacementText(optional): string

The HTML formatted replacement text.
replacementTextNonFormatted(optional): string

The non-HTML formatted replacement text.
tokenName(optional): string

The replacement token's name.
tokenType(optional): string

The token type of the token. Used to specify what kind of text editor was used to create/edit this token: rich text('RICH_TEXT') or plain text('PLAIN_TEXT').

{
    "title":"ReplacementToken",
    "properties":{
        "recordId":{
            "description":"The replacement token's record Id.",
            "type":"string"
        },
        "tokenName":{
            "description":"The replacement token's name.",
            "type":"string"
        },
        "replacementText":{
            "description":"The HTML formatted replacement text.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date modified for the replacement token for the specified locale.",
            "format":"date-time",
            "type":"string"
        },
        "tokenType":{
            "description":"The token type of the token. Used to specify what kind of text editor was used to create/edit this token:  rich text('RICH_TEXT') or plain text('PLAIN_TEXT').",
            "type":"string"
        },
        "replacementTextNonFormatted":{
            "description":"The non-HTML formatted replacement text.",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date added for the replacement token for the specified locale.",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Clear content check out

Request

Response

204 Response

Examples