1. REST API for Knowledge Management with the Redwood User Experience
  2. Tasks
  3. Articles

Get all knowledge articles

get

/articles

Request

Query Parameters
  • This parameter filters the fields returned in the response; look at the response schema to see the possible values. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links).

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource and root fields: ?fields=Attribute1;Child:Attribute1,Attribute2
    Example:
    Attribute1;Child:Attribute1,Attribute2
  • his parameter filters the returned items based on locale. If used, this parameter will take precedence over Accept-Language.
    Example:
    fr_FR
  • Minimum Value: 1
    Maximum Value: 1000
    This parameter restricts the number of items returned per page. If the limit exceeds the available items then all are returned. The maximum value is 1000.
    Default Value: 20
  • Minimum Value: 0
    Used for pagination, this parameter indicates the starting point in the collection, for example. if you are returning 10 per page, have 100 items, and want to return the second page you would use limit=10&offset=10. If offset exceeds the resource count then no resources are returned. Default value is 0.
    Default Value: 0
  • Prevents links from being returned in the response, defaults to false.
    Default Value: false
  • This parameter orders items returned based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc".
    Example:
    field1:asc,field2:desc
  • Used to filter the items in your response. The available attribute/parameter combinations and usage instructions can be found in Reference > Supported Query Parameters.
  • Causes the response to include an "estimated row count" when "?totalResults=true", otherwise this count is not included. The default value is "false". It is recommended to only use this as part of the request for your first page of results.
    Default Value: false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ResultListBOContentDataBO
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The collection of of the requested resources meeting your criteria.
Show Source
Nested Schema : ContentDataBO
Type: object
Documentation for BO mode: ContentDataBO
Show Source
Nested Schema : All Translations
Type: array
Title: All Translations
Read Only: true
Contains a collection of translations available of an article, if there are any.
Show Source
Nested Schema : All Versions
Type: array
Title: All Versions
Read Only: true
Contains a collection of all versions of an article.
Show Source
Nested Schema : articleStatus
Match All

The article status.

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

    Example URIs for the articleStatus parameter are as follows:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

    • OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')

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


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

Show Source
  • ArticleStatusKeyBO
    Documentation for BO mode: ArticleStatusKeyBO
  • Title: Article Status

    The article status.

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

      Example URIs for the articleStatus parameter are as follows:

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

      • OR

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')

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

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'

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

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'

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

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')

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


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

Nested Schema : autosave
Match All
autosave record.
Show Source
Nested Schema : Autosave List
Type: array
Title: Autosave List
Read Only: true
Contains a collection of autosaves that exist for an article, if there are any.
Show Source
Nested Schema : basedLocale
Match All
The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.
Show Source
  • LocaleKeyBO
    Documentation for BO mode: LocaleKeyBO:

    Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

  • Title: Based Locale
    The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.
Nested Schema : checkedOutBy
Match All

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

  • checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : User's firstName.
  • checkedOutBy.lastName : User's lastName.
  • checkedOutBy.login : User's login.
Show Source
  • UserKeyBO
    Documentation for BO mode: UserKeyBO
  • Title: Checked Out By
    Read Only: true

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

    • checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
    • checkedOutBy.email : User's email.
    • checkedOutBy.firstName : User's firstName.
    • checkedOutBy.lastName : User's lastName.
    • checkedOutBy.login : User's login.
Nested Schema : contentType
Match All

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

  • contentType.recordId : The unique identifier of the ContentType object.
  • contentType.referenceKey : The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages. For Example to request articles for content type FAQ, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.
Show Source
  • ContentTypeKeyBO
    Documentation for BO mode: ContentTypeKeyBO
  • Title: Content Type

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

    • contentType.recordId : The unique identifier of the ContentType object.
    • contentType.referenceKey : The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages. For Example to request articles for content type FAQ, submit a call using the URI:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
    • contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.
Nested Schema : creator
Match All

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

  • creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : User's firstName.
  • creator.lastName : User's lastName.
  • creator.login : User's login.
Show Source
  • UserKeyBO
    Documentation for BO mode: UserKeyBO
  • Title: Creator
    Read Only: true

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

    • creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
    • creator.email : User's email.
    • creator.firstName : User's firstName.
    • creator.lastName : User's lastName.
    • creator.login : User's login.
Nested Schema : Content External Associations
Type: object
Title: Content External Associations
Read Only: true
Additional Properties Allowed
Show Source
This field will return external associations of content such as a reference to an SR this article was created from.
Nested Schema : lastModifier
Match All

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

  • lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : User's firstName.
  • lastModifier.lastName : User's lastName.
  • lastModifier.login : User's login.
