All pages
Powered by GitBook
1 of 2

Loading...

Loading...

Audit Event Type

Audit Event Type refers to an event that has occurred within the platform. These records are generated automatically and can be used to store supplementary information related to the specific event type.

Field
Type
Description

id

string, core

(Read-only) The ID of the item.

key

string, core

(Read-only) The event's key.

name

string, core

(Read-only) The name of the event.

description

string

(Read-only) (Optional) A description of the event.

Example

AUDIT EVENT TYPE OBJECT
{
  "id": "AET-5699-2751",
  "Key": "platform.commerce.order.created",
  "Name": "Order created.",
  "Description": "A standard event that occurs upon the creation of an order."
},

List audit event types

get
Responses
200

OK

application/json
offsetinteger · int32Optional
limitinteger · int32Optional
totalinteger · int32 · nullableOptional
omittedstring[]Optional
idstringOptional
keystringOptional
namestringOptional
descriptionstringOptional
get/public/v1/audit/event-types
GET /public/v1/audit/event-types HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "key": "text",
      "name": "text",
      "description": "text"
    }
  ]
}