Article Version Object

Field Overview

NameTypeExampleNotes
project_idString559f118932131c6576ccb5be*Required. ID of the knowledge base this belongs to.
statusStringactive*Required. Can be one of the following: 'active', 'deleted'.
article_idString559f118932131c6576ccb5be*Required. ID of the article object that this belongs to.
nameStringArticle Version*Required. Name of the article verion.
article_versionFloated Integer1.02Required*. Version number.
readyBooleanTRUEVersion is marked as ready to review by person with appropriate permissions.
current_versionArrayArray (
  [en] => Array (
    [title] => Article Version,
    [text] => Version body
  )
)
Contains both the title and body content of the article version.
version_reader_rolesArray
Array (
 559f118932131c6576ccb5be,
 559f118932131c6576ccb5be
)
Array of reader group IDs that should be able to see this version before it is published as live to everyone.

Example Response

stdClass Object
(
    [valid] => 1
    [data] => stdClass Object
        (
            [id] => 5849a5058a161cee05e45c7c
            [type] => articleversion
            [ready] => 
            [project_id] => 57cdca2d8a161c63646bd227
            [article_id] => 57cdca2e8a161ca3658b456a
            [name] => Set Up Your Knowledge Base
            [languages] => Array (
                [0] => en
            )
            [current_version] => Array (
                [en] => Array (
                     [title] => Example Article Version
                     [text] => Example version body text.
                )
            )
            [version_number] => 1.01
            [modified_author] => 
            [date_created] => 12/08/2016 1:23 pm EST
            [date_modified] => 
            [date_published] => 
            [date_deleted] => 
            [status] => active
            [auto_save] => 
            [version_reader_roles] => 
        )

)