Show Source
  • UserKeyBO
    Documentation for BO mode: UserKeyBO
  • Title: Last Modifier
    Read Only: true

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

    • lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
    • lastModifier.email : User's email.
    • lastModifier.firstName : User's firstName.
    • lastModifier.lastName : User's lastName.
    • lastModifier.login : User's login.
Nested Schema : latestContent
Match All
Latest BO for this document.
Show Source
  • ContentKeyBO
    Documentation for BO mode: ContentKeyBO
  • Title: Latest Content
    Read Only: true
    Latest BO for this document.
Nested Schema : locale
Match All

The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter:

  • locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'
Show Source
  • LocaleKeyBO
    Documentation for BO mode: LocaleKeyBO:

    Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

  • Title: Locale

    The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter:

    • locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'
Nested Schema : owner
Match All

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

  • owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : User's email.
  • owner.firstName : User's firstName.
  • owner.lastName : User's lastName.
  • owner.login : User's login.
Show Source
  • UserKeyBO
    Documentation for BO mode: UserKeyBO
  • Title: Owner
    Read Only: true

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

    • owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
    • owner.email : User's email.
    • owner.firstName : User's firstName.
    • owner.lastName : User's lastName.
    • owner.login : User's login.
Nested Schema : publishedContent
Match All
Published BO for this document.
Show Source
  • ContentKeyBO
    Documentation for BO mode: ContentKeyBO
  • Title: Published Content
    Read Only: true
    Published BO for this document.
Nested Schema : rating
Match All
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)
Show Source
  • DataFormBO
    Documentation for BO mode: DataFormBO
  • Title: Rating
    Read Only: true
    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)
Nested Schema : ratingsAggregate
Match All
The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.
Show Source
  • AggregateFormResultsBO
    Documentation for BO mode: AggregateFormResultsBO
  • Title: Ratings Aggregate
    Read Only: true
    The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.
Nested Schema : reviewInformation
Match All
Review information added after document marked as reviewed.
Show Source
Nested Schema : Schema Attributes
Type: array
Title: Schema Attributes
Read Only: true
Returns information about the schema of an article.
Show Source
Nested Schema : workflowStep
Match All
The step of the workflow in which the document version currently exist.
Show Source
  • WorkflowStepDataBO
    Documentation for BO mode: WorkflowStepDataBO
  • Title: Workflow Step
    Read Only: true
    The step of the workflow in which the document version currently exist.
Nested Schema : ContentKeyBO
Type: object
Documentation for BO mode: ContentKeyBO
Show Source
Nested Schema : All Translations
Type: array
Title: All Translations
Read Only: true
Contains a collection of translations available of an article, if there are any.
Show Source
Nested Schema : All Versions
Type: array
Title: All Versions
Read Only: true
Contains a collection of all versions of an article.
Show Source
Nested Schema : articleStatus
Match All

The article status.

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

    Example URIs for the articleStatus parameter are as follows:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

    • OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')

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


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

Show Source
  • ArticleStatusKeyBO
    Documentation for BO mode: ArticleStatusKeyBO
  • Title: Article Status

    The article status.

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

      Example URIs for the articleStatus parameter are as follows:

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

      • OR

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')

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

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'

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

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'

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

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')

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


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

Nested Schema : autosave
Match All
autosave record.
Show Source
Nested Schema : Autosave List
Type: array
Title: Autosave List
Read Only: true
Contains a collection of autosaves that exist for an article, if there are any.
Show Source
Nested Schema : Content External Associations
Type: object
Title: Content External Associations
Read Only: true
Additional Properties Allowed
Show Source
This field will return external associations of content such as a reference to an SR this article was created from.
Nested Schema : latestContent
Match All
Latest BO for this document.
Show Source
  • ContentKeyBO
    Documentation for BO mode: ContentKeyBO
  • Title: Latest Content
    Read Only: true
    Latest BO for this document.
Nested Schema : locale
Match All

The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter:

  • locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'
Show Source
  • LocaleKeyBO
    Documentation for BO mode: LocaleKeyBO:

    Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

  • Title: Locale

    The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter:

    • locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'
Nested Schema : publishedContent
Match All
Published BO for this document.
Show Source
  • ContentKeyBO
    Documentation for BO mode: ContentKeyBO
  • Title: Published Content
    Read Only: true
    Published BO for this document.
Nested Schema : rating
Match All
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)
Show Source
  • DataFormBO
    Documentation for BO mode: DataFormBO
  • Title: Rating
    Read Only: true
    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)
Nested Schema : ratingsAggregate
Match All
The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.
Show Source
  • AggregateFormResultsBO
    Documentation for BO mode: AggregateFormResultsBO
  • Title: Ratings Aggregate
    Read Only: true
    The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.
