API docs by Redocly

Supervision Internal Schemas (1.0.0)

Download OpenAPI specification:

License: ISC

Entity, event, and response schemas for the Supervision platform event bus.

Reference documentation for the Supervision platform's internal schema definitions. Every schema below is generated from the JSON Schema files under schemas/ — that directory is the single source of truth.

  • Entities — reusable building blocks such as Person, Case, or Hearing.
  • Events — CloudEvents v1.0 compliant envelope plus payload, named with an Event suffix.
  • Responses — the shared API response envelope and its parts, named with a Response prefix.

Schemas are shown fully resolved: every $ref to an entity or common type is inlined, so each one can be read on its own.

Entities

Source: schemas/entities/

Address

description
string
Enum: "Home" "Mailing" "Other" "Homeless"

Address type: Home, Mailing, Other, Homeless.

object (Code Resolution)

Country code.

streetAddress
string <= 200 characters

Street name and number (e.g., '1316 Imperial Street').

unitNumber
string <= 50 characters

Unit/Apartment/Suite number.

city
string <= 100 characters

City.

object (Code Resolution)

State/Province/Region.

postalCode
string <= 20 characters

Postal code.

foreignAddress
string

If the country code is not '1' this field is required and contains the full foreign address.

object (Code Resolution)

Address area.

{
  • "description": "Home",
  • "country": {
    },
  • "streetAddress": "1234 Main St.",
  • "unitNumber": "215",
  • "city": "Phoenix",
  • "stateProvince": {
    },
  • "postalCode": "85003",
  • "area": {
    }
}

Arrest

entityType
required
any

Must be "arrest".

Value: "arrest"
object (SourceContext)

Object containing source system ID.

arrestNumber
required
string <= 100 characters

Arrest number.

required
object (Code Resolution)

Arresting agency.

arrestDate
required
string <date>

Date of arrest.

{
  • "entityType": "arrest",
  • "sourceContext": {
    },
  • "arrestNumber": "123456789",
  • "arrestAgency": {
    },
  • "arrestDate": "2026-07-01"
}

Booking

entityType
required
any

Must be "booking".

Value: "booking"
object (SourceContext)

Object containing source system ID.

bookingNumber
required
string <= 100 characters

Booking number.

bookingDate
string <date>

Date of booking (YYYY-MM-DD).

required
object (Code Resolution)

Booking facility type.

required
object (Code Resolution)

Booking facility name.

required
object (Code Resolution)

Booking facility location.

{
  • "entityType": "booking",
  • "sourceContext": {
    },
  • "bookingDate": "2026-06-15",
  • "bookingNumber": "12345699",
  • "facilityType": {
    },
  • "facilityName": {
    },
  • "facilityLocation": {
    }
}

BookingCase

entityType
required
any

Must be "booking-case".

Value: "booking-case"
object (SourceContext)

Object containing source system ID.

bookingDate
string <date>

Date of booking (YYYY-MM-DD).

facilityName
string

Location of booking.

bookingNumber
required
string

Booking number.

required
object (Code Resolution)

Which court the case is assigned to.

object (Code Resolution)

Department within the court.

{
  • "entityType": "booking-case",
  • "sourceContext": {
    },
  • "bookingDate": "2026-06-15",
  • "facilityName": "Maricopa County Jail-Towers",
  • "bookingNumber": "12345699",
  • "court": {
    },
  • "courtDepartment": {
    }
}

BookingRelease

entityType
required
any
Value: "booking-release"
object (SourceContext)

Identifies the record in the originating (source) system.

bookingDate
required
string <date>
bookingNumber
required
string
releaseDate
required
string <date>
{
  • "entityType": "booking-release",
  • "sourceContext": {
    },
  • "bookingDate": "2026-06-15",
  • "bookingNumber": "12345699",
  • "releaseDate": "2026-06-20"
}

Case

Any of
entityType
required
any
Enum: "case" "prefile-case"

Must be "case" or "prefile-case".

