Description
The Knowledge workbench V1 associated APIs are being deprecated and replaced by Knowledge workbench V2 associated APIs. From 29/May/2023, Knowledge v1 APIs will be deprecated and all applications should migrate to the V2 resources. This deprecation does not affect customers who already use Genesys knowledge workbench V2 APIs. See also the feature deprecation announcement of Knowledge workbench V1: Deprecation: Knowledge workbench V1 - Genesys Cloud Resource Center
Change Category
API
Change Context
Genesys' strategic decision is to use Knowledge v2 instead of Knowledge v1 and migrate all the Knowledge v1 customer to use Knowledge v2 as it provides the latest version of Knowledge capabilities. As of now all the Knowledge v1 customers already migrated to use Knowledge v2 except those who integrated with Genesys APIs and calling directly Knowledge v1 APIs from their own applications. These customers were already notified about the deprecation and guided to be able to stop calling Knowledge v1 APIs.
Change Impact
Customers' own applications integrated with Genesys knowledge v1 APIs can be impacted.
Genesys recommends that customers who use the Knowledge v1 API integrations should make a copy of their v1 articles and knowledge bases and migrate to v2 knowledge bases. For migration guidance and help please contact through My Support Portal.
Date of Change
May 29, 2023
Impacted APIs
Knowledge v1 documents:
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs)
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId} (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId})
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs)
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId} (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId})
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents)
Knowledge v1 feedback:
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/feedback/approvals/bulk (replaced by: No replacement)
- api/v2/knowledge/knowledgebases/feedback/approvals/bulk (replaced by: No replacement)
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/feedback/{feedbackId} (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId})
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/feedback (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback)
- api/v2/knowledge/knowledgebases/feedback (replaced by: No replacement)
Knowledge v1 trainings:
- api/v2/knowledge/knowledgebases/trainings (replaced by: No replacement as training is automatic since Knowledge v2)
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId} (replaced by: No replacement as training is automatic since Knowledge v2)
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings (replaced by: No replacement as training is automatic since Knowledge v2)
Knowledge v1 search:
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search)
Knowledge v1 categories:
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories)
- api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId} (replaced by: api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId})
Knowledge v1 knowledgebase:
- Under api/v2/knowledge/knowledgebases/{knowledgeBaseId} and api/v2/knowledge/knowledgebases the "faqCount" and "published" API response properties are being deprecated without any replacement.
References
[GKC-9556], [AI-593]