v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

copilotAuditLogs

partially update one existing copilotAuditLog

Partially update one existing copilotAuditLog

patch/api/serviceorganizations/copilotAuditLogs/{identifier}

Path parameters

identifierstring uuid required

copilotAuditLog unique identifier

Request body

uuidstring uuid

createdAtstring date-time

createdBystring uuid

lastUpdatedAtstring date-time

lastUpdatedBystring uuid

lastUpdatedByAudiencestring

lastUpdatedByAudienceUuidstring uuid

lastUpdatedByImpersonatedBystring uuid

lastUpdatedByCompanyUuidstring uuid

lastUpdatedByEnterpriseUuidstring uuid

companyUuidstring uuid required

Unique identifier for the company

agentNamestring required

Name of the agent

exAgentIdinteger required

Internal ExAgent ID

exAgentThreadIdinteger required

Internal ExAgent Thread ID

exAgentUuidstring uuid

External ExAgent UUID

exAgentThreadUuidstring uuid

External ExAgent Thread UUID

userIdstring

User ID who triggered the tool call

userEmailstring

User email who triggered the tool call

actionTypestring

Action type (if applicable)

outputstring

Serialized output of the tool call

statusstring

Status of the tool call

annotationsobject

Any extra metadata annotations

Example request

{
  "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
  "createdAt": "2021-05-05T01:02:03.924Z",
  "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
  "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
  "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
  "lastUpdatedByAudience": "employer",
  "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
  "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
  "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
  "companyUuid": "06b0ee4f-3477-4091-a395-5e82b7c50cc7",
  "agentName": "Copilot Attendance Bot",
  "exAgentId": 123,
  "exAgentThreadId": 456,
  "exAgentUuid": "aabbccdd-eeff-1122-3344-556677889900",
  "exAgentThreadUuid": "ddeeff00-1122-3344-5566-778899aabbcc",
  "userId": "user-123",
  "userEmail": "john.doe@company.com",
  "actionType": "TOOL_CALL",
  "output": "{\"result\": \"Success\", \"data\": {}}",
  "status": "success"
}

Response

updated copilotAuditLog. Wrapped in a JsonAPI root response.

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "companyUuid": "06b0ee4f-3477-4091-a395-5e82b7c50cc7",
    "agentName": "Copilot Attendance Bot",
    "exAgentId": 123,
    "exAgentThreadId": 456,
    "exAgentUuid": "aabbccdd-eeff-1122-3344-556677889900",
    "exAgentThreadUuid": "ddeeff00-1122-3344-5566-778899aabbcc",
    "userId": "user-123",
    "userEmail": "john.doe@company.com",
    "actionType": "TOOL_CALL",
    "output": "{\"result\": \"Success\", \"data\": {}}",
    "status": "success"
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}