GET CopilotDataSource/{id}
Some tooltip text!
• 2 minutes to read
• 2 minutes to read
GET /api/v1/CopilotDataSource/{id}
Gets a CopilotDataSourceEntity object.
Calls the AI agent service GetCopilotDataSourceEntity. NsApiSlow threshold: 1000 ms.
Experimental: ## The AI agent is experimental, subject to change, and not intended for partners.
| Path Part | Type | Description |
|---|---|---|
| id | int32 | The id of the CopilotDataSourceEntity to return. Required |
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| $select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields. |
GET /api/v1/CopilotDataSource/{id}?$select=name,department,category/id
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Response:
CopilotDataSourceEntity found.
| Response | Description |
|---|---|
| 200 | CopilotDataSourceEntity found. |
| 404 | Not Found. |
Response body: CopilotDataSourceEntityWithLinks
| Property Name | Type | Description |
|---|---|---|
| CopilotDataSourceId | int32 | Primary key |
| CopilotDataSourceType | string | Type of copilot data source |
| CopilotId | int32 | The associated copilot |
| Description | string | Description of data source |
| Name | string | Name of data source |
| Settings | array | Collection of data source settings |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
| _Links | object |
Sample request
No sample available
Sample response
No sample available