Nested Schema : reviewInformation
Match All
Review information added after document marked as reviewed.
Show Source
Nested Schema : Schema Attributes
Type: array
Title: Schema Attributes
Read Only: true
Returns information about the schema of an article.
Show Source
Nested Schema : ArticleStatusKeyBO
Type: object
Documentation for BO mode: ArticleStatusKeyBO
Show Source
  • Links
  • Title: Name
    Read Only: true
    Minimum Length: 1
    Maximum Length: 255
    The localized name of the ArticleStatus object. The name field can only be used for sorting.
  • Title: Record Id
    The unique identifier of the ArticleStatus object.
  • Title: Reference Key
    Maximum Length: 255
    The reference key for the ArticleStatus object. ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.
Nested Schema : ContentAutosaveKeyBO
Type: object
Show Source
Nested Schema : autosaveType
Match All
Show Source
  • Allowed Values: [ "ALL", "CREATED", "EDITED", "TRANSLATED" ]
Nested Schema : LocaleKeyBO
Type: object
Documentation for BO mode: LocaleKeyBO:

Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

Show Source
  • Links
  • Title: Locale Desc
    Read Only: true
    Maximum Length: 100
    The description about the language and country that the Locale object represents.
  • Title: Record Id
    The unique identifier of the Locale object.
Nested Schema : ContentExternalAssociationBO
Type: object
Documentation for ContentExternalAssociationBO
Show Source
Nested Schema : Properties
Type: object
Title: Properties
Additional Properties Allowed
Show Source
The properties of the external association
Nested Schema : DataFormBO
Type: object
Documentation for BO mode: DataFormBO
Show Source
Nested Schema : Questions
Type: array
Title: Questions
To Many Relationship to Question
Show Source
Nested Schema : user
Match All
Relationship to User
Show Source
Nested Schema : Views
Type: array
Title: Views
To Many Relationship to View
Show Source
Nested Schema : DataFormQuestionBO
Type: object
Documentation for BO mode: QuestionBO
Show Source
Nested Schema : Answers
Type: array
Title: Answers
To Many Relationship to Answer
Show Source
Nested Schema : dataForm
Match All
Relationship to Rating
Show Source
Nested Schema : DataFormAnswerBO
Type: object
Documentation for BO mode: AnswerBO
Show Source
Nested Schema : dataFormQuestion
Match All
Relationship to Question
Show Source
Nested Schema : DataFormQuestionKeyBO
Type: object
Documentation for BO mode: QuestionKeyBO
Show Source
Nested Schema : DataFormKeyBO
Type: object
Documentation for BO mode: DataFormKeyBO
Show Source
Nested Schema : UserKeyBO
Type: object
Documentation for BO mode: UserKeyBO
Show Source
Nested Schema : Content Type Privileges
Type: array
Title: Content Type Privileges
This field will return list of all contenttype privileges user have
Show Source
Nested Schema : Functional Privileges of user
Type: object
Title: Functional Privileges of user
Additional Properties Allowed
Show Source
This field will return list of all fucntional privileges user have
Nested Schema : CompositeContentTypeBO
Type: object
Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line
Show Source
Nested Schema : WorkflowSteps Composite BO
Type: array
Title: WorkflowSteps Composite BO
WorkflowSteps mapped to this content type and user privileges on that
Show Source
Nested Schema : contentTypeKeyBO
Match All
ContentBO object being created or updated
Show Source
  • ContentTypeKeyBO
    Documentation for BO mode: ContentTypeKeyBO
  • Title: Content Type Key BO
    ContentBO object being created or updated
Nested Schema : List Of Privilege
Type: array
Title: List Of Privilege
List of Privileges for the ContentType
Show Source
Nested Schema : CompositeWorkflowStepBO
Type: object
Composite of WorkflowStepBO with user privileges on this step.
Show Source
Nested Schema : List Of Privilege
Type: array
Title: List Of Privilege
List of Privileges for the WorkflowStep
Show Source
Nested Schema : WorkflowStepKeyBO
Match All
WorkflowStep object being fetched
Show Source
  • WorkflowStepKeyBO
    Documentation for BO mode: WorkflowStepKeyBO
  • Title: WorkflowStep Key BO
    WorkflowStep object being fetched