object (SourceContext)

Object containing source system ID.

courtFileNumber
required
string <= 125 characters

The number assigned to the case by the court, or the prefile number when entityType is "prefile-case".

required
object (Code Resolution)

Which court the case is assigned to.

object (Code Resolution)

Department within the court.

object (Code Resolution)

Judge assigned to the case.

{
  • "entityType": "case",
  • "sourceContext": {
    },
  • "courtFileNumber": "CR-26-123456",
  • "court": {
    },
  • "courtDepartment": {
    },
  • "judge": {
    }
}

CaseLookup

entityType
required
any
Value: "case-lookup"
object (SourceContext)

Identifies the record in the originating (source) system.

courtFileNumber
required
string
required
object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

{
  • "entityType": "case-lookup",
  • "sourceContext": {
    },
  • "courtFileNumber": "CR-26-123456",
  • "court": {
    },
  • "courtDepartment": {
    }
}

Caseload

entityType
required
any
Value: "caseload"
caseloadId
required
integer >= 1
startDate
required
string <date>
isPrimary
boolean
{
  • "entityType": "caseload",
  • "caseloadId": 1,
  • "startDate": "2019-08-24",
  • "isPrimary": true
}

Condition

entityType
required
any

Must be "condition".

Value: "condition"
object (SourceContext)

Source system context for entity tracking.

required
object (Code Resolution)

The actual condition text.

conditionTitle
string <= 100 characters

Custom or default condition title.

conditionText
string

Extended condition text.

actionDueDate
string <date>

Due date for condition (YYYY-MM-DD).

{
  • "entityType": "condition",
  • "sourceContext": {
    },
  • "condition": {
    },
  • "conditionTitle": "01. Obey All Laws",
  • "conditionText": "01. Obey All Laws",
  • "actionDueDate": "2028-12-31"
}

Disposition

required
object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

date
required
string <date>
{
  • "status": {
    },
  • "reason": {
    },
  • "date": "2019-08-24"
}

Document

entityType
required
any

Must be "document".

Value: "document"
documentId
required
string

Document ID.

name
required
string

Document name.

required
object (Code Resolution)

Document type.

fileName
required
string

File name.

documentDate
required
string <date>

Date of the document (YYYY-MM-DD).

description
string

Document description.

{
  • "entityType": "document",
  • "documentId": "12345",
  • "name": "Test Document",
  • "documentType": {
    },
  • "fileName": "Test Document",
  • "documentDate": "2026-07-22",
  • "description": "Court order detailing probation terms and conditions"
}

DocumentFull

Any of
entityType
required
string

Entity type identifier - must be 'document'

Value: "document"
operation
string
Enum: "CREATE" "UPDATE" "UPSERT" "DELETE" "NOOP"

SERVER-INJECTED: Database operation to perform for this entity. Injected by Styx event handler based on event context. Clients MUST NOT provide this field.

documentId
required
integer >= 1

ESUP document identifier (optional, only required for update operations)

object (SourceContext)

Source system context for entity tracking. Links client-provided identifiers with ESUP internal IDs in response payloads.

title
string <= 150 characters

Document title or name

description
string <= 250 characters

Description of the document

object (Code Resolution)

Type of document code resolution (sys_UserFileType table - e.g., Court Order, Sentencing Document, Probation Agreement, Case File, Police Report)

object (Code Resolution)

Category of document code resolution (sys_UserFileCategory table - e.g., Legal Documents, Court Records, Administrative, Evidence)

documentDate
string <date>

Date of the document (YYYY-MM-DD)

object

File information

downloads
integer >= 0

Number of times the document has been downloaded (maps to Downloads field in sys_UserFile)

verified
boolean

Whether the document has been verified/authenticated

recordVisibility
string
Enum: "Available" "Sealed" "Expunged"

Record visibility status - Available (normal access), Sealed (restricted access), Expunged (removed from records)

notes
string

Additional notes about the document

