Skip to content

Error ​

Status: Pending

Breadcrumb: sarif:Result > Error

Representation of an Error.

Parent types ​

sarif:Result, InstantaneousEvent

Properties ​

Properties for Error ​

PropertyExpected typeDefined onDescription
errorCodeDefinedTerm, Integer, StatusEnumeration, TextErrorApplication or platform dependant error code.

Inherited properties ​

PropertyExpected typeInherited fromDescription
additionalTypeText, URLThingAn additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
alternateNameTextThingAn alias for the item.
dataThingInstantaneousEventData associated with the event, like for instance a log message.
descriptionText, TextObjectThingA description of the item.
disambiguatingDescriptionTextThingA sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifierPropertyValue, Text, URLThingThe identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
imageImageObject, URLThingAn image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPageCreativeWork, URLThingIndicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
nameTextThingThe name of the item.
ownerOrganization, PersonThingA person or organization who owns this Thing.
potentialActionActionThingIndicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAsURLThingURL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
sourceThingInstantaneousEventThe source or cause of the event.
subjectOfCreativeWork, EventThingA CreativeWork or Event about this Thing.
timestampDateTimeInstantaneousEventThe instant the event occured.
urlURLThingURL of the item.

Example ​

json
{
  "@context": "https://schema.org",
  "@type": "Error",
  "name": "Example Name",
  "description": "A short description.",
  "url": "/example",
  "errorCode": "Example value"
}