# Get Article By ID with Editions

## Overview
  * This API allows a user to retrieve an article with all its editions.
  * If there are no editions for the article, the response will contain the base content of the article.

Endpoint: GET /articles/{articleID}/witheditions
Security: oAuthClient

## Header parameters:

  - `Accept-Language` (string, required)
    The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
    Enum: "en-US", "es-ES", "fr-FR", "it-IT", "de-DE", "nl-NL", "pt-BR", "pt-PT", "da-DK", "ru-RU", "fr-CA", "zh-CN", "ja-JP", "ko-KR", "sv-SE"

  - `x-ext-integration-id` (string)
    The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

## Path parameters:

  - `articleID` (string, required)
    The ID of the Article.An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.
    Example: "PROD-2996"

## Query parameters:

  - `$lang` (string, required)
    The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
    Enum: "en-US", "fr-FR", "en-GB", "es-ES", "it-IT", "nl-NL", "da-DA", "sv-SE", "pt-PT", "fi-FI", "no-NB", "no-NN", "ja-JA", "de-DE", "pt-BR", "zh-CN", "zh-TW", "ko-KO", "ru-RU", "el-EL", "tr-TR", "pl-PL", "cs-CS", "sk-SK", "hu-HU", "sr-SR", "ar-SA", "hr-HR", "ro-RO", "th-TH", "de-AT", "vi-VN", "id-ID", "ms-MY", "fil-PH", "fr-CA", "hi-IN", "uk-UA", "bg-BG", "sl-SI", "xx-XX"

## Response 200 fields (application/json):

  - `id` (string, required)
    The ID of the Article.An Article ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

  - `additionalInfo` (string)
    Additional information about the Article. Max 1 KB.

  - `articleMacro` (string)
    The name of the macro associated with this Article.

  - `articleType` (object)
    The type of the Article and its attributes.

  - `articleType.articleCategoryId` (integer)
    Specifies the article category ID.

  - `articleType.typeName` (string)
    Indicates the article type name.

  - `articleType.useStructuredAuthoring` (boolean)
    Indicates whether structured authoring is enabled for this article type, requiring content to be created using predefined fields

  - `articleType.articleTypeId` (string)
    The ID of the Article Type.
    Example: "932100000002020"

  - `articleKeywords` (string)
    A comma-separated list of keywords associated with this Article. 1 KB max size limit.

  - `articleSummary` (string)
    A brief summary of the Article, provided as metadata. 1 KB max size limit.

  - `attachments` (array)
    The attachments of the Article.

  - `attachments.id` (string)
    The ID of the attachment.
    Example: "PROD-1001"

  - `attachments.name` (string)
    The name of the attachment.

  - `attachments.size` (integer)
    The size of the attachment in bytes. The maximum size is limited to 25MB.

  - `attachments.type` (string)
    The type of attachment.
    Enum: "INTERNAL", "EXTERNAL"

  - `attachments.link` (object)
    Defines the relationship between this resource and another object.

  - `attachments.link.rel` (string)
    Defines the relationship between a linked resource and the current object.For example: self, prev, next or an object name such as 'user', 'folder' etc.

  - `attachments.link.href` (string)
    The URL that specifies the link's destination.

  - `availabilityDate` (string)
    The date on which the Article version is available.

  - `availableEditions` (array)
    The editions of this Article that are available to the user.

  - `availableEditions.id` (string)
    The ID of the article edition.An edition ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits.

  - `availableEditions.name` (string)
    The alphanumeric name of the edition.

  - `availableEditions.isContentEdition` (boolean)
    The presence of this element indicates that this edition is the one corresponding to the returned content.