{
  • "entityType": "document",
  • "documentId": 1234,
  • "sourceContext": {
    },
  • "title": "Probation Order and Conditions",
  • "description": "Court order detailing probation terms and conditions",
  • "documentType": {
    },
  • "documentCategory": {
    },
  • "documentDate": "2024-03-15",
  • "file": {
    },
  • "downloads": 0,
  • "verified": true,
  • "recordVisibility": "Available"
}

DocumentUpload

Any of
entityType
required
string

Entity type identifier - must be 'document'

Value: "document"
operation
string
Enum: "CREATE" "UPDATE" "UPSERT" "DELETE" "NOOP"

SERVER-INJECTED: Database operation to perform for this entity. Injected by Styx event handler based on event context. Clients MUST NOT provide this field.

documentId
required
integer >= 1

ESUP document identifier (optional, only required for update operations)

object (SourceContext)

Source system context for entity tracking. Links client-provided identifiers with ESUP internal IDs in response payloads.

title
string <= 150 characters

Document title or name

description
string <= 250 characters

Description of the document

object (Code Resolution)

Type of document code resolution (sys_UserFileType table - e.g., Court Order, Sentencing Document, Probation Agreement, Case File, Police Report)

object (Code Resolution)

Category of document code resolution (sys_UserFileCategory table - e.g., Legal Documents, Court Records, Administrative, Evidence)

documentDate
string <date>

Date of the document (YYYY-MM-DD)

object

File information

downloads
integer >= 0

Number of times the document has been downloaded (maps to Downloads field in sys_UserFile)

verified
boolean

Whether the document has been verified/authenticated

recordVisibility
string
Enum: "Available" "Sealed" "Expunged"

Record visibility status - Available (normal access), Sealed (restricted access), Expunged (removed from records)

notes
string

Additional notes about the document

{
  • "entityType": "document",
  • "documentId": 1234,
  • "sourceContext": {
    },
  • "title": "Probation Order and Conditions",
  • "description": "Court order detailing probation terms and conditions",
  • "documentType": {
    },
  • "documentCategory": {
    },
  • "documentDate": "2024-03-15",
  • "file": {
    },
  • "downloads": 0,
  • "verified": true,
  • "recordVisibility": "Available"
}

Hearing

Any of
entityType
required
any
Enum: "hearing" "hearing-complete"

Must be "hearing".

hearingId
required
integer >= 1

ESUP hearing identifier (only required when referencing an existing hearing).

object (SourceContext)

Object containing source system ID.

hearingDate
string <date>

Date of hearing as YYYY-MM-DD.

hearingTime
string^([01]\d|2[0-3]):([0-5]\d)$

Time of hearing as HH:MM.

object (Code Resolution)

Type of hearing.

object (Code Resolution)

Court holding the hearing.

object (Code Resolution)

Department within the court if configured.

object (Code Resolution)

Location of hearing.

object (Code Resolution)

Judge assigned to the hearing.

courtroomMinutes
string

Courtroom minutes text.

{
  • "entityType": "hearing-complete",
  • "sourceContext": {
    },
  • "hearingDate": "2026-07-30",
  • "hearingTime": "10:30",
  • "hearingType": {
    },
  • "court": {
    },
  • "courtDepartment": {
    },
  • "room": {
    },
  • "judge": {
    },
  • "courtroomMinutes": "Sample hearing minutes"
}

HearingLookup

entityType
required
any
Value: "hearing-lookup"
object (SourceContext)

Identifies the record in the originating (source) system.

hearingDate
required
string <date>
hearingTime
required
string^([01]\d|2[0-3]):([0-5]\d)$
required
object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

required
object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

{
  • "entityType": "hearing-lookup",
  • "sourceContext": {
    },
  • "hearingDate": "2026-07-30",
  • "hearingTime": "10:30",
  • "hearingType": {
    },
  • "court": {
    }
}

IdentificationNumber

required
object (Code Resolution)

