Create Audit Record

Creates a new audit record for the object specified in body.

post
Body
idstringOptional
eventstringOptional
summarystringOptional
detailsstringOptional
objectall ofOptional
timestampstring · date-timeOptional
actorall ofOptional
typeall ofOptional
string · enumOptionalPossible values:
requestall ofOptional
Responses
201
Created
application/json
post
POST /public/v1/audit/records HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1267

{
  "id": "text",
  "event": "text",
  "summary": "text",
  "details": "text",
  "object": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "objectType": "text"
  },
  "timestamp": "2025-07-15T19:15:14.600Z",
  "actor": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "account": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "accountType": "text"
    }
  },
  "type": "text",
  "request": {
    "api": {
      "ip": "text",
      "geolocation": {
        "countryCode": "text",
        "countryName": "text",
        "region": "text"
      },
      "userAgent": "text"
    },
    "worker": {
      "workerName": "text"
    },
    "log": {
      "requestId": "text",
      "operationId": "text"
    }
  },
  "documents": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "propertyNameCaseInsensitive": true
      },
      "parent": {
        "options": {
          "propertyNameCaseInsensitive": true
        },
        "parent": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "root": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        }
      },
      "root": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "viewers": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "icon": "text"
    }
  ]
}
{
  "id": "text",
  "event": "text",
  "summary": "text",
  "details": "text",
  "object": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "objectType": "text"
  },
  "timestamp": "2025-07-15T19:15:14.600Z",
  "actor": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "account": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "accountType": "text"
    }
  },
  "type": "text",
  "request": {
    "api": {
      "ip": "text",
      "geolocation": {
        "countryCode": "text",
        "countryName": "text",
        "region": "text"
      },
      "userAgent": "text"
    },
    "worker": {
      "workerName": "text"
    },
    "log": {
      "requestId": "text",
      "operationId": "text"
    }
  },
  "documents": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "propertyNameCaseInsensitive": true
      },
      "parent": {
        "options": {
          "propertyNameCaseInsensitive": true
        },
        "parent": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "root": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        }
      },
      "root": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "viewers": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "icon": "text"
    }
  ]
}

Last updated

Was this helpful?