Skip to content
Knowledge APIs
/
/
/
Get Article Edition Detai...

Get Article Edition Details

Request

Overview

  • This API retrieves the details of an article edition.
Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Path
articleIDstring, [ 7 .. 20 ] charactersrequired

The ID of the Article. Both numeric and alternate ID formats are supported.

Valid numerical IDs are 15-19 digits long.

Example:PROD-2996
Examples:
Readable Id
A readable Article ID.
PROD-2996
Numeric Id
A numerical Article ID.
202200000002996
publishViewIdstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

The ID of a Publish View Id.

A Publish View Id ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example:PROD-3020
Query
$langstring(languageCode)required

The language used for 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"
Example:$lang=en-US
workflowMilestonestring

For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.

  • 'Authoring' returns the most recent version of an Article checked-in by an author.
  • 'Staging' returns the updated version currently being processed in a workflow.
  • 'Publish' returns the most recently published version.

    • Enum:"authoring""staging""publish"
    Example:workflowMilestone=publish
    Headers
    Accept-Languagestringrequired

    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"
    Example:en-US
    GET
    /articles/{articleID}/editions/{publishViewId}
    curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/articles/PROD-2996/editions/PROD-3020?%24lang=en-US&workflowMilestone=publish' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

    Responses

    Success

    Bodyapplication/json
    idstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$

    ID of the edition.

    namestring, [ 1 .. 255 ] characters^[\w\W]+$

    Name of the edition.

    publishProfileobject(Publish Profile)

    This schema contains information about Profile.

    contentstring, [ 0 .. 2000000 ] characters^[\w\W]*$

    The raw content of the article. The maximum allowed Article content size is 2 MB.

    contentTextstring, [ 0 .. 2000000 ] characters^[\w\W]*$

    Plain text version of the content. The maximum allowed Article content size is 2 MB.

    accessTagsobject(accessTags)
    Response
    {
  "id": "PROD-2940",
  "name": "Internal",
  "publishProfile": {
    "id": "PROD-3020",
    "name": "Internal"
  },
  "content": "<h1>What is fair lending?</h1>\n\n<p>Fair lending prohibits lenders from considering your race, color, national origin, religion, sex, familial status, or disability when applying for residential mortgage loans. Fair lending guarantees the same lending opportunities to everyone.</p>\n\n\n\n\n\n<h1>If I am not from the United States, does the federal Fair Housing Act protect me?</h1>\n\n<p>Yes, whether you are a U.S. citizen, registered alien (a “green card” holder), or an undocumented resident of the U.S., you are protected by the federal Fair Housing Act.</p>\n\n<h1>How can the Fair Housing Act protect me when I purchase a home?</h1>\n\n<p>The federal Fair Housing Act makes it unlawful to discriminate in the sale, rental, or financing of homes because of race, color, national origin, religion, sex, familial status, or disability</p>\n\n<p></p>\n",
  "contentText": "What is fair lending?\r\n\n\n\r\nFair lending prohibits lenders from considering your race, color, national origin, religion, sex, familial status, or disability when applying for residential mortgage loans. Fair lending guarantees the same lending opportunities to everyone.\n\n\n\n\n\n\r\nIf I am not from the United States, does the federal Fair Housing Act protect me?\r\n\n\n\r\nYes, whether you are a U.S. citizen, registered alien (a “green card” holder), or an undocumented resident of the U.S., you are protected by the federal Fair Housing Act.\n\n\r\nHow can the Fair Housing Act protect me when I purchase a home?\r\n\n\n\r\nThe federal Fair Housing Act makes it unlawful to discriminate in the sale, rental, or financing of homes because of race, color, national origin, religion, sex, familial status, or disability\n\n\r\n\n",
  "accessTags": {
    "tagCategory": [ … ]
  },
  "link": {
    "rel": "self",
    "href": "/knowledge/portalmgr/v4/articles/PROD-2996/editions/PROD-3020?%24lang=en-US"
  }
}