NCIC ID Number Type code: SID=State ID, FBI=FBI Number, SOC=SSN, OLN=Driver License, MNU=Miscellaneous, TAX=Tax ID, PAS=Passport, IDC=State Identification Card.

idNumber
required
string <= 40 characters

The identification number.

object (Code Resolution)

Issuing authority or state.

{
  • "idNumberType": {
    },
  • "idNumber": "123456789",
  • "issuedBy": {
    }
}

Offense

One of
entityType
required
string
Enum: "offense-sentence" "offense-pretrial" "offense-presentence"

Must be "offense-pretrial", "offense-presentence", or "offense-sentence".

object (SourceContext)

Object containing source system ID.

count
required
integer

Count number or identifier (e.g., 1, 2).

required
object (Code Resolution)

Offense code/statute code (e.g., PC 459, VC 23152).

required
object (Code Resolution)

Specific section of offense code.

required
object (Code Resolution)

Offense level: Felony, Misdemeanor, etc.

Array of objects (OffenseModifier)

Array of offense enhancements/modifiers.

startDate
string <date>

Date offense began (YYYY-MM-DD).

endDate
string <date>

Date offense ended (YYYY-MM-DD).

required
object (Code Resolution)

Offense disposition/status. Required when entityType is "offense-sentence".

object (Code Resolution)

Offense disposition reason.

dispositionDate
required
string <date>

Disposition date (YYYY-MM-DD). Required when entityType is "offense-sentence".

termYears
integer >= 0

Years of probation.

termMonths
integer >= 0

Months of probation.

termDays
integer >= 0

Days of probation.

Example
{
  • "entityType": "offense-sentence",
  • "sourceContext": {
    },
  • "count": 1,
  • "offenseCode": {
    },
  • "offenseCodeSection": {
    },
  • "offenseLevel": {
    },
  • "modifiers": [
    ],
  • "startDate": "2026-05-15",
  • "endDate": "2026-05-15",
  • "disposition": {
    },
  • "dispositionReason": {
    },
  • "dispositionDate": "2026-07-22",
  • "termYears": 2,
  • "termMonths": 6,
  • "termDays": 30
}

OffenseModifier

required
object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

{
  • "modificationType": {
    }
}

OnlineIdentity

identityType
required
string
Enum: "Email Address - Personal" "Email Address - Work"

Type of email address: Email Address - Personal, Email Address - Work.

emailAddress
required
string <email> <= 255 characters

Email address.

{
  • "identityType": "Email Address - Personal",
  • "emailAddress": "mail@mail.com"
}

Person

Any of
entityType
required
any

Must be "person".

Value: "person"
personId
required
integer >= 1

ESUP person identifier (only required when referencing an existing person).

object (SourceContext)

Object containing source system ID.

Array of objects (PersonName) non-empty

Array of names.

object

Object containing demographic information.

object

Object containing physical characteristics.

Array of objects (IdentificationNumber)

Array of identification numbers.

Array of objects (OnlineIdentity)

Array of online identities.

object

Object of contact information.

{
  • "entityType": "person",
  • "sourceContext": {
    },
  • "names": [
    ],
  • "demographics": {
    },
  • "physicalCharacteristics": {
    },
  • "identificationNumbers": [
    ],
  • "onlineIdentities": [
    ],
  • "contactInformation": {
    }
}

PersonLookup

entityType
required
any
Value: "person-lookup"
object (SourceContext)

Identifies the record in the originating (source) system.

firstName
required
string
middleName
string
lastName
required
string
dateOfBirth
required
string <date>
sid
string
soc
string
fbi
string
oln
string
object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

{
  • "entityType": "person-lookup",
  • "sourceContext": {
    },
  • "firstName": "John",
  • "middleName": "Henry",
  • "lastName": "Jones",
  • "dateOfBirth": "1970-01-15",
  • "sid": "1523659",
  • "soc": "123-45-6789",
  • "fbi": "A123456789",
  • "oln": "Z12345678",
  • "olnState": {
    }
}

PersonName

required
object (Code Resolution)

