get https://api.talkdeskapp.com/knowledge-management/external-sources/
Retrieves the details of the specified external source.
Scope
km-external-sources:read
Body Response
200 (The details of the specified external source)
| Parameter | Type | Description |
|---|---|---|
| details | object | Specific details of the knowledge base. "details" subdivides into: 1. - "description" (string) - The description of the knowledge base. Example: This is a description. 2. - "knowledge_type" (string) - The type of the external source. <= 255 characters Allowed value: CUSTOM Example: CUSTOM 3. - "name" (string) - The name of the external source. Example: External source XPTO. 4. - "knowledge_segments" (string) The knowledge segments of the external source, separated by commas. Example: sales, vip. 5. - "ring_groups"(array [string]) - The ring groups associated with the external source. Example: ["agents"] 6. - "metadata" (dictionary [string]) A set of arbitrary key-value pairs with additional data about the external source. Example: {"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"} |
| id | string | The ID of the external source. Example: 486d70ae-62ad-4115-a1fd-39ceb87aaa5d |
| enabled | boolean | Determines if the data source should be indexed or not. |
401 (unauthorized), 403 (forbidden), 404 (not found), 500 (internal server error)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.