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.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
The ID of the Article.An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Query Parameters
The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
Value in
- "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"
Header Parameters
The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "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"
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.
^[\w\W]+$length <= 40Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledge/portalmgr/v4/articles/PROD-2996/witheditions?%24lang=en-US" \ -H "Accept-Language: en-US" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176"{ "id": "PROD-2996", "additionalInfo": "Can be shared to public.", "articleType": { "articleCategoryId": 0, "typeName": "General", "useStructuredAuthoring": false, "articleTypeId": "100100000002020" }, "articleKeywords": "Fair lending, Fair Housing Act, Discrimination protection, Residential mortgage loans, Equal opportunity housing", "articleSummary": "Fair lending ensures that lenders do not discriminate based on race, color, national origin, religion, sex, familial status, or disability when applying for residential mortgage loans. The federal Fair Housing Act protects individuals' fair lending rights, enforced by the Office of Fair Housing and Equal Opportunity, along with state and local agencies. This law applies to U.S. citizens, green card holders, and undocumented residents, ensuring equal opportunities in home sales, rentals, and financing.", "attachments": [ { "id": "PROD-1000", "name": "eightbank.png", "size": 45152, "type": "INTERNAL", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/articles/attachments/PROD-1000" } } ], "availabilityDate": "2025-01-28T19:53:58.000Z", "availableEditions": [ { "id": "PROD-2940", "publishProfile": { "id": "PROD-3020", "name": "Internal" }, "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/articles/PROD-2996/editions/PROD-3020?%24lang=en-US" } }, { "id": "PROD-2941", "publishProfile": { "id": "PROD-3203", "name": "Customers" }, "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/articles/PROD-2996/editions/PROD-3203?%24lang=en-US" } } ], "averageRating": 0, "createdBy": { "id": "1013", "userName": "jdoe", "firstName": "John", "middleName": "", "lastName": "Doe" }, "modifiedBy": { "id": "1013", "userName": "jdoe", "firstName": "John", "middleName": "", "lastName": "Doe" }, "ownedBy": { "id": "1013", "userName": "jdoe", "firstName": "John", "middleName": "", "lastName": "Doe" }, "createdDate": "2022-06-30T07:54:55.000Z", "customAttributes": [], "departmentID": "1001", "description": "Common questions and answers regarding Fair Lending.", "expirationDate": "2031-01-02T18:56:15.000Z", "imageURL": "https://hd.egain.com/images/km-for-dummies-24.jpg", "includeInGenAI": true, "isSubscribed": false, "modifiedDate": "2025-01-28T19:53:58.000Z", "languageCode": "en-US", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/articles/PROD-2996/witheditions?%24lang=en-US" }, "name": "Fair Lending FAQs", "articleState": "P", "timesRated": 0, "versionId": "PROD-2939", "workflow": { "stages": [ { "name": "publish", "milestone": { "name": { "value": "publish", "displayValue": "Published" } } } ] }, "personalization": { "filters": { "tagCategory": [ { "name": "Banking", "id": "PROD-1014", "tags": { "tag": [ { "name": "Fair Lending", "id": "PROD-5381" }, { "name": "Banking Industry Regulations", "id": "PROD-2930" } ] }, "tagGroups": { "tagGroup": [ { "name": "Banking", "id": "PROD-2745" } ] } } ] } }}Get Article by ID GET
## Overview * The Get Article by ID API allows a user or client application to retrieve an Article using its ID. * It requires a Portal ID, which a user or client application can retrieve through the Administrative Console or by calling Get All Portals API. * Additional Article attributes and contextual views can be specified in the query parameters. * This API returns structured authoring attributes of Issue, Environment, Cause and Confidence Level when the following conditions are met: * The "Allow Structured Authoring" setting is enabled at the partition/department level through the Administrative Console. * The "Use Structured Authoring" flag is set on the article type. ## Prerequisites * Agents without a user profile and customers in a portal without a default user profile only have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain publish views without any associated tags. * Agents with a user profile and customers in a portal with a default user profile have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain publish views without any associated tags. * Contain access tags that are also in the assigned user profiles. * Contain publish views with associated tags that are also in the assigned user profiles. * Agents with the following assigned actions can view updates to articles currently being processed in workflows: * View Author Portal – Allows agents to view updates to articles at any stage in a workflow. * View Staging Portal – Allows agents to view updates to articles in the Staging stage or a subsequent stage in a workflow.
Get Article Edition Details GET
## Overview * This API retrieves the details of an article edition.