This can only be true for at most one  element in the list of editions.
This parameter must only be returned if article content is returned as well.
The only allowed value is true. The absence of this parameter in the response indicates false.

  - `availableEditions.publishProfile` (object)
    The publish view associated with this edition.

  - `availableEditions.publishProfile.id` (string, required)
    The ID of the Publish Profile.An Publish Profile ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

  - `availableEditions.publishProfile.name` (string, required)
    The name of the profile.

  - `averageRating` (number)
    The average rating of the Article.

  - `content` (string)
    The Article content. The maximum allowed Article content size is 5 MB.

  - `contentText` (string)
    The plaintext version of the Article content, which does not have the HTML tags and rich formatting present in content. The maximum allowed Article content size is 5 MB.

  - `createdBy` (object, required)

  - `createdBy.id` (string)
    The ID of the user that created this resource.

  - `createdBy.userName` (string)
    The resource creator's username.

  - `createdBy.firstName` (string)
    The resource creator's first name.

  - `createdBy.middleName` (string)
    The resource creator's middle name.

  - `createdBy.lastName` (string)
    The resource creator's last name.

  - `modifiedBy` (object)

  - `modifiedBy.id` (string)
    The ID of the user that modified this resource.

  - `modifiedBy.userName` (string)
    The resource modifier's username.

  - `modifiedBy.firstName` (string)
    The resource modifier's first name.

  - `modifiedBy.middleName` (string)
    The resource modifier's middle name.

  - `modifiedBy.lastName` (string)
    The resource modifier's last name.

  - `ownedBy` (object)

  - `ownedBy.id` (string)
    The ID of the user that owns this resource.

  - `ownedBy.userName` (string)
    The resource owner's username.

  - `ownedBy.firstName` (string)
    The resource owner's first name.

  - `ownedBy.middleName` (string)
    The resource owner's middle name.

  - `ownedBy.lastName` (string)
    The resource owner's last name.

  - `createdDate` (string)
    The date on which the Article was created. The timezone of the date will be in UTC.

  - `customAttributes` (array)
    A list of custom attributes.

  - `customAttributes.name` (string)
    The custom attribute's name.

  - `customAttributes.value` (array)
    The custom attribute's values.

  - `customAttributes.type` (string)
    The custom attribute's type.
    Enum: "STRING", "INTEGER", "BOOLEAN", "DATETIME"

  - `departmentID` (string)
    ID of the Article's department.

  - `description` (string)
    A description of the Article. The maximum allowed Article description size is 1 KB.

  - `expirationDate` (string)
    Date of Article expiration if Article expires otherwise empty.

  - `imageURL` (string)
    The URL of an image to be associated with the Article.

  - `includeInGenAI` (boolean)
    Indicates whether the Article is included for Generative AI.

  - `isSubscribed` (boolean)
    Indicates whether the Article is subscribed for notifications.

  - `modifiedDate` (string)
    The date on which the Article was last modified. The timezone of the date will be in UTC.

  - `languageCode` (string)
    Language code of the resource's language.
    Enum: "en-US", "fr-FR", "en-GB", "es-ES", "it-IT", "nl-NL", "da-DA", "sv-SE", "pt-PT", "fi-FI", "no-NB", "no-NN", "ja-JA", "de-DE", "pt-BR", "zh-CN", "zh-TW", "ko-KO", "ru-RU", "el-EL", "tr-TR", "pl-PL", "cs-CS", "sk-SK", "hu-HU", "sr-SR", "ar-SA", "hr-HR", "ro-RO", "th-TH"

  - `name` (string, required)
    The name of the Article.

  - `structuredAuthoringFields` (object)

  - `structuredAuthoringFields.confidenceLevel` (object)

  - `structuredAuthoringFields.confidenceLevel.value` (string)
    A string that indicates the value.

  - `structuredAuthoringFields.confidenceLevel.displayValue` (string)
    Localized string of the value element.

  - `structuredAuthoringFields.issue` (string)
    Describes the problem, symptom, or question the article addresses.

  - `structuredAuthoringFields.environment` (string)
    Specifies the relevant product(s), category, or business process tied to the issue.

  - `structuredAuthoringFields.cause` (string)
    Identifies the underlying cause of the issue.

  - `articleState` (string)
    The Article's state.

  - `timesRated` (integer)
    The number of times that this Article has been rated.

  - `relatedQuestions` (object)
    Related questions for the article.

  - `relatedQuestions.relatedQuestion` (array)
    An array of related questions.

  - `relatedQuestions.count` (integer)
    The total count of related questions for the article.

  - `versionId` (string)
    The ID of this version of the Article.

  - `workflow` (object)
    The Article's workflow.

  - `workflow.stages` (array)
    An array of stages for the workflow.

  - `workflow.stages.name` (string)
    The name of the stage.

  - `workflow.stages.milestone` (object)
    A resource's workflow milestone.

  - `workflow.stages.milestone.name` (object)
    The identifiers of the milestone.

  - `workflow.stages.milestone.name.value` (string)
    The name of the milestone.

  - `workflow.stages.milestone.name.displayValue` (string)
    The readable name of the milestone.

  - `personalization` (object)
    Personalization allows the filtering of search results and controls the access to articles and article editions.

  - `personalization.accessTags` (object)

  - `personalization.accessTags.tagCategory` (array)
    An array of tag categories. Note that the total number of tag categories cannot exceed 20.

  - `personalization.accessTags.tagCategory.name` (string)
    The name of the tag category.

  - `personalization.accessTags.tagCategory.id` (string)
    The ID of the tag category. A tag category ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits.

  - `personalization.accessTags.tagCategory.tags` (object)

  - `personalization.accessTags.tagCategory.tags.tag` (array)
    An array of tags.

  - `personalization.accessTags.tagCategory.tags.tag.name` (string)
    Example: "Blue"

  - `personalization.accessTags.tagCategory.tags.tag.id` (string)
    Example: "PROD-13206"

  - `personalization.accessTags.tagCategory.tagGroups` (object)

  - `personalization.accessTags.tagCategory.tagGroups.tagGroup` (array)
    An array of tag groups.

  - `personalization.filters` (object)

  - `personalization.publishViews` (object)

  - `personalization.publishViews.publishView` (array)
    Publish views allow authors to tailor the contents of an article to different audiences by controlling visibility of certain article content using tags.The total number of publish views is limited to 20.

  - `personalization.publishViews.publishView.name` (string)
    name of the publish view

  - `personalization.publishViews.publishView.tagCategories` (array)
    Tag categories are comprised of both tags and tag groups.Note that the total number of tag and tag groups cannot exceed 20.

  - `personalization.publishViews.publishView.tagCategories.tagCategory` (array)

## Response 400 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 401 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 403 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 404 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 406 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 500 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.