Put Copilot Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Copilot/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"CopilotId\": 123,\n  \"Name\": \"<string>\",\n  \"CopilotDataSources\": [\n    {\n      \"CopilotDataSourceId\": 123,\n      \"CopilotId\": 123,\n      \"Description\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"Settings\": [\n        {\n          \"CopilotDataSourceSettingId\": 123,\n          \"CopilotDataSourceId\": 123,\n          \"Key\": \"<string>\",\n          \"Value\": \"<string>\",\n          \"TableRight\": {\n            \"Mask\": \"<string>\",\n            \"Reason\": \"<string>\"\n          },\n          \"FieldProperties\": {}\n        }\n      ],\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    CopilotId: 123,
    Name: '<string>',
    CopilotDataSources: [
      {
        CopilotDataSourceId: 123,
        CopilotId: 123,
        Description: '<string>',
        Name: '<string>',
        Settings: [
          {
            CopilotDataSourceSettingId: 123,
            CopilotDataSourceId: 123,
            Key: '<string>',
            Value: '<string>',
            TableRight: {Mask: '<string>', Reason: '<string>'},
            FieldProperties: {}
          }
        ],
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Copilot/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Copilot/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'CopilotId' => 123,
    'Name' => '<string>',
    'CopilotDataSources' => [
        [
                'CopilotDataSourceId' => 123,
                'CopilotId' => 123,
                'Description' => '<string>',
                'Name' => '<string>',
                'Settings' => [
                                [
                                                                'CopilotDataSourceSettingId' => 123,
                                                                'CopilotDataSourceId' => 123,
                                                                'Key' => '<string>',
                                                                'Value' => '<string>',
                                                                'TableRight' => [
                                                                                                                                'Mask' => '<string>',
                                                                                                                                'Reason' => '<string>'
                                                                ],
                                                                'FieldProperties' => [
                                                                                                                                
                                                                ]
                                ]
                ],
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Copilot/{id}"

payload = {
    "CopilotId": 123,
    "Name": "<string>",
    "CopilotDataSources": [
        {
            "CopilotDataSourceId": 123,
            "CopilotId": 123,
            "Description": "<string>",
            "Name": "<string>",
            "Settings": [
                {
                    "CopilotDataSourceSettingId": 123,
                    "CopilotDataSourceId": 123,
                    "Key": "<string>",
                    "Value": "<string>",
                    "TableRight": {
                        "Mask": "<string>",
                        "Reason": "<string>"
                    },
                    "FieldProperties": {}
                }
            ],
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    CopilotId: 123,
    Name: '<string>',
    CopilotDataSources: [
      {
        CopilotDataSourceId: 123,
        CopilotId: 123,
        Description: '<string>',
        Name: '<string>',
        Settings: [
          {
            CopilotDataSourceSettingId: 123,
            CopilotDataSourceId: 123,
            Key: '<string>',
            Value: '<string>',
            TableRight: {Mask: '<string>', Reason: '<string>'},
            FieldProperties: {}
          }
        ],
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Copilot/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CopilotId": 123,
  "Name": "<string>",
  "CopilotDataSources": [
    {
      "CopilotDataSourceId": 123,
      "CopilotDataSourceType": "Requests",
      "CopilotId": 123,
      "Description": "<string>",
      "Name": "<string>",
      "Settings": [
        {
          "CopilotDataSourceSettingId": 123,
          "CopilotDataSourceId": 123,
          "Key": "<string>",
          "Value": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        }
      ],
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Put Copilot Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Copilot/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"CopilotId\": 123,\n  \"Name\": \"<string>\",\n  \"CopilotDataSources\": [\n    {\n      \"CopilotDataSourceId\": 123,\n      \"CopilotId\": 123,\n      \"Description\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"Settings\": [\n        {\n          \"CopilotDataSourceSettingId\": 123,\n          \"CopilotDataSourceId\": 123,\n          \"Key\": \"<string>\",\n          \"Value\": \"<string>\",\n          \"TableRight\": {\n            \"Mask\": \"<string>\",\n            \"Reason\": \"<string>\"\n          },\n          \"FieldProperties\": {}\n        }\n      ],\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    CopilotId: 123,
    Name: '<string>',
    CopilotDataSources: [
      {
        CopilotDataSourceId: 123,
        CopilotId: 123,
        Description: '<string>',
        Name: '<string>',
        Settings: [
          {
            CopilotDataSourceSettingId: 123,
            CopilotDataSourceId: 123,
            Key: '<string>',
            Value: '<string>',
            TableRight: {Mask: '<string>', Reason: '<string>'},
            FieldProperties: {}
          }
        ],
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Copilot/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Copilot/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'CopilotId' => 123,
    'Name' => '<string>',
    'CopilotDataSources' => [
        [
                'CopilotDataSourceId' => 123,
                'CopilotId' => 123,
                'Description' => '<string>',
                'Name' => '<string>',
                'Settings' => [
                                [
                                                                'CopilotDataSourceSettingId' => 123,
                                                                'CopilotDataSourceId' => 123,
                                                                'Key' => '<string>',
                                                                'Value' => '<string>',
                                                                'TableRight' => [
                                                                                                                                'Mask' => '<string>',
                                                                                                                                'Reason' => '<string>'
                                                                ],
                                                                'FieldProperties' => [
                                                                                                                                
                                                                ]
                                ]
                ],
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Copilot/{id}"

payload = {
    "CopilotId": 123,
    "Name": "<string>",
    "CopilotDataSources": [
        {
            "CopilotDataSourceId": 123,
            "CopilotId": 123,
            "Description": "<string>",
            "Name": "<string>",
            "Settings": [
                {
                    "CopilotDataSourceSettingId": 123,
                    "CopilotDataSourceId": 123,
                    "Key": "<string>",
                    "Value": "<string>",
                    "TableRight": {
                        "Mask": "<string>",
                        "Reason": "<string>"
                    },
                    "FieldProperties": {}
                }
            ],
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    CopilotId: 123,
    Name: '<string>',
    CopilotDataSources: [
      {
        CopilotDataSourceId: 123,
        CopilotId: 123,
        Description: '<string>',
        Name: '<string>',
        Settings: [
          {
            CopilotDataSourceSettingId: 123,
            CopilotDataSourceId: 123,
            Key: '<string>',
            Value: '<string>',
            TableRight: {Mask: '<string>', Reason: '<string>'},
            FieldProperties: {}
          }
        ],
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Copilot/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CopilotId": 123,
  "Name": "<string>",
  "CopilotDataSources": [
    {
      "CopilotDataSourceId": 123,
      "CopilotDataSourceType": "Requests",
      "CopilotId": 123,
      "Description": "<string>",
      "Name": "<string>",
      "Settings": [
        {
          "CopilotDataSourceSettingId": 123,
          "CopilotDataSourceId": 123,
          "Key": "<string>",
          "Value": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        }
      ],
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

integer<int32>

required

The CopilotEntity id to update.

Query Parameters

$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.

Body

The CopilotEntity to be saved.

Entity for Copilot configuration Carrier object for CopilotEntity. Services for the CopilotEntity Carrier is available from the AI Agent.

CopilotId

integer<int32>

Primary key

Name

string

The name of copilot

CopilotDataSources

object[]

Data sources

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

CopilotEntity updated.

Entity for Copilot configuration CopilotEntity entity with API _Links added.

CopilotId

integer<int32>

Primary key

Name

string

The name of copilot

CopilotDataSources

object[]

Data sources

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

_Links

object

Show child attributes