npm package: @ngreenberg/egain-portalmgr-sdk
Description: OpenAPI client for @ngreenberg/portalmgr-sdk
Author: OpenAPI-Generator Contributors
Latest version: 1.0.6

## @ngreenberg/portalmgr-sdk

Docs viewer: https://unpkg.com/@ngreenberg/portalmgr-sdk@latest/docs/index.html

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @ngreenberg/portalmgr-sdk@1.0.0 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints


<!-- Begin ArticleApi.md -->

# ArticleApi

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addAsReference**](#addasreference) | **PUT** /portals/{portalID}/articles/{articleID}/addasreference | Add as Reference|
|[**addToReply**](#addtoreply) | **PUT** /portals/{portalID}/articles/{articleID}/addtoreply | Add Article to Reply|
|[**complyArticle**](#complyarticle) | **PUT** /portals/{portalID}/articles/{articleID}/comply | Comply With an Article|
|[**getAcknowledgedComplianceArticles**](#getacknowledgedcompliancearticles) | **GET** /portals/{portalID}/articles/compliance/acknowledged | Get Acknowledged Article Compliances|
|[**getAnnouncementArticles**](#getannouncementarticles) | **GET** /portals/{portalID}/articles/announcements | Get Announcement Articles|
|[**getArticleById**](#getarticlebyid) | **GET** /portals/{portalID}/articles/{articleID} | Get Article by ID|
|[**getArticlePermissionsById**](#getarticlepermissionsbyid) | **GET** /portals/{portalID}/articles/{articleID}/permissions | Get Article Permissions By ID|
|[**getArticlePersonalization**](#getarticlepersonalization) | **GET** /portals/{portalID}/articles/{articleID}/personalization | Get Article Personalization Details|
|[**getArticleRatings**](#getarticleratings) | **GET** /portals/{portalID}/articles/{articleID}/ratings | Get Article Ratings|
|[**getArticlesInTopic**](#getarticlesintopic) | **GET** /portals/{portalID}/articles | Get Articles in Topic|
|[**getAttachmentById**](#getattachmentbyid) | **GET** /portals/{portalID}/articles/attachments/{attachmentID} | Get Article Attachment|
|[**getMySubscription**](#getmysubscription) | **GET** /portals/{portalID}/articles/subscribed | My Subscription|
|[**getPendingComplianceArticles**](#getpendingcompliancearticles) | **GET** /portals/{portalID}/articles/compliance/pending | Get Pending Article Compliances|
|[**getRelatedArticles**](#getrelatedarticles) | **GET** /portals/{portalID}/articles/{articleID}/related | Get Related Articles|
|[**rateArticle**](#ratearticle) | **PUT** /portals/{portalID}/articles/{articleID}/ratings | Rate an Article|
|[**subscribeArticle**](#subscribearticle) | **PUT** /portals/{portalID}/articles/{articleID}/subscribe | Subscribe to an Article|
|[**unsubscribeArticle**](#unsubscribearticle) | **PUT** /portals/{portalID}/articles/{articleID}/unsubscribe | Unsubscribe to an Article|

# **addAsReference**
> addAsReference(articleActivityLink)

## Overview The Add as Reference API captures events for articles that are referenced by agents replying inside of a digital channel activity.  Note: Either the <code>x-ext-activity-id</code> or<br><code>x-ext-integration-id</code> and <code>x-ext-interaction-id</code> header must be provided.  ## Permissions   * Only Agents can invoke this API. 

### Example

```typescript
import {
    ArticleApi,
    Configuration,
    ArticleActivityLink
} from '@ngreenberg/portalmgr-sdk';

const configuration = new Configuration();
const apiInstance = new ArticleApi(configuration);

let acceptLanguage: '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 Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). (default to undefined)
let accept: 'application/json'; //The content type accepted by the client. (default to 'application/json')
let portalID: string; //The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. (default to undefined)
let articleID: string; //The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. (default to undefined)
let articleActivityLink: ArticleActivityLink; //
let xEgainActivityId: string; //A unique numeric interaction identifier from eGain. (optional) (default to undefined)
let xExtIntegrationId: string; //The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* (optional) (default to undefined)
let xExtInteractionId: string; //A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* (optional) (default to undefined)

const { status, data } = await apiInstance.addAsReference(
    acceptLanguage,
    accept,
    portalID,
    articleID,
    articleActivityLink,
    xEgainActivityId,
    xExtIntegrationId,
    xExtInteractionId
);
```

### Parameters
|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **articleActivityLink** | **ArticleActivityLink**|  | |
| **acceptLanguage** | [**&#39;en-US&#39; | &#39;es-ES&#39; | &#39;fr-FR&#39; | &#39;it-IT&#39; | &#39;de-DE&#39; | &#39;nl-NL&#39; | &#39;pt-BR&#39; | &#39;pt-PT&#39; | &#39;da-DK&#39; | &#39;ru-RU&#39; | &#39;fr-CA&#39; | &#39;zh-CN&#39; | &#39;ja-JP&#39; | &#39;ko-KR&#39; | &#39;sv-SE&#39;**]**Array<&#39;en-US&#39; &#124; &#39;es-ES&#39; &#124; &#39;fr-FR&#39; &#124; &#39;it-IT&#39; &#124; &#39;de-DE&#39; &#124; &#39;nl-NL&#39; &#124; &#39;pt-BR&#39; &#124; &#39;pt-PT&#39; &#124; &#39;da-DK&#39; &#124; &#39;ru-RU&#39; &#124; &#39;fr-CA&#39; &#124; &#39;zh-CN&#39; &#124; &#39;ja-JP&#39; &#124; &#39;ko-KR&#39; &#124; &#39;sv-SE&#39;>** | The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). | defaults to undefined|
| **accept** | [**&#39;application/json&#39;**]**Array<&#39;application/json&#39;>** | The content type accepted by the client. | defaults to 'application/json'|
| **portalID** | [**string**] | The ID of the portal being accessed.&lt;br&gt;&lt;br&gt;A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. | defaults to undefined|
| **articleID** | [**string**] | The ID of the Article.&lt;br&gt;&lt;br&gt;An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. | defaults to undefined|
| **xEgainActivityId** | [**string**] | A unique numeric interaction identifier from eGain. | (optional) defaults to undefined|
| **xExtIntegrationId** | [**string**] | The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* | (optional) defaults to undefined|
| **xExtInteractionId** | [**string**] | A unique interaction identifier from other CRM applications.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* | (optional) defaults to undefined|


### Return type

void (empty response body)

### Authorization

[oAuthUser](../README.md#oAuthUser)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | No Content |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Not Found |  -  |
|**406** | Not acceptable |  -  |
|**415** | Incorrect Content Type Header |  -  |
|**500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **addToReply**
> addToReply(articleActivityLink)

## Overview The Add Article to Reply API captures events for articles used in a reply for a digital channel activity.  Note:  Either the <code>x-ext-activity-id</code> or<br><code>x-ext-integration-id</code> and <code>x-ext-interaction-id</code> header must be provided.  ## Permissions   * Only Agents can invoke this API. 

### Example

```typescript
import {
    ArticleApi,
    Configuration,
    ArticleActivityLink
} from '@ngreenberg/portalmgr-sdk';

const configuration = new Configuration();
const apiInstance = new ArticleApi(configuration);

let acceptLanguage: '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 Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). (default to undefined)
let accept: 'application/json'; //The content type accepted by the client. (default to 'application/json')
let portalID: string; //The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. (default to undefined)
let articleID: string; //The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. (default to undefined)
let articleActivityLink: ArticleActivityLink; //
let xEgainActivityId: string; //A unique numeric interaction identifier from eGain. (optional) (default to undefined)
let xExtIntegrationId: string; //The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* (optional) (default to undefined)
let xExtInteractionId: string; //A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* (optional) (default to undefined)

const { status, data } = await apiInstance.addToReply(
    acceptLanguage,
    accept,
    portalID,
    articleID,
    articleActivityLink,
    xEgainActivityId,
    xExtIntegrationId,
    xExtInteractionId
);
```

### Parameters
|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **articleActivityLink** | **ArticleActivityLink**|  | |
| **acceptLanguage** | [**&#39;en-US&#39; | &#39;es-ES&#39; | &#39;fr-FR&#39; | &#39;it-IT&#39; | &#39;de-DE&#39; | &#39;nl-NL&#39; | &#39;pt-BR&#39; | &#39;pt-PT&#39; | &#39;da-DK&#39; | &#39;ru-RU&#39; | &#39;fr-CA&#39; | &#39;zh-CN&#39; | &#39;ja-JP&#39; | &#39;ko-KR&#39; | &#39;sv-SE&#39;**]**Array<&#39;en-US&#39; &#124; &#39;es-ES&#39; &#124; &#39;fr-FR&#39; &#124; &#39;it-IT&#39; &#124; &#39;de-DE&#39; &#124; &#39;nl-NL&#39; &#124; &#39;pt-BR&#39; &#124; &#39;pt-PT&#39; &#124; &#39;da-DK&#39; &#124; &#39;ru-RU&#39; &#124; &#39;fr-CA&#39; &#124; &#39;zh-CN&#39; &#124; &#39;ja-JP&#39; &#124; &#39;ko-KR&#39; &#124; &#39;sv-SE&#39;>** | The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). | defaults to undefined|
| **accept** | [**&#39;application/json&#39;**]**Array<&#39;application/json&#39;>** | The content type accepted by the client. | defaults to 'application/json'|
| **portalID** | [**string**] | The ID of the portal being accessed.&lt;br&gt;&lt;br&gt;A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. | defaults to undefined|
| **articleID** | [**string**] | The ID of the Article.&lt;br&gt;&lt;br&gt;An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. | defaults to undefined|
| **xEgainActivityId** | [**string**] | A unique numeric interaction identifier from eGain. | (optional) defaults to undefined|
| **xExtIntegrationId** | [**string**] | The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* | (optional) defaults to undefined|
| **xExtInteractionId** | [**string**] | A unique interaction identifier from other CRM applications.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* | (optional) defaults to undefined|


### Return type

void (empty response body)

### Authorization

[oAuthUser](../README.md#oAuthUser)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | No Content |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Not Found |  -  |
|**406** | Not acceptable |  -  |
|**415** | Incorrect Content Type Header |  -  |
|**500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **complyArticle**
> complyArticle()

## Overview The Comply with an Article API allows the user to comply with an article by passing the Article\'s ID, which marks it as read by the user.              ## Prerequisites   * The user must be an agent and:     * Be available in the portal.     * Be available for the current user profile.     * Have the Article\'s compliance policy enabled.   * If the Article has Access Tags, then it must be available for the agent\'s current user profile.   * If the Article has Publish Views, then at least one edition of the Article must be available for the agent\'s current user profile. 

### Example

```typescript
import {
    ArticleApi,
    Configuration
} from '@ngreenberg/portalmgr-sdk';

const configuration = new Configuration();
const apiInstance = new ArticleApi(configuration);

let acceptLanguage: '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 Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). (default to undefined)
let portalID: string; //The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. (default to undefined)
let articleID: string; //The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. (default to undefined)
let xEgainActivityId: string; //A unique numeric interaction identifier from eGain. (optional) (default to undefined)
let xExtIntegrationId: string; //The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* (optional) (default to undefined)
let xExtInteractionId: string; //A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* (optional) (default to undefined)

const { status, data } = await apiInstance.complyArticle(
    acceptLanguage,
    portalID,
    articleID,
    xEgainActivityId,
    xExtIntegrationId,
    xExtInteractionId
);
```

### Parameters
|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptLanguage** | [**&#39;en-US&#39; | &#39;es-ES&#39; | &#39;fr-FR&#39; | &#39;it-IT&#39; | &#39;de-DE&#39; | &#39;nl-NL&#39; | &#39;pt-BR&#39; | &#39;pt-PT&#39; | &#39;da-DK&#39; | &#39;ru-RU&#39; | &#39;fr-CA&#39; | &#39;zh-CN&#39; | &#39;ja-JP&#39; | &#39;ko-KR&#39; | &#39;sv-SE&#39;**]**Array<&#39;en-US&#39; &#124; &#39;es-ES&#39; &#124; &#39;fr-FR&#39; &#124; &#39;it-IT&#39; &#124; &#39;de-DE&#39; &#124; &#39;nl-NL&#39; &#124; &#39;pt-BR&#39; &#124; &#39;pt-PT&#39; &#124; &#39;da-DK&#39; &#124; &#39;ru-RU&#39; &#124; &#39;fr-CA&#39; &#124; &#39;zh-CN&#39; &#124; &#39;ja-JP&#39; &#124; &#39;ko-KR&#39; &#124; &#39;sv-SE&#39;>** | The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). | defaults to undefined|
| **portalID** | [**string**] | The ID of the portal being accessed.&lt;br&gt;&lt;br&gt;A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. | defaults to undefined|
| **articleID** | [**string**] | The ID of the Article.&lt;br&gt;&lt;br&gt;An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. | defaults to undefined|
| **xEgainActivityId** | [**string**] | A unique numeric interaction identifier from eGain. | (optional) defaults to undefined|
| **xExtIntegrationId** | [**string**] | The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* | (optional) defaults to undefined|
| **xExtInteractionId** | [**string**] | A unique interaction identifier from other CRM applications.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* | (optional) defaults to undefined|


### Return type

void (empty response body)

### Authorization

[oAuthUser](../README.md#oAuthUser)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | No Content |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Not Found |  -  |
|**406** | Not acceptable |  -  |
|**500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getAcknowledgedComplianceArticles**
> ComplianceArticleResults getAcknowledgedComplianceArticles()

## Overview The Get Acknowledged Article Compliances API retrieves all compliance-enabled articles in a portal that have been read by the current user in the last 60 days. Results are sorted in descending order of the acknowledgement date.  ## Prerequisites * The Article compliances that are returned must be:     * Available for the current user profile.     * Displayable. An article is displayable when the \"Include in browse on portals\" property is enabled for the article.     * Acknowledged within the last 60 days.     * Only the latest version of a republished compliance article will be shown.     * Results will be sorted in descending order of acknowledgment date. 

### Example

```typescript
import {
    ArticleApi,
    Configuration
} from '@ngreenberg/portalmgr-sdk';

const configuration = new Configuration();
const apiInstance = new ArticleApi(configuration);

let acceptLanguage: '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 Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). (default to undefined)
let portalID: string; //The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. (default to undefined)
let xEgainActivityId: string; //A unique numeric interaction identifier from eGain. (optional) (default to undefined)
let xExtIntegrationId: string; //The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* (optional) (default to undefined)
let xExtInteractionId: string; //A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* (optional) (default to undefined)
let complianceArticleResultAdditionalAttributes: Array<'averageRating' | 'articleSummary' | 'customAttributes' | 'description' | 'imageURL' | 'isSubscribed' | 'timesRated' | 'topicBreadcrumb' | 'ownedBy' | 'ownedBy.userName' | 'workflow' | 'compliance' | 'personalization' | 'all'>; //The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing \'all\' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | updateSummary | Summary of the Article update. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.  (optional) (default to undefined)
let $lang: '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' | 'xx-XX'; //The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>lang</code> is not passed, then the portal\'s default language is used.</li> (optional) (default to undefined)
let $pagenum: number; //Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize. (optional) (default to 1)
let $pagesize: number; //Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum. (optional) (default to 10)

const { status, data } = await apiInstance.getAcknowledgedComplianceArticles(
    acceptLanguage,
    portalID,
    xEgainActivityId,
    xExtIntegrationId,
    xExtInteractionId,
    complianceArticleResultAdditionalAttributes,
    $lang,
    $pagenum,
    $pagesize
);
```

### Parameters
|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptLanguage** | [**&#39;en-US&#39; | &#39;es-ES&#39; | &#39;fr-FR&#39; | &#39;it-IT&#39; | &#39;de-DE&#39; | &#39;nl-NL&#39; | &#39;pt-BR&#39; | &#39;pt-PT&#39; | &#39;da-DK&#39; | &#39;ru-RU&#39; | &#39;fr-CA&#39; | &#39;zh-CN&#39; | &#39;ja-JP&#39; | &#39;ko-KR&#39; | &#39;sv-SE&#39;**]**Array<&#39;en-US&#39; &#124; &#39;es-ES&#39; &#124; &#39;fr-FR&#39; &#124; &#39;it-IT&#39; &#124; &#39;de-DE&#39; &#124; &#39;nl-NL&#39; &#124; &#39;pt-BR&#39; &#124; &#39;pt-PT&#39; &#124; &#39;da-DK&#39; &#124; &#39;ru-RU&#39; &#124; &#39;fr-CA&#39; &#124; &#39;zh-CN&#39; &#124; &#39;ja-JP&#39; &#124; &#39;ko-KR&#39; &#124; &#39;sv-SE&#39;>** | The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). | defaults to undefined|
| **portalID** | [**string**] | The ID of the portal being accessed.&lt;br&gt;&lt;br&gt;A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. | defaults to undefined|
| **xEgainActivityId** | [**string**] | A unique numeric interaction identifier from eGain. | (optional) defaults to undefined|
| **xExtIntegrationId** | [**string**] | The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* | (optional) defaults to undefined|
| **xExtInteractionId** | [**string**] | A unique interaction identifier from other CRM applications.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* | (optional) defaults to undefined|
| **complianceArticleResultAdditionalAttributes** | **Array<&#39;averageRating&#39; &#124; &#39;articleSummary&#39; &#124; &#39;customAttributes&#39; &#124; &#39;description&#39; &#124; &#39;imageURL&#39; &#124; &#39;isSubscribed&#39; &#124; &#39;timesRated&#39; &#124; &#39;topicBreadcrumb&#39; &#124; &#39;ownedBy&#39; &#124; &#39;ownedBy.userName&#39; &#124; &#39;workflow&#39; &#124; &#39;compliance&#39; &#124; &#39;personalization&#39; &#124; &#39;all&#39;>** | The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing \&#39;all\&#39; will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | updateSummary | Summary of the Article update. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.&lt;br&gt;False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.  | (optional) defaults to undefined|
| **$lang** | [**&#39;en-US&#39; | &#39;fr-FR&#39; | &#39;en-GB&#39; | &#39;es-ES&#39; | &#39;it-IT&#39; | &#39;nl-NL&#39; | &#39;da-DA&#39; | &#39;sv-SE&#39; | &#39;pt-PT&#39; | &#39;fi-FI&#39; | &#39;no-NB&#39; | &#39;no-NN&#39; | &#39;ja-JA&#39; | &#39;de-DE&#39; | &#39;pt-BR&#39; | &#39;zh-CN&#39; | &#39;zh-TW&#39; | &#39;ko-KO&#39; | &#39;ru-RU&#39; | &#39;el-EL&#39; | &#39;tr-TR&#39; | &#39;pl-PL&#39; | &#39;cs-CS&#39; | &#39;sk-SK&#39; | &#39;hu-HU&#39; | &#39;sr-SR&#39; | &#39;ar-SA&#39; | &#39;hr-HR&#39; | &#39;ro-RO&#39; | &#39;th-TH&#39; | &#39;xx-XX&#39;**]**Array<&#39;en-US&#39; &#124; &#39;fr-FR&#39; &#124; &#39;en-GB&#39; &#124; &#39;es-ES&#39; &#124; &#39;it-IT&#39; &#124; &#39;nl-NL&#39; &#124; &#39;da-DA&#39; &#124; &#39;sv-SE&#39; &#124; &#39;pt-PT&#39; &#124; &#39;fi-FI&#39; &#124; &#39;no-NB&#39; &#124; &#39;no-NN&#39; &#124; &#39;ja-JA&#39; &#124; &#39;de-DE&#39; &#124; &#39;pt-BR&#39; &#124; &#39;zh-CN&#39; &#124; &#39;zh-TW&#39; &#124; &#39;ko-KO&#39; &#124; &#39;ru-RU&#39; &#124; &#39;el-EL&#39; &#124; &#39;tr-TR&#39; &#124; &#39;pl-PL&#39; &#124; &#39;cs-CS&#39; &#124; &#39;sk-SK&#39; &#124; &#39;hu-HU&#39; &#124; &#39;sr-SR&#39; &#124; &#39;ar-SA&#39; &#124; &#39;hr-HR&#39; &#124; &#39;ro-RO&#39; &#124; &#39;th-TH&#39; &#124; &#39;xx-XX&#39;>** | The language that describes the details of a resource. Resources available in different languages may differ from each other.&lt;li&gt;If &lt;code&gt;lang&lt;/code&gt; is not passed, then the portal\&#39;s default language is used.&lt;/li&gt; | (optional) defaults to undefined|
| **$pagenum** | [**number**] | Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize. | (optional) defaults to 1|
| **$pagesize** | [**number**] | Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum. | (optional) defaults to 10|


### Return type

**ComplianceArticleResults**

### Authorization

[oAuthUser](../README.md#oAuthUser)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Success |  -  |
|**204** | No Content |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Not Found |  -  |
|**406** | Not acceptable |  -  |
|**500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getAnnouncementArticles**
> ArticleResults getAnnouncementArticles()

## Overview The Get Announcement Articles API returns a portal\'s announcement articles. Only displayable announcement articles in the portal are returned.   ## Prerequisites   * For an article to display or be returned, set the Article type’s parameter, “Include in browse on portals,” to \"Yes\".   * 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.  ## Permissions    * 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.      

### Example

```typescript
import {
    ArticleApi,
    Configuration
} from '@ngreenberg/portalmgr-sdk';

const configuration = new Configuration();
const apiInstance = new ArticleApi(configuration);

let acceptLanguage: '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 Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). (default to undefined)
let portalID: string; //The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. (default to undefined)
let xEgainActivityId: string; //A unique numeric interaction identifier from eGain. (optional) (default to undefined)
let xExtIntegrationId: string; //The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* (optional) (default to undefined)
let xExtInteractionId: string; //A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* (optional) (default to undefined)
let $filterTags: string; //A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together. (optional) (default to undefined)
let articleResultAdditionalAttributes: Array<'averageRating' | 'customAttributes' | 'description' | 'articleSummary' | 'imageURL' | 'isSubscribed' | 'timesRated' | 'topicBreadcrumb' | 'ownedBy' | 'ownedBy.userName' | 'workflow' | 'compliance' | 'personalization' | 'all'>; //The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing \'all\' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.  (optional) (default to undefined)
let workflowMilestone: 'authoring' | 'staging' | 'publish'; //For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>\'Authoring\' returns the most recent version of an Article checked-in by an author.</li><li>\'Staging\' returns the updated version currently being processed in a workflow.</li><li>\'Publish\' returns the most recently published version.</li> (optional) (default to undefined)
let $lang: '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' | 'xx-XX'; //The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>lang</code> is not passed, then the portal\'s default language is used.</li> (optional) (default to undefined)
let $pagenum: number; //Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize. (optional) (default to 1)
let $pagesize: number; //Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum. (optional) (default to 10)

const { status, data } = await apiInstance.getAnnouncementArticles(
    acceptLanguage,
    portalID,
    xEgainActivityId,
    xExtIntegrationId,
    xExtInteractionId,
    $filterTags,
    articleResultAdditionalAttributes,
    workflowMilestone,
    $lang,
    $pagenum,
    $pagesize
);
```

### Parameters
|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptLanguage** | [**&#39;en-US&#39; | &#39;es-ES&#39; | &#39;fr-FR&#39; | &#39;it-IT&#39; | &#39;de-DE&#39; | &#39;nl-NL&#39; | &#39;pt-BR&#39; | &#39;pt-PT&#39; | &#39;da-DK&#39; | &#39;ru-RU&#39; | &#39;fr-CA&#39; | &#39;zh-CN&#39; | &#39;ja-JP&#39; | &#39;ko-KR&#39; | &#39;sv-SE&#39;**]**Array<&#39;en-US&#39; &#124; &#39;es-ES&#39; &#124; &#39;fr-FR&#39; &#124; &#39;it-IT&#39; &#124; &#39;de-DE&#39; &#124; &#39;nl-NL&#39; &#124; &#39;pt-BR&#39; &#124; &#39;pt-PT&#39; &#124; &#39;da-DK&#39; &#124; &#39;ru-RU&#39; &#124; &#39;fr-CA&#39; &#124; &#39;zh-CN&#39; &#124; &#39;ja-JP&#39; &#124; &#39;ko-KR&#39; &#124; &#39;sv-SE&#39;>** | The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). | defaults to undefined|
| **portalID** | [**string**] | The ID of the portal being accessed.&lt;br&gt;&lt;br&gt;A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. | defaults to undefined|
| **xEgainActivityId** | [**string**] | A unique numeric interaction identifier from eGain. | (optional) defaults to undefined|
| **xExtIntegrationId** | [**string**] | The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* | (optional) defaults to undefined|
| **xExtInteractionId** | [**string**] | A unique interaction identifier from other CRM applications.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* | (optional) defaults to undefined|
| **$filterTags** | [**string**] | A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.&lt;br&gt;&lt;br&gt;Tag IDs and Tag Group IDs can be mixed together. | (optional) defaults to undefined|
| **articleResultAdditionalAttributes** | **Array<&#39;averageRating&#39; &#124; &#39;customAttributes&#39; &#124; &#39;description&#39; &#124; &#39;articleSummary&#39; &#124; &#39;imageURL&#39; &#124; &#39;isSubscribed&#39; &#124; &#39;timesRated&#39; &#124; &#39;topicBreadcrumb&#39; &#124; &#39;ownedBy&#39; &#124; &#39;ownedBy.userName&#39; &#124; &#39;workflow&#39; &#124; &#39;compliance&#39; &#124; &#39;personalization&#39; &#124; &#39;all&#39;>** | The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing \&#39;all\&#39; will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.&lt;br&gt;False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.  | (optional) defaults to undefined|
| **workflowMilestone** | [**&#39;authoring&#39; | &#39;staging&#39; | &#39;publish&#39;**]**Array<&#39;authoring&#39; &#124; &#39;staging&#39; &#124; &#39;publish&#39;>** | For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.&lt;li&gt;\&#39;Authoring\&#39; returns the most recent version of an Article checked-in by an author.&lt;/li&gt;&lt;li&gt;\&#39;Staging\&#39; returns the updated version currently being processed in a workflow.&lt;/li&gt;&lt;li&gt;\&#39;Publish\&#39; returns the most recently published version.&lt;/li&gt; | (optional) defaults to undefined|
| **$lang** | [**&#39;en-US&#39; | &#39;fr-FR&#39; | &#39;en-GB&#39; | &#39;es-ES&#39; | &#39;it-IT&#39; | &#39;nl-NL&#39; | &#39;da-DA&#39; | &#39;sv-SE&#39; | &#39;pt-PT&#39; | &#39;fi-FI&#39; | &#39;no-NB&#39; | &#39;no-NN&#39; | &#39;ja-JA&#39; | &#39;de-DE&#39; | &#39;pt-BR&#39; | &#39;zh-CN&#39; | &#39;zh-TW&#39; | &#39;ko-KO&#39; | &#39;ru-RU&#39; | &#39;el-EL&#39; | &#39;tr-TR&#39; | &#39;pl-PL&#39; | &#39;cs-CS&#39; | &#39;sk-SK&#39; | &#39;hu-HU&#39; | &#39;sr-SR&#39; | &#39;ar-SA&#39; | &#39;hr-HR&#39; | &#39;ro-RO&#39; | &#39;th-TH&#39; | &#39;xx-XX&#39;**]**Array<&#39;en-US&#39; &#124; &#39;fr-FR&#39; &#124; &#39;en-GB&#39; &#124; &#39;es-ES&#39; &#124; &#39;it-IT&#39; &#124; &#39;nl-NL&#39; &#124; &#39;da-DA&#39; &#124; &#39;sv-SE&#39; &#124; &#39;pt-PT&#39; &#124; &#39;fi-FI&#39; &#124; &#39;no-NB&#39; &#124; &#39;no-NN&#39; &#124; &#39;ja-JA&#39; &#124; &#39;de-DE&#39; &#124; &#39;pt-BR&#39; &#124; &#39;zh-CN&#39; &#124; &#39;zh-TW&#39; &#124; &#39;ko-KO&#39; &#124; &#39;ru-RU&#39; &#124; &#39;el-EL&#39; &#124; &#39;tr-TR&#39; &#124; &#39;pl-PL&#39; &#124; &#39;cs-CS&#39; &#124; &#39;sk-SK&#39; &#124; &#39;hu-HU&#39; &#124; &#39;sr-SR&#39; &#124; &#39;ar-SA&#39; &#124; &#39;hr-HR&#39; &#124; &#39;ro-RO&#39; &#124; &#39;th-TH&#39; &#124; &#39;xx-XX&#39;>** | The language that describes the details of a resource. Resources available in different languages may differ from each other.&lt;li&gt;If &lt;code&gt;lang&lt;/code&gt; is not passed, then the portal\&#39;s default language is used.&lt;/li&gt; | (optional) defaults to undefined|
| **$pagenum** | [**number**] | Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize. | (optional) defaults to 1|
| **$pagesize** | [**number**] | Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum. | (optional) defaults to 10|


### Return type

**ArticleResults**

### Authorization

[oAuthAnonymousCustomer](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#oAuthUser)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Success |  -  |
|**204** | No Content |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Not Found |  -  |
|**406** | Not acceptable |  -  |
|**500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getArticleById**
> Article getArticleById()

## Overview   * The Get Article by ID API allows a user to retrieve an Article using its ID.     * 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. 

### Example

```typescript
import {
    ArticleApi,
    Configuration
} from '@ngreenberg/portalmgr-sdk';

const configuration = new Configuration();
const apiInstance = new ArticleApi(configuration);

let acceptLanguage: '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 Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). (default to undefined)
let portalID: string; //The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. (default to undefined)
let articleID: string; //The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. (default to undefined)
let xEgainActivityId: string; //A unique numeric interaction identifier from eGain. (optional) (default to undefined)
let xExtIntegrationId: string; //The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* (optional) (default to undefined)
let xExtInteractionId: string; //A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* (optional) (default to undefined)
let $lang: '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' | 'xx-XX'; //The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>lang</code> is not passed, then the portal\'s default language is used.</li> (optional) (default to undefined)
let articleAdditionalAttributes: Array<'articleMacro' | 'availabilityDate' | 'availableEditions' | 'averageRating' | 'bookmarkStatus' | 'content' | 'contentText' | 'compliance' | 'timesRated' | 'createdBy.userName' | 'modifiedBy.userName' | 'ownedBy' | 'ownedBy.userName' | 'workflow' | 'all'>; //The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing \'all\' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | additionalInfo | Additional information provided as Article metadata. | articleType | The Article type and its attributes. | articleKeywords | A comma-separated list of keywords associated with this Article. | articleState | The current state of the Article. States include A (Authoring), S (Staging), and P (Published). | articleSummary | A brief summary of the Article, provided as metadata. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | departmentId | ID of the department for which this Article belongs to. | description | The Article\'s description. | expirationDate | The date that the Article is set to expire. | attachments | The Article\'s attachments | imageURL | The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article. | includeInGenAI | Indicates whether this Article is used for eGain\'s generative AI features. | isSubscribed | Indicates whether the Article is subscribed for notifications.  | languageCode | The language code of the Article language.  | link | The link object, used to retrieve the details of the Article. | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | topicBreadcrumb | Contains a list of topics from the top-level topic to this Article. There may be multiple paths. | versionId | The ID of the Article version that is returned.  (optional) (default to undefined)
let $customAdditionalAttributes: string; // (optional) (default to undefined)
let accessSource: 'article_view' | 'article_view_more_related_Article' | 'article_view_basic_search' | 'article_view_adv_search' | 'article_view_guided_help' | 'article_view_browse_topic' | 'article_view_browse_tree' | 'article_view_popular_articles' | 'article_view_useful_items' | 'article_view_widget' | 'article_view_announcement' | 'article_view_bookmarked' | 'article_view_subscription_notification' | 'article_view_guided_help_additional_info' | 'view_articles_pending_compliance' | 'type_ahead_Suggestion' | 'semantic_Suggestion' | 'instant_answer' | 'instant_answer_reference'; //Provides information about the method in which the Article is accessed and is used for self-service analytics. Refer to the eGain User Guide regarding \"Article View Contexts\".  | Name | Description  | ---- | ----------- | article_view | View an Article directly using its ID. | article_view_more_related_Article  | View related articles of an Article using its ID. | article_view_basic_search | View an Article via a basic search. | article_view_adv_search | View an Article via an advanced search. | article_view_guided_help | View an Article via a Guided Help solution. | article_view_browse_topic | View an Article via browsing a topic. | article_view_browse_tree | View an Article via browsing a topic tree. | article_view_popular_articles | View an Article using the Popular Items list in the Self-Service portal. | article_view_useful_items | View Article using the Useful Items list in the Self-Service portal. | article_view_widget | View an Article via a widget. | article_view_announcement | View an Article from the announcement section in the Self-Service portal. | article_view_bookmarked | View a bookmarked Article. | article_view_subscription_notification | View an Article from a subscription notification. | article_view_guided_help_additional_info | View an Article via additional information from a Guided Help search. | view_articles_pending_compliance | View an Article via Read & Sign in the Self-Service portal. | type_ahead_Suggestion | View an Article from a type-ahead Suggestion in the Self-Service portal. | semantic_Suggestion | View an Article from a semantic Suggestion in the Self-Service portal. | instant_answer | View an Article via an Instant Answers solution. | instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.  (optional) (default to 'article_view')
let publishViewId: string; //The ID of a publish view for an Article. A publish view is a set of tags used to generate multiple editions of the same Article for display on the self-service portal. Publish views are used in conjunction with single sourcing to tailor the content of an Article to a specific audience by granting access to an Article\'s version to users that possess the same tags.<br><br>A publish view ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits. (optional) (default to undefined)
let workflowMilestone: 'authoring' | 'staging' | 'publish'; //For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>\'Authoring\' returns the most recent version of an Article checked-in by an author.</li><li>\'Staging\' returns the updated version currently being processed in a workflow.</li><li>\'Publish\' returns the most recently published version.</li> (optional) (default to undefined)

const { status, data } = await apiInstance.getArticleById(
    acceptLanguage,
    portalID,
    articleID,
    xEgainActivityId,
    xExtIntegrationId,
    xExtInteractionId,
    $lang,
    articleAdditionalAttributes,
    $customAdditionalAttributes,
    accessSource,
    publishViewId,
    workflowMilestone
);
```

### Parameters
|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptLanguage** | [**&#39;en-US&#39; | &#39;es-ES&#39; | &#39;fr-FR&#39; | &#39;it-IT&#39; | &#39;de-DE&#39; | &#39;nl-NL&#39; | &#39;pt-BR&#39; | &#39;pt-PT&#39; | &#39;da-DK&#39; | &#39;ru-RU&#39; | &#39;fr-CA&#39; | &#39;zh-CN&#39; | &#39;ja-JP&#39; | &#39;ko-KR&#39; | &#39;sv-SE&#39;**]**Array<&#39;en-US&#39; &#124; &#39;es-ES&#39; &#124; &#39;fr-FR&#39; &#124; &#39;it-IT&#39; &#124; &#39;de-DE&#39; &#124; &#39;nl-NL&#39; &#124; &#39;pt-BR&#39; &#124; &#39;pt-PT&#39; &#124; &#39;da-DK&#39; &#124; &#39;ru-RU&#39; &#124; &#39;fr-CA&#39; &#124; &#39;zh-CN&#39; &#124; &#39;ja-JP&#39; &#124; &#39;ko-KR&#39; &#124; &#39;sv-SE&#39;>** | The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). | defaults to undefined|
| **portalID** | [**string**] | The ID of the portal being accessed.&lt;br&gt;&lt;br&gt;A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. | defaults to undefined|
| **articleID** | [**string**] | The ID of the Article.&lt;br&gt;&lt;br&gt;An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits. | defaults to undefined|
| **xEgainActivityId** | [**string**] | A unique numeric interaction identifier from eGain. | (optional) defaults to undefined|
| **xExtIntegrationId** | [**string**] | The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.* | (optional) defaults to undefined|
| **xExtInteractionId** | [**string**] | A unique interaction identifier from other CRM applications.&lt;br&gt;&lt;br&gt;*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.* | (optional) defaults to undefined|
| **$lang** | [**&#39;en-US&#39; | &#39;fr-FR&#39; | &#39;en-GB&#39; | &#39;es-ES&#39; | &#39;it-IT&#39; | &#39;nl-NL&#39; | &#39;da-DA&#39; | &#39;sv-SE&#39; | &#39;pt-PT&#39; | &#39;fi-FI&#39; | &#39;no-NB&#39; | &#39;no-NN&#39; | &#39;ja-JA&#39; | &#39;de-DE&#39; | &#39;pt-BR&#39; | &#39;zh-CN&#39; | &#39;zh-TW&#39; | &#39;ko-KO&#39; | &#39;ru-RU&#39; | &#39;el-EL&#39; | &#39;tr-TR&#39; | &#39;pl-PL&#39; | &#39;cs-CS&#39; | &#39;sk-SK&#39; | &#39;hu-HU&#39; | &#39;sr-SR&#39; | &#39;ar-SA&#39; | &#39;hr-HR&#39; | &#39;ro-RO&#39; | &#39;th-TH&#39; | &#39;xx-XX&#39;**]**Array<&#39;en-US&#39; &#124; &#39;fr-FR&#39; &#124; &#39;en-GB&#39; &#124; &#39;es-ES&#39; &#124; &#39;it-IT&#39; &#124; &#39;nl-NL&#39; &#124; &#39;da-DA&#39; &#124; &#39;sv-SE&#39; &#124; &#39;pt-PT&#39; &#124; &#39;fi-FI&#39; &#124; &#39;no-NB&#39; &#124; &#39;no-NN&#39; &#124; &#39;ja-JA&#39; &#124; &#39;de-DE&#39; &#124; &#39;pt-BR&#39; &#124; &#39;zh-CN&#39; &#124; &#39;zh-TW&#39; &#124; &#39;ko-KO&#39; &#124; &#39;ru-RU&#39; &#124; &#39;el-EL&#39; &#124; &#39;tr-TR&#39; &#124; &#39;pl-PL&#39; &#124; &#39;cs-CS&#39; &#124; &#39;sk-SK&#39; &#124; &#39;hu-HU&#39; &#124; &#39;sr-SR&#39; &#124; &#39;ar-SA&#39; &#124; &#39;hr-HR&#39; &#124; &#39;ro-RO&#39; &#124; &#39;th-TH&#39; &#124; &#39;xx-XX&#39;>** | The language that describes the details of a resource. Resources available in different languages may differ from each other.&lt;li&gt;If &lt;code&gt;lang&lt;/code&gt; is not passed, then the portal\&#39;s default language is used.&lt;/li&gt; | (optional) defaults to undefined|
| **articleAdditionalAttributes** | **Array<&#39;articleMacro&#39; &#124; &#39;availabilityDate&#39; &#124; &#39;availableEditions&#39; &#124; &#39;averageRating&#39; &#124; &#39;bookmarkStatus&#39; &#124; &#39;content&#39; &#124; &#39;contentText&#39; &#124; &#39;compliance&#39; &#124; &#39;timesRated&#39; &#124; &#39;createdBy.userName&#39; &#124; &#39;modifiedBy.userName&#39; &#124; &#39;ownedBy&#39; &#124; &#39;ownedBy.userName&#39; &#124; &#39;workflow&#39; &#124; &#39;all&#39;>** | The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing \&#39;all\&#39; will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | additionalInfo | Additional information provided as Article metadata. | articleType | The Article type and its attributes. | articleKeywords | A comma-separated list of keywords associated with this Article. | articleState | The current state of the Article. States include A (Authoring), S (Staging), and P (Published). | articleSummary | A brief summary of the Article, provided as metadata. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | departmentId | ID of the department for which this Article belongs to. | description | The Article\&#39;s description. | expirationDate | The date that the Article is set to expire. | attachments | The Article\&#39;s attachments | imageURL | The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article. | includeInGenAI | Indicates whether this Article is used for eGain\&#39;s generative AI features. | isSubscribed | Indicates whether the Article is subscribed for notifications.  | languageCode | The language code of the Article language.  | link | The link object, used to retrieve the details of the Article. | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | topicBreadcrumb | Contains a list of topics from the top-level topic to this Article. There may be multiple paths. | versionId | The ID of the Article version that is returned.  | (optional) defaults to undefined|
| **$customAdditionalAttributes** | [**string**] |  | (optional) defaults to undefined|
| **accessSource** | [**&#39;article_view&#39; | &#39;article_view_more_related_Article&#39; | &#39;article_view_basic_search&#39; | &#39;article_view_adv_search&#39; | &#39;article_view_guided_help&#39; | &#39;article_view_browse_topic&#39; | &#39;article_view_browse_tree&#39; | &#39;article_view_popular_articles&#39; | &#39;article_view_useful_items&#39; | &#39;article_view_widget&#39; | &#39;article_view_announcement&#39; | &#39;article_view_bookmarked&#39; | &#39;article_view_subscription_notification&#39; | &#39;article_view_guided_help_additional_info&#39; | &#39;view_articles_pending_compliance&#39; | &#39;type_ahead_Suggestion&#39; | &#39;semantic_Suggestion&#39; | &#39;instant_answer&#39; | &#39;instant_answer_reference&#39;**]**Array<&#39;article_view&#39; &#124; &#39;article_view_more_related_Article&#39; &#124; &#39;article_view_basic_search&#39; &#124; &#39;article_view_adv_search&#39; &#124; &#39;article_view_guided_help&#39; &#124; &#39;article_view_browse_topic&#39; &#124; &#39;article_view_browse_tree&#39; &#124; &#39;article_view_popular_articles&#39; &#124; &#39;article_view_useful_items&#39; &#124; &#39;article_view_widget&#39; &#124; &#39;article_view_announcement&#39; &#124; &#39;article_view_bookmarked&#39; &#124; &#39;article_view_subscription_notification&#39; &#124; &#39;article_view_guided_help_additional_info&#39; &#124; &#39;view_articles_pending_compliance&#39; &#124; &#39;type_ahead_Suggestion&#39; &#124; &#39;semantic_Suggestion&#39; &#124; &#39;instant_answer&#39; &#124; &#39;instant_answer_reference&#39;>** | Provides information about the method in which the Article is accessed and is used for self-service analytics. Refer to the eGain User Guide regarding \&quot;Article View Contexts\&quot;.  | Name | Description  | ---- | ----------- | article_view | View an Article directly using its ID. | article_view_more_related_Article  | View related articles of an Article using its ID. | article_view_basic_search | View an Article via a basic search. | article_view_adv_search | View an Article via an advanced search. | article_view_guided_help | View an Article via a Guided Help solution. | article_view_browse_topic | View an Article via browsing a topic. | article_view_browse_tree | View an Article via browsing a topic tree. | article_view_popular_articles | View an Article using the Popular Items list in the Self-Service portal. | article_view_useful_items | View Article using the Useful Items list in the Self-Service portal. | article_view_widget | View an Article via a widget. | article_view_announcement | View an Article from the announcement section in the Self-Service portal. | article_view_bookmarked | View a bookmarked Article. | article_view_subscription_notification | View an Article from a subscription notification. | article_view_guided_help_additional_info | View an Article via additional information from a Guided Help search. | view_articles_pending_compliance | View an Article via Read &amp; Sign in the Self-Service portal. | type_ahead_Suggestion | View an Article from a type-ahead Suggestion in the Self-Service portal. | semantic_Suggestion | View an Article from a semantic Suggestion in the Self-Service portal. | instant_answer | View an Article via an Instant Answers solution. | instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.  | (optional) defaults to 'article_view'|
| **publishViewId** | [**string**] | The ID of a publish view for an Article. A publish view is a set of tags used to generate multiple editions of the same Article for display on the self-service portal. Publish views are used in conjunction with single sourcing to tailor the content of an Article to a specific audience by granting access to an Article\&#39;s version to users that possess the same tags.&lt;br&gt;&lt;br&gt;A publish view ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits. | (optional) defaults to undefined|
| **workflowMilestone** | [**&#39;authoring&#39; | &#39;staging&#39; | &#39;publish&#39;**]**Array<&#39;authoring&#39; &#124; &#39;staging&#39; &#124; &#39;publish&#39;>** | For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.&lt;li&gt;\&#39;Authoring\&#39; returns the most recent version of an Article checked-in by an author.&lt;/li&gt;&lt;li&gt;\&#39;Staging\&#39; returns the updated version currently being processed in a workflow.&lt;/li&gt;&lt;li&gt;\&#39;Publish\&#39; returns the most recently published version.&lt;/li&gt; | (optional) defaults to undefined|


### Return type

**Article**

### Authorization

[oAuthAnonymousCustomer](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#oAuthUser)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Success |  -  |
|**204** | No Content |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Not Found |  -  |
|**406** | Not acceptable |  -  |
|**500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getArticlePermissionsById**
> ArticlePermissionsResult getArticlePermissionsById()

## Overview   * The Get Article Permission by ID permits a user to retrieve permissions associated to an article. 

### Example

```typescript
import {
    ArticleApi,
    Configuration
} from '@ngreenberg/portalmgr-sdk';

const configuration = new Configuration();
const apiInstance = new ArticleApi(configuration);

let acceptLanguage: '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 Language locale accepted by the client (used for locale specific fields in resource