Dixa
    Nothing Found

Knowledge

Get article

Get a knowledge article by id

SecurityApiKeyAuth
Request
path Parameters
articleId
required
string <uuid>
query Parameters
language
string

Language in which the article translations will be returned. If not provided, the default language will be used.

Responses
200

The knowledge article

400
404

An entity in this request could not be found

500

Internal failure during request processing

get/beta/knowledge/articles/{articleId}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "123e4567-e89b-12d3-a456-426614174000",
    • "isDefaultLocation": true,
    • "translation": {
      • "draft": {
        • "language": "en",
        • "title": "Getting Started",
        • "isIndexedVersion": true,
        • "contents": {
          • "html": "<p>HTML content</p>",
          • "plaintext": "plaintext content"
          },
        • "availableAt": {
          • "helpCenterLinks": []
          }
        },
      • "published": {
        • "language": "en",
        • "title": "Getting Started",
        • "isIndexedVersion": true,
        • "contents": {
          • "html": "<p>HTML content</p>",
          • "plaintext": "plaintext content"
          },
        • "availableAt": {
          • "helpCenterLinks": []
          }
        }
      },
    • "tags": [
      • "f6020a03-5a7a-4d9e-81e6-f1b76a855a5e"
      ],
    • "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
    • "updatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    • "indexedAt": "2021-12-01T12:46:36.581Z[GMT]",
    • "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    • "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    • "ownedBy": "123e4567-e89b-12d3-a456-426614174000",
    • "indexedBy": "123e4567-e89b-12d3-a456-426614174000",
    • "restrictions": {
      • "isRestricted": true,
      • "inheritedRestrictions": [
        • {
          • "fromCollection": "78dfb531-2e1e-4ffc-bd18-fdad68cd2419"
          }
        ]
      },
    • "parentCategory": "123e4567-e89b-12d3-a456-426614174000",
    • "parentCollections": [
      • "78dfb531-2e1e-4ffc-bd18-fdad68cd2419"
      ]
    }
}
Get article translations
Get a knowledge article translations


SecurityApiKeyAuth 
Request 
path Parameters
articleId
required
string <uuid> 
 
Responses 
200
The article translations


400
404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/knowledge/articles/{articleId}/translations
Request samples 
Response samples 
application/json
{
  • "data": {
    • "translations": {
      • "draft": [
        • {
          • "language": "en",
          • "title": "Getting Started",
          • "isIndexedVersion": true,
          • "contents": {
            • "html": "<p>HTML content</p>",
            • "plaintext": "plaintext content"
            },
          • "availableAt": {
            • "helpCenterLinks": []
            }
          }
        ],
      • "published": [
        • {
          • "language": "en",
          • "title": "Getting Started",
          • "isIndexedVersion": true,
          • "contents": {
            • "html": "<p>HTML content</p>",
            • "plaintext": "plaintext content"
            },
          • "availableAt": {
            • "helpCenterLinks": []
            }
          }
        ]
      }
    }
}
Get category
Get a knowledge category by id


SecurityApiKeyAuth 
Request 
path Parameters
categoryId
required
string <uuid> 
 
query Parameters
language
string
Language in which the article translations will be returned. If not provided, the default language will be used.


 
Responses 
200
The category


400
404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/knowledge/categories/{categoryId}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "123e4567-e89b-12d3-a456-426614174000",
    • "title": {
      • "languageId": "en",
      • "title": "Getting Started"
      },
    • "isDefaultLocation": true,
    • "isLocked": false,
    • "restrictions": {
      • "isRestricted": true,
      • "inheritedRestrictions": [
        • {
          • "fromCollection": "78dfb531-2e1e-4ffc-bd18-fdad68cd2419"
          }
        ]
      },
    • "parentCategory": "222e4567-e89b-12d3-a456-426614174111",
    • "parentCollections": [
      • "78dfb531-2e1e-4ffc-bd18-fdad68cd2419"
      ]
    }
}
Get category translations
Get the knowledge category translations


SecurityApiKeyAuth 
Request 
path Parameters
categoryId
required
string <uuid> 
 
Responses 
200
The category translations


400
404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/knowledge/categories/{categoryId}/translations
Request samples 
Response samples 
application/json
{
  • "data": {
    • "titles": [
      • {
        • "languageId": "en",
        • "title": "Getting Started"
        }
      ]
    }
}
Get collection
Get a knowledge collection by id


SecurityApiKeyAuth 
Request 
path Parameters
collectionId
required
string <uuid> 
 
Responses 
200
The knowledge collection


400
404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/knowledge/collections/{collectionId}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "78dfb531-2e1e-4ffc-bd18-fdad68cd2419",
    • "title": "Test Collection",
    • "description": "This is a test collection",
    • "internalKbEnabled": true,
    • "restrictions": {
      • "isRestricted": true,
      • "inheritedRestrictions": [
        • {
          • "fromCollection": "78dfb531-2e1e-4ffc-bd18-fdad68cd2419"
          }
        ]
      }
    }
}
Get collection catalog
Get collection catalog, including all categories and articles


SecurityApiKeyAuth 
Request 
path Parameters
collectionId
required
string <uuid> 
 
query Parameters
language
string
Language in which the article translations will be returned. If not provided, the default language will be used.


 
Responses 
200
The knowledge collection catalog


400
404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/knowledge/collections/{collectionId}/catalog
Request samples 
Response samples 
application/json
{
  • "data": {
    • "categories": [
      • {
        • "id": "123e4567-e89b-12d3-a456-426614174000",
        • "title": {
          • "languageId": "en",
          • "title": "Getting Started"
          },
        • "categories": [
          • {
            • "id": "123e4567-e89b-12d3-a456-426614174000",
            • "title": {
              • "languageId": "en",
              • "title": "Getting Started"
              },
            • "categories": [ ],
            • "articles": [
              • {
                • "id": "5f2640d8-631c-4472-8d48-3de0cfd21cd0",
                • "title": {
                  • "languageId": "en",
                  • "title": "Getting Started"
                  }
                }
              ]
            }
          ],
        • "articles": [
          • {
            • "id": "5f2640d8-631c-4472-8d48-3de0cfd21cd0",
            • "title": {
              • "languageId": "en",
              • "title": "Getting Started"
              }
            }
          ]
        }
      ],
    • "articles": [
      • {
        • "id": "5f2640d8-631c-4472-8d48-3de0cfd21cd0",
        • "title": {
          • "languageId": "en",
          • "title": "Getting Started"
          }
        }
      ]
    }
}
List collections
Paginated list knowledge collections


SecurityApiKeyAuth 
Request 
query Parameters
pageKey
string
Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.


 
pageLimit
integer <int32> 
Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.


 
Responses 
200
A list of knowledge collections


400
404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/knowledge/collections
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "78dfb531-2e1e-4ffc-bd18-fdad68cd2419",
      • "title": "Test Collection",
      • "description": "This is a test collection",
      • "internalKbEnabled": true,
      • "restrictions": {
        • "isRestricted": true,
        • "inheritedRestrictions": [
          • {
            • "fromCollection": "78dfb531-2e1e-4ffc-bd18-fdad68cd2419"
            }
          ]
        }
      }
    ]
}
Why Dixa
Product
Capabilities
Resources
Solutions
Company
Call us now 
© Dixa 2024