Nested Schema : WorkflowStepKeyBO
Type: object
Documentation for BO mode: WorkflowStepKeyBO
Show Source
Nested Schema : ContentTypeKeyBO
Type: object
Documentation for BO mode: ContentTypeKeyBO
Show Source
  • Title: Description
    Maximum Length: 255
    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
  • Title: Name
    Minimum Length: 1
    Maximum Length: 255
    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.
  • Title: Record Id
    Read Only: true
    The unique identifier of the ContentType object.
  • Title: Reference Key
    Minimum Length: 1
    Maximum Length: 255
    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.
  • Title: Stripe Cd
    Maximum Length: 30
    Lookup code that indicates the stripe code.
  • Title: Usage Code
    Read Only: true
    Maximum Length: 30
    Lookup code that indicates the product usage code.
  • workflow
Nested Schema : workflow
Match All
The workflow definition that the author can use while content authoring in a content type.
Show Source
  • WorkflowKeyBO
  • Title: Workflow
    The workflow definition that the author can use while content authoring in a content type.
Nested Schema : WorkflowKeyBO
Type: object
Show Source
Nested Schema : ViewKeyBO
Type: object
Documentation for BO mode: ViewKeyBO
Show Source
Nested Schema : AggregateFormResultsBO
Type: object
Documentation for BO mode: AggregateFormResultsBO
Show Source
  • Links
  • Questions
    Title: Questions
    To Many Relationship to AggregateQuestionResult
  • Title: Record Id
    Read Only: true
    The unique record ID of the AggregateFormResults object.
  • Title: Reference Key
    Maximum Length: 255
    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.
  • Title: Total Responses
    TotalResponses of the AggregateFormResults object
Nested Schema : Questions
Type: array
Title: Questions
To Many Relationship to AggregateQuestionResult
Show Source
Nested Schema : AggregateQuestionResultBO
Type: object
Documentation for BO mode: AggregateQuestionResultBO
Show Source
Nested Schema : Answers
Type: array
Title: Answers
To Many Relationship to AggregateAnswerResult
Show Source
Nested Schema : AggregateAnswerResultBO
Type: object
Documentation for BO mode: AggregateAnswerResultBO
Show Source
  • Title: Name
    Minimum Length: 1
    Maximum Length: 255
    Localized display name for the Answer
  • Title: Record Id
    Read Only: true
    The unique record ID of the AggregateAnswerResult object.
  • Title: Reference Key
    Maximum Length: 255
    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.
  • Title: Total Responses
    TotalResponses of the AggregateAnswerResult object
Nested Schema : ContentReviewInformationBO
Type: object
Content Review Information BO
Show Source
Nested Schema : lastUpdatedBy
Match All
The user or author who marked document reviewed.
Show Source
  • UserKeyBO
    Documentation for BO mode: UserKeyBO
  • Title: Last Updated By
    Read Only: true
    The user or author who marked document reviewed.
Nested Schema : state
Match All
review state for document.
Show Source
  • Allowed Values: [ "REVIEWED" ]
  • Title: State
    Read Only: true
    review state for document.
Nested Schema : SchemaAttributeBO
Type: object
Documentation for BO mode: SchemaAttributeBO
Show Source
Nested Schema : Children
Type: array
Title: Children
List of child nodes of the current element
Show Source
Nested Schema : Localized Attributes
Type: array
Title: Localized Attributes
List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
Show Source
Nested Schema : Schema Attribute User Group List
Type: array
Title: Schema Attribute User Group List
List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType
Show Source
Nested Schema : schemaAttrType
Match All
Enumerated type representing the type of attribute - i.e. text field, rich text area
Show Source
  • Allowed Values: [ "BOOLEAN", "COUNTER", "DATE", "DATETIME", "FILE", "FLOAT", "INTEGER", "LIST", "TEXT_AREA", "TEXT_FIELD", "TIME", "WYSIWYG_EDIT" ]
  • Title: Schema Attr Type
    Enumerated type representing the type of attribute - i.e. text field, rich text area
Nested Schema : wysiwygType
Match All
Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3
Show Source
  • Allowed Values: [ "BASIC", "FULL", "MEDIUM" ]
  • Title: Wysiwyg Type
    Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3
Nested Schema : LocalizedAttributesBO
Type: object
Show Source
Nested Schema : SchemaAttributeUserGroupBO
Type: object
Show Source
Nested Schema : UserGroupKeyBO
Type: object
Documentation for BO mode: UserGroupKeyBO
Show Source
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 255
    The localized name of the user group. The name field can only be used for sorting.
  • Title: Record Id
    The unique identifier from the TAG table that represent a userGroups resource
  • Title: Reference Key
    Maximum Length: 255
    The non localized name of the user group
  • Title: Stripe CD
    Read Only: true
    Maximum Length: 30
    Stripe for UserGroup
Nested Schema : WorkflowStepDataBO
Type: object
Documentation for BO mode: WorkflowStepDataBO
Show Source
Back to Top