NCIC Name code type: LGL=Legal Name, AKA=Also Known As, DBA=Doing Business As, FKA=Formerly Known As, LKA=Last Known As, NKA=Now Known As.

firstName
required
string [ 1 .. 100 ] characters

First name of the individual.

middleName
string <= 100 characters

Middle name of the individual.

lastName
required
string [ 1 .. 100 ] characters

Last name of the individual.

object (Code Resolution)

Suffix of the individual.

object (Code Resolution)

Title of the individual.

{
  • "nameType": {
    },
  • "firstName": "John",
  • "middleName": "Henry",
  • "lastName": "Jones",
  • "nameSuffix": {
    },
  • "nameTitle": {
    }
}

PhoneNumber

phoneType
required
string
Enum: "Home" "Mobile" "Work" "Emergency Contact" "Message" "Other"

Phone number type: Home, Mobile, Work, Emergency Contact, Message, Other.

phoneNumber
required
string <= 50 characters

Phone number.

{
  • "phoneType": "Home",
  • "phoneNumber": "6021231234"
}

Warrant

Any of
entityType
required
any

Must be "warrant".

Value: "warrant"
warrantId
required
integer >= 1

ESUP warrant identifier (only required when referencing an existing warrant).

object (SourceContext)

Object containing source system ID.

warrantNumber
string <= 100 characters

Warrant number.

object (Code Resolution)

Warrant type.

warrantStatusDate
string <date>

Date of issuance or status update (YYYY-MM-DD).

warrantStatusTime
string^([01]\d|2[0-3]):([0-5]\d)$

Time of issuance or status update (HH:MM).

object (Code Resolution)

The agency that issued the warrant.

object (Code Resolution)

The agency that will serve the warrant.

bailAmount
number >= 0

The bail amount associated with the warrant.

{
  • "entityType": "warrant",
  • "sourceContext": {
    },
  • "warrantNumber": "123456789",
  • "warrantType": {
    },
  • "warrantStatusDate": "2026-07-25",
  • "warrantStatusTime": "10:30",
  • "issuingAgency": {
    },
  • "responsibleAgency": {
    },
  • "bailAmount": 1000
}

WarrantLookup

entityType
required
any
Value: "warrant-lookup"
object (SourceContext)

Identifies the record in the originating (source) system.

warrantNumber
required
string
required
object (Code Resolution)

Canonical code resolution schema defining the complete structure for external code, internal identifier, and canonical value. This is the base schema that all code resolution schemas inherit from.

{
  • "entityType": "warrant-lookup",
  • "sourceContext": {
    },
  • "warrantNumber": "123456789",
  • "warrantType": {
    }
}

Events

Source: schemas/events/

BookingEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.bookings.booked-in"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Booking Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.bookings.booked-in",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

BookingReleaseEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.bookings.released"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Booking Release Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.bookings.released",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

CaseFiledEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.filings.case-filed"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Case Filed in Court Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.filings.case-filed",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

DocumentReceivedEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.documents.received"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Receive Document from Court Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.documents.received",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

HearingCanceledEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.hearings.canceled"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Hearing Canceled Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.hearings.canceled",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

HearingCompletedEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.hearings.completed"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Hearing Completed Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.hearings.completed",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

HearingRescheduledEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.hearings.rescheduled"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Hearing Rescheduled Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.hearings.rescheduled",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

HearingScheduledEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.hearings.scheduled"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Hearing Scheduled Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.hearings.scheduled",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

PresentenceInvestigationEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.orders.presentence-investigation"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Presentence Investigation Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.orders.presentence-investigation",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

PretrialReleaseOrderEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.orders.pretrial-release"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Pretrial Release Order Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.orders.pretrial-release",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

ProbationSentencingEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.orders.probation-sentencing"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Probation Sentencing Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.orders.probation-sentencing",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

SummonsEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.warrants.summons"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Summons Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.warrants.summons",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

WarrantIssuedEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.warrants.issued"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Warrant Issued Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.warrants.issued",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

WarrantPurgedEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.warrants.purged"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Warrant Purged Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.warrants.purged",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

WarrantQuashedEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.warrants.quashed"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Warrant Quashed Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.warrants.quashed",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

WarrantRecalledEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.warrants.recalled"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Warrant Recalled Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.warrants.recalled",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

WarrantServedEvent

specversion
required
string

The version of the CloudEvents specification which the event uses. Always '1.0'.

Value: "1.0"
type
required
string^gov\.supervision\.[a-z][a-z0-9-]*\.[a-z][a-z...

Describes the type of event. Format: 'gov.supervision.{domain}.{action}' (e.g., 'gov.supervision.hearings.scheduled'). All segments must be lowercase with hyphens allowed.

Value: "gov.supervision.warrants.served"
source
required
string <= 200 characters

Identifies the context in which an event happened. Examples: 'https://court.losangeles.gov/cms', '/systems/court-management', 'urn:justice:system:cms'.

id
required
string <= 100 characters

Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. This is typically a UUID or ULID.

time
string <date-time>

Timestamp of when the occurrence happened (RFC 3339 format). RECOMMENDED for all events.

datacontenttype
string
Default: "application/json"

Content type of the data value. Defaults to 'application/json' if not specified.

dataschema
string <uri> <= 200 characters

Identifies the schema that the 'data' payload adheres to. Must point to the full event schema URI.

subject
string <= 200 characters

Describes the subject of the event in the context of the event producer. Optional field for additional event context.

tenant
required
string <= 100 characters

Multi-tenant identifier. Client MUST provide this field to select which authorized tenant this event is for. API Gateway validates this value against the JWT's authorized tenant list. Returns 403 Forbidden if tenant is not in the authorized list. This is a CloudEvents v1.0 extension attribute (extension attributes go at root level per spec, not in a nested extensions object).

correlationid
string <= 100 characters

Tracing identifier used to correlate events and logs across systems. This value can be used to trace a request or event through the entire processing pipeline for debugging and observability purposes.

required
object (Warrant Served Event Data)

Event payload containing the Justice Assistant event data. Structure is defined by the event-specific schema referenced in dataschema.

{
  • "specversion": "1.0",
  • "type": "gov.supervision.warrants.served",
  • "source": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/json",
  • "dataschema": "http://example.com",
  • "subject": "string",
  • "tenant": "string",
  • "correlationid": "string",
  • "data": {
    }
}

Responses

Source: schemas/responses/

Response

One of
status
required
string
Enum: "success" "error"

Indicates whether the operation succeeded or failed.

Value: "error"
correlationId
required
string

Propagated or generated correlation identifier (ULID) used to trace a logical operation across systems.

timestamp
required
string <date-time>

UTC timestamp when this response was produced.

message
string

Human-readable summary of the response.

data
object

Primary payload. Shape is endpoint-specific.

Array of objects (Response Link)

References to resources created, updated, or touched by this operation. Present on success responses.

required
Array of objects (Response Error) non-empty

One or more errors. Present on error responses.

Example
{
  • "status": "success",
  • "correlationId": "01J9Z8QX3K7VFZC2G5M6T4RN0P",
  • "timestamp": "2026-08-05T14:22:31Z",
  • "data": { },
  • "links": [
    ]
}

ResponseError

code
required
string
Enum: "VALIDATION_ERROR" "NOT_FOUND" "CONFLICT" "AUTHENTICATION_ERROR" "AUTHORIZATION_ERROR" "RATE_LIMITED" "INTERNAL_ERROR" "SERVICE_UNAVAILABLE" "BUSINESS_RULE_ERROR"

Machine-readable error code.

message
required
string

Human-readable explanation of the error.

fields
Array of strings

The field paths that caused the error (dot notation with brackets for arrays).

docs
string <uri>

Link to documentation about this error code.

{
  • "code": "VALIDATION_ERROR",
  • "message": "string",
  • "fields": [
    ],
  • "docs": "http://example.com"
}