Get Articles Available For My Work

Overview

This API allows an author to retrieve all the articles that are available to them to process further. The articles returned are based on the user's role and the articles assigned to the user. The user must have proper permissions on the requested article to work on it.

SecurityoAuthUser or oAuthClient
Request
query Parameters
$lang
string

The knowledge base language used for retrieving the response. This must be a language that is made available to the user. If this parameter is not passed, then the default language of the system is used.

Enum: "en-US" "en-GB" "fr-FR" "fi-FI" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DA" "ru-RU" "zh-CN" "sv-SE" "no-NB" "no-NN" "zh-TW" "tr-TR" "pl-PL" "cs-CS" "hu-HU" "ar-SA" "ro-RO" "ja-JA" "ko-KO" "el-EL" "xx-XX"
Example: $lang=en-US
filter[includeArticleTypes]
string

Attributes to filter articles based on their type. If provided, the returned artilces will have types as provided in this filter Provide comma seperatd article type.

Example: filter[includeArticleTypes]=409700000001010,409700000001011,409700000001012
filter[excludeArticleTypes]
string

Attributes to filter articles based on their type. If provided, the returned artilces will have types other than those provided in this filter Provide comma seperatd article type.

Example: filter[excludeArticleTypes]=409700000001010,409700000001011,409700000001012
filter[name]
string

Filter articles based on their name.

Example: filter[name]=Test
filter[description]
string

Filter articles based on their description.

Example: filter[description]=Test
filter[includeArticleTypeNames]
string

Filter articles based on their type name. comma seperated article type name is supported.

Example: filter[includeArticleTypeNames]=General,Suggestion
filter[reviewStageNames]
string

Filter articles based on their review stage name. comma seperated review stage name is supported.

Example: filter[reviewStageNames]=Staging,Review
filter[knowledgeWorkflowNames]
string

Filter articles based on their workflow name. comma seperated workflow name is supported.

Example: filter[knowledgeWorkflowNames]=KnowledgeWorkflow
expandMacros
string

This is an optional query parameter. Allowed values are 'yes' or 'no'. If 'expandMacros=yes', then it will expand all the macros in the result.

Enum: "no" "yes"
Example: expandMacros=no
$pagenum
string

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
Default value: 1

$pagesize
string

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
Default value: 10

$attribute
string

article attributes to be returned. comma separated input

Enum: "id" "lastModified" "created" "suggestionState" "folder" "lock" "language" "attachments" "name" "versionNumber" "articleState" "availabilityDate" "expirationDate" "description" "imageUrl" "department" "articleType" "linkAlias" "path" "suggestionResolutionCode" "currentReviewStage" "previousReviewStage" "currentWorkflow" "ownedBy" "lockedBy" "expiryDateTimeZone" "availabilityDateTimeZone" "returnArticleStateInfo" "all"
$sort
string

article attributes to be sorted. comma separated input

Enum: "id" "name" "description" "createdAt" "createdBy" "lastModifiedAt" "lastModifiedBy" "owner" "checkedOutBy" "workflowName" "reviewStageName" "previousStageName" "currentStageTime" "lastReviewedBy" "articleType" "folderName" "departmentName"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
Responses
200

OK

204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/mywork
Request samples
Response samples
application/json
{
  • "link": {
    },
  • "paginationInfo": {
    },
  • "article": [
    ],
  • "count": 1
}