Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/sarif-external-property-file-2-1-0-rtm-3/_shared/latest--sarif-2.1.0-rtm.3.json
Parent schema sarif-external-property-file-2-1-0-rtm-3
Type: object

Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema: a standard format for the output of static analysis tools.

Properties

version enum required

The SARIF format version of this log file.

Values: "2.1.0"
runs run[] required

The set of runs contained in this log file.

minItems=0
$schema string

The URI of the JSON schema corresponding to the version.

format=uri
inlineExternalProperties externalProperties[]

References to external property files that share data between runs.

minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true

Definitions

address object

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

absoluteAddress integer

The address expressed as a byte offset from the start of the addressable region.

Default: -1
min=-1
relativeAddress integer

The address expressed as a byte offset from the absolute address of the top-most parent object.

length integer

The number of bytes in this range of addresses.

kind string

An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.

name string

A name that is associated with the address, e.g., '.text'.

fullyQualifiedName string

A human-readable fully qualified name that is associated with the address.

offsetFromParent integer

The byte offset of this address from the absolute or relative address of the parent object.

index integer

The index within run.addresses of the cached object for this address.

Default: -1
min=-1
parentIndex integer

The index within run.addresses of the parent object.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
artifact object

A single artifact. In some cases, this artifact might be nested within another artifact.

description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
location object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
parentIndex integer

Identifies the index of the immediate parent of the artifact, if this artifact is nested.

Default: -1
min=-1
offset integer

The offset in bytes of the artifact within its containing artifact.

min=0
length integer

The length of the artifact in bytes.

Default: -1
min=-1
roles enum[]

The role or roles played by the artifact in the analysis.

Default:
[]
minItems=0uniqueItems=true
mimeType string

The MIME type (RFC 2045) of the artifact.

pattern=[^/]+/.+
contents object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
encoding string

Specifies the encoding for an artifact object that refers to a text file.

sourceLanguage string

Specifies the source language for any artifact object that refers to a text file that contains source code.

hashes Record<string, string>

A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.

lastModifiedTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
artifactChange object

A change to a single artifact.

artifactLocation object required

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
replacements replacement[] required

An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.

minItems=1
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
artifactContent object

Represents the contents of an artifact.

text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
artifactLocation object

Specifies the location of an artifact.

uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
attachment object

An artifact relevant to a result.

artifactLocation object required

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
regions region[]

An array of regions of interest within the attachment.

Default:
[]
minItems=0uniqueItems=true
rectangles rectangle[]

An array of rectangles specifying areas of interest within the image.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
codeFlow object

A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.

threadFlows threadFlow[] required

An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

minItems=1
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
configurationOverride object

Information about how a specific rule or notification was reconfigured at runtime.

configuration object required

Information about a rule or notification that can be configured at runtime.

5 nested properties
enabled boolean

Specifies whether the report may be produced during the scan.

Default: true
level enum

Specifies the failure level for the report.

Default: "warning"
Values: "none" "note" "warning" "error"
rank number

Specifies the relative priority of the report. Used for analysis output only.

Default: -1
min=-1max=100
parameters object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
descriptor object required

Information about how to locate a relevant reporting descriptor.

Any of: variant, variant, variant
5 nested properties
id string

The id of the descriptor.

index integer

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

Default: -1
min=-1
guid string

A guid that uniquely identifies the descriptor.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
toolComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
conversion object

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

tool object required

The analysis tool that was run.

3 nested properties
driver object required

A component, such as a plug-in or the driver, of the analysis tool that was run.

28 nested properties
name string required

The name of the tool component.

guid string

A unique identifier for the tool component in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
organization string

The organization or company that produced the tool component.

product string

A product suite to which the tool component belongs.

productSuite string

A localizable string containing the name of the suite of products to which the tool component belongs.

shortDescription object

A message string or message format string rendered in multiple formats.

fullDescription object

A message string or message format string rendered in multiple formats.

fullName string

The name of the tool component along with its version and any other useful identifying information, such as its locale.

version string

The tool component version, in whatever format the component natively provides.

semanticVersion string

The tool component version in the format specified by Semantic Versioning 2.0.

dottedQuadFileVersion string

The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

pattern=[0-9]+(\.[0-9]+){3}
releaseDateUtc string

A string specifying the UTC date (and optionally, the time) of the component's release.

downloadUri string

The absolute URI from which the tool component can be downloaded.

format=uri
informationUri string

The absolute URI at which information about this version of the tool component can be found.

format=uri
globalMessageStrings Record<string, object>

A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

notifications reportingDescriptor[]

An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

Default:
[]
minItems=0uniqueItems=true
locations artifactLocation[]

An array of the artifactLocation objects associated with the tool component.

Default:
[]
minItems=0
language string

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Default: "en-US"
pattern=^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$
contents enum[]

The kinds of data contained in this object.

Default:
[
  "localizedData",
  "nonLocalizedData"
]
uniqueItems=true
isComprehensive boolean

Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

Default: false
localizedDataSemanticVersion string

The semantic version of the localized strings defined in this component; maintained by components that provide translations.

minimumRequiredLocalizedDataSemanticVersion string

The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

associatedComponent object
translationMetadata object

Provides additional metadata related to translation.

supportedTaxonomies toolComponentReference[]

An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

extensions toolComponent[]

Tool extensions that contributed to or reconfigured the analysis tool that was run.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
invocation object

The runtime environment of the analysis tool run.

26 nested properties
executionSuccessful boolean required

Specifies whether the tool's execution completed successfully.

commandLine string

The command line used to invoke the tool.

arguments string[]

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

minItems=0
responseFiles artifactLocation[]

The locations of any response files specified on the tool's command line.

minItems=0uniqueItems=true
startTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
endTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
exitCode integer

The process exit code.

ruleConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe rules related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
notificationConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe notifications related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
toolExecutionNotifications notification[]

A list of runtime conditions detected by the tool during the analysis.

Default:
[]
minItems=0
toolConfigurationNotifications notification[]

A list of conditions detected by the tool that are relevant to the tool's configuration.

Default:
[]
minItems=0
exitCodeDescription string

The reason for the process exit.

exitSignalName string

The name of the signal that caused the process to exit.

exitSignalNumber integer

The numeric value of the signal that caused the process to exit.

processStartFailureMessage string

The reason given by the operating system that the process failed to start.

machine string

The machine that hosted the analysis tool run.

account string

The account that ran the analysis tool.

processId integer

The process id for the analysis tool run.

executableLocation object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

workingDirectory object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

environmentVariables Record<string, string>

The environment variables associated with the analysis tool process, expressed as key/value pairs.

stdin object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

stdout object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

stderr object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

stdoutStderr object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
analysisToolLogFiles artifactLocation[]

The locations of the analysis tool's per-run log files.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
edge object

Represents a directed edge in a graph.

id string required

A string that uniquely identifies the edge within its graph.

sourceNodeId string required

Identifies the source node (the node at which the edge starts).

targetNodeId string required

Identifies the target node (the node at which the edge ends).

label object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
edgeTraversal object

Represents the traversal of a single edge during a graph traversal.

edgeId string required

Identifies the edge being traversed.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
finalState Record<string, object>

The values of relevant expressions after the edge has been traversed.

stepOverEdgeCount integer

The number of edge traversals necessary to return from a nested graph.

min=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
exception object
kind string

A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

message string

A message that describes the exception.

stack object

A call stack that is relevant to a result.

3 nested properties
frames stackFrame[] required

An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=0
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
innerExceptions exception[]

An array of exception objects each of which is considered a cause of this exception.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
externalProperties object
schema string

The URI of the JSON schema corresponding to the version of the external property file format.

format=uri
version enum

The SARIF format version of this external properties object.

Values: "2.1.0"
guid string

A stable, unique identifier for this external properties object, in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
runGuid string

A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
conversion object

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

4 nested properties
tool object required

The analysis tool that was run.

3 nested properties
driver object required

A component, such as a plug-in or the driver, of the analysis tool that was run.

extensions toolComponent[]

Tool extensions that contributed to or reconfigured the analysis tool that was run.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

invocation object

The runtime environment of the analysis tool run.

26 nested properties
executionSuccessful boolean required

Specifies whether the tool's execution completed successfully.

commandLine string

The command line used to invoke the tool.

arguments string[]

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

minItems=0
responseFiles artifactLocation[]

The locations of any response files specified on the tool's command line.

minItems=0uniqueItems=true
startTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
endTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
exitCode integer

The process exit code.

ruleConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe rules related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
notificationConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe notifications related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
toolExecutionNotifications notification[]

A list of runtime conditions detected by the tool during the analysis.

Default:
[]
minItems=0
toolConfigurationNotifications notification[]

A list of conditions detected by the tool that are relevant to the tool's configuration.

Default:
[]
minItems=0
exitCodeDescription string

The reason for the process exit.

exitSignalName string

The name of the signal that caused the process to exit.

exitSignalNumber integer

The numeric value of the signal that caused the process to exit.

processStartFailureMessage string

The reason given by the operating system that the process failed to start.

machine string

The machine that hosted the analysis tool run.

account string

The account that ran the analysis tool.

processId integer

The process id for the analysis tool run.

executableLocation object

Specifies the location of an artifact.

workingDirectory object

Specifies the location of an artifact.

environmentVariables Record<string, string>

The environment variables associated with the analysis tool process, expressed as key/value pairs.

stdin object

Specifies the location of an artifact.

stdout object

Specifies the location of an artifact.

stderr object

Specifies the location of an artifact.

stdoutStderr object

Specifies the location of an artifact.

properties object

Key/value pairs that provide additional information about the object.

analysisToolLogFiles artifactLocation[]

The locations of the analysis tool's per-run log files.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
graphs graph[]

An array of graph objects that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
externalizedProperties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
artifacts artifact[]

An array of artifact objects that will be merged with a separate run.

minItems=0uniqueItems=true
invocations invocation[]

Describes the invocation of the analysis tool that will be merged with a separate run.

Default:
[]
minItems=0
logicalLocations logicalLocation[]

An array of logical locations such as namespaces, types or functions that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
threadFlowLocations threadFlowLocation[]

An array of threadFlowLocation objects that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
results result[]

An array of result objects that will be merged with a separate run.

Default:
[]
minItems=0
taxonomies toolComponent[]

Tool taxonomies that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
driver object

A component, such as a plug-in or the driver, of the analysis tool that was run.

28 nested properties
name string required

The name of the tool component.

guid string

A unique identifier for the tool component in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
organization string

The organization or company that produced the tool component.

product string

A product suite to which the tool component belongs.

productSuite string

A localizable string containing the name of the suite of products to which the tool component belongs.

shortDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

fullDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

fullName string

The name of the tool component along with its version and any other useful identifying information, such as its locale.

version string

The tool component version, in whatever format the component natively provides.

semanticVersion string

The tool component version in the format specified by Semantic Versioning 2.0.

dottedQuadFileVersion string

The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

pattern=[0-9]+(\.[0-9]+){3}
releaseDateUtc string

A string specifying the UTC date (and optionally, the time) of the component's release.

downloadUri string

The absolute URI from which the tool component can be downloaded.

format=uri
informationUri string

The absolute URI at which information about this version of the tool component can be found.

format=uri
globalMessageStrings Record<string, object>

A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

notifications reportingDescriptor[]

An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

Default:
[]
minItems=0uniqueItems=true
locations artifactLocation[]

An array of the artifactLocation objects associated with the tool component.

Default:
[]
minItems=0
language string

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Default: "en-US"
pattern=^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$
contents enum[]

The kinds of data contained in this object.

Default:
[
  "localizedData",
  "nonLocalizedData"
]
uniqueItems=true
isComprehensive boolean

Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

Default: false
localizedDataSemanticVersion string

The semantic version of the localized strings defined in this component; maintained by components that provide translations.

minimumRequiredLocalizedDataSemanticVersion string

The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

associatedComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

translationMetadata object

Provides additional metadata related to translation.

7 nested properties
name string required

The name associated with the translation metadata.

fullName string

The full name associated with the translation metadata.

shortDescription object

A message string or message format string rendered in multiple formats.

fullDescription object

A message string or message format string rendered in multiple formats.

downloadUri string

The absolute URI from which the translation metadata can be downloaded.

format=uri
informationUri string

The absolute URI from which information related to the translation metadata can be downloaded.

format=uri
properties object

Key/value pairs that provide additional information about the object.

supportedTaxonomies toolComponentReference[]

An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
extensions toolComponent[]

Tool extensions that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
policies toolComponent[]

Tool policies that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
translations toolComponent[]

Tool translations that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
addresses address[]

Addresses that will be merged with a separate run.

Default:
[]
minItems=0
webRequests webRequest[]

Requests that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
webResponses webResponse[]

Responses that will be merged with a separate run.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
externalPropertyFileReference object
location object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
guid string

A stable, unique identifier for the external property file in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
itemCount integer

A non-negative integer specifying the number of items contained in the external property file.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
externalPropertyFileReferences object

References to external property files that should be inlined with the content of a root log file.

conversion object
Any of: variant, variant
4 nested properties
location object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

guid string

A stable, unique identifier for the external property file in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
itemCount integer

A non-negative integer specifying the number of items contained in the external property file.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing a run.graphs object to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
externalizedProperties object
Any of: variant, variant
4 nested properties
location object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

guid string

A stable, unique identifier for the external property file in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
itemCount integer

A non-negative integer specifying the number of items contained in the external property file.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.artifacts arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.invocations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.logicalLocations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
threadFlowLocations externalPropertyFileReference[]

An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.results arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.taxonomies arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.addresses arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
driver object
Any of: variant, variant
4 nested properties
location object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

guid string

A stable, unique identifier for the external property file in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
itemCount integer

A non-negative integer specifying the number of items contained in the external property file.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.extensions arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.policies arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.translations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.requests arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.responses arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
fix object

A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.

artifactChanges artifactChange[] required

One or more artifact changes that comprise a fix for a result.

minItems=1uniqueItems=true
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
graph object

A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).

description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
nodes node[]

An array of node objects representing the nodes of the graph.

Default:
[]
minItems=0uniqueItems=true
edges edge[]

An array of edge objects representing the edges of the graph.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
graphTraversal object

Represents a path through a graph.

runGraphIndex integer

The index within the run.graphs to be associated with the result.

Default: -1
min=-1
resultGraphIndex integer

The index within the result.graphs to be associated with the result.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
initialState Record<string, object>

Values of relevant expressions at the start of the graph traversal that may change during graph traversal.

immutableState Record<string, object>

Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.

edgeTraversals edgeTraversal[]

The sequences of edges traversed by this graph traversal.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
invocation object

The runtime environment of the analysis tool run.

executionSuccessful boolean required

Specifies whether the tool's execution completed successfully.

commandLine string

The command line used to invoke the tool.

arguments string[]

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

minItems=0
responseFiles artifactLocation[]

The locations of any response files specified on the tool's command line.

minItems=0uniqueItems=true
startTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
endTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
exitCode integer

The process exit code.

ruleConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe rules related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
notificationConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe notifications related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
toolExecutionNotifications notification[]

A list of runtime conditions detected by the tool during the analysis.

Default:
[]
minItems=0
toolConfigurationNotifications notification[]

A list of conditions detected by the tool that are relevant to the tool's configuration.

Default:
[]
minItems=0
exitCodeDescription string

The reason for the process exit.

exitSignalName string

The name of the signal that caused the process to exit.

exitSignalNumber integer

The numeric value of the signal that caused the process to exit.

processStartFailureMessage string

The reason given by the operating system that the process failed to start.

machine string

The machine that hosted the analysis tool run.

account string

The account that ran the analysis tool.

processId integer

The process id for the analysis tool run.

executableLocation object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
workingDirectory object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
environmentVariables Record<string, string>

The environment variables associated with the analysis tool process, expressed as key/value pairs.

stdin object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
stdout object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
stderr object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
stdoutStderr object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
location object

A location within a programming artifact.

id integer

Value that distinguishes this location from all other locations within a single result object.

Default: -1
min=-1
physicalLocation object

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Any of: variant, variant
5 nested properties
address object

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

10 nested properties
absoluteAddress integer

The address expressed as a byte offset from the start of the addressable region.

Default: -1
min=-1
relativeAddress integer

The address expressed as a byte offset from the absolute address of the top-most parent object.

length integer

The number of bytes in this range of addresses.

kind string

An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.

name string

A name that is associated with the address, e.g., '.text'.

fullyQualifiedName string

A human-readable fully qualified name that is associated with the address.

offsetFromParent integer

The byte offset of this address from the absolute or relative address of the parent object.

index integer

The index within run.addresses of the cached object for this address.

Default: -1
min=-1
parentIndex integer

The index within run.addresses of the parent object.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

artifactLocation object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

region object

A region within an artifact where a result was detected.

12 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the artifact of the first character in the region.

Default: -1
min=-1
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the artifact of the first byte in the region.

Default: -1
min=-1
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents the contents of an artifact.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
sourceLanguage string

Specifies the source language, if any, of the portion of the artifact specified by the region object.

properties object

Key/value pairs that provide additional information about the object.

contextRegion object

A region within an artifact where a result was detected.

12 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the artifact of the first character in the region.

Default: -1
min=-1
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the artifact of the first byte in the region.

Default: -1
min=-1
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents the contents of an artifact.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
sourceLanguage string

Specifies the source language, if any, of the portion of the artifact specified by the region object.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
logicalLocations logicalLocation[]

The logical locations associated with the result.

Default:
[]
minItems=0uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
annotations region[]

A set of regions relevant to the location.

Default:
[]
minItems=0uniqueItems=true
relationships locationRelationship[]

An array of objects that describe relationships between this location and others.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
locationRelationship object

Information about the relation of one location to another.

target integer required

A reference to the related location.

min=0
kinds string[]

A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.

Default:
[
  "relevant"
]
uniqueItems=true
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
logicalLocation object

A logical location of a construct that produced a result.

name string

Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

index integer

The index within the logical locations array.

Default: -1
min=-1
fullyQualifiedName string

The human-readable fully qualified name of the logical location.

decoratedName string

The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

parentIndex integer

Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

Default: -1
min=-1
kind string

The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
multiformatMessageString object

A message string or message format string rendered in multiple formats.

text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
node object

Represents a node in a graph.

id string required

A string that uniquely identifies the node within its graph.

label object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
location object

A location within a programming artifact.

7 nested properties
id integer

Value that distinguishes this location from all other locations within a single result object.

Default: -1
min=-1
physicalLocation object

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Any of: variant, variant
5 nested properties
address object

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

artifactLocation object

Specifies the location of an artifact.

region object

A region within an artifact where a result was detected.

contextRegion object

A region within an artifact where a result was detected.

properties object

Key/value pairs that provide additional information about the object.

logicalLocations logicalLocation[]

The logical locations associated with the result.

Default:
[]
minItems=0uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

annotations region[]

A set of regions relevant to the location.

Default:
[]
minItems=0uniqueItems=true
relationships locationRelationship[]

An array of objects that describe relationships between this location and others.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
children node[]

Array of child nodes.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
notification object

Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

message object required

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
locations location[]

The locations relevant to this notification.

Default:
[]
minItems=0uniqueItems=true
level enum

A value specifying the severity level of the notification.

Default: "warning"
Values: "none" "note" "warning" "error"
threadId integer

The thread identifier of the code that generated the notification.

timeUtc string

The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.

format=date-time
exception object
5 nested properties
kind string

A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

message string

A message that describes the exception.

stack object

A call stack that is relevant to a result.

3 nested properties
frames stackFrame[] required

An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=0
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

innerExceptions exception[]

An array of exception objects each of which is considered a cause of this exception.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
descriptor object

Information about how to locate a relevant reporting descriptor.

Any of: variant, variant, variant
5 nested properties
id string

The id of the descriptor.

index integer

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

Default: -1
min=-1
guid string

A guid that uniquely identifies the descriptor.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
toolComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
associatedRule object

Information about how to locate a relevant reporting descriptor.

Any of: variant, variant, variant
5 nested properties
id string

The id of the descriptor.

index integer

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

Default: -1
min=-1
guid string

A guid that uniquely identifies the descriptor.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
toolComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
physicalLocation object

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

address object

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

10 nested properties
absoluteAddress integer

The address expressed as a byte offset from the start of the addressable region.

Default: -1
min=-1
relativeAddress integer

The address expressed as a byte offset from the absolute address of the top-most parent object.

length integer

The number of bytes in this range of addresses.

kind string

An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.

name string

A name that is associated with the address, e.g., '.text'.

fullyQualifiedName string

A human-readable fully qualified name that is associated with the address.

offsetFromParent integer

The byte offset of this address from the absolute or relative address of the parent object.

index integer

The index within run.addresses of the cached object for this address.

Default: -1
min=-1
parentIndex integer

The index within run.addresses of the parent object.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
artifactLocation object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
region object

A region within an artifact where a result was detected.

12 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the artifact of the first character in the region.

Default: -1
min=-1
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the artifact of the first byte in the region.

Default: -1
min=-1
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

properties object

Key/value pairs that provide additional information about the object.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

sourceLanguage string

Specifies the source language, if any, of the portion of the artifact specified by the region object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
contextRegion object

A region within an artifact where a result was detected.

12 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the artifact of the first character in the region.

Default: -1
min=-1
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the artifact of the first byte in the region.

Default: -1
min=-1
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

properties object

Key/value pairs that provide additional information about the object.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

sourceLanguage string

Specifies the source language, if any, of the portion of the artifact specified by the region object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
propertyBag object

Key/value pairs that provide additional information about the object.

tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
rectangle object

An area within an image.

top number

The Y coordinate of the top edge of the rectangle, measured in the image's natural units.

left number

The X coordinate of the left edge of the rectangle, measured in the image's natural units.

bottom number

The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.

right number

The X coordinate of the right edge of the rectangle, measured in the image's natural units.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
region object

A region within an artifact where a result was detected.

startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the artifact of the first character in the region.

Default: -1
min=-1
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the artifact of the first byte in the region.

Default: -1
min=-1
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
sourceLanguage string

Specifies the source language, if any, of the portion of the artifact specified by the region object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
replacement object

The replacement of a single region of an artifact.

deletedRegion object required

A region within an artifact where a result was detected.

12 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the artifact of the first character in the region.

Default: -1
min=-1
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the artifact of the first byte in the region.

Default: -1
min=-1
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

properties object

Key/value pairs that provide additional information about the object.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

sourceLanguage string

Specifies the source language, if any, of the portion of the artifact specified by the region object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
insertedContent object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
reportingDescriptor object

Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

id string required

A stable, opaque identifier for the report.

deprecatedIds string[]

An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

minItems=0uniqueItems=true
guid string

A unique identifier for the reporting descriptor in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
deprecatedGuids string[]

An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

minItems=0uniqueItems=true
name string

A report identifier that is understandable to an end user.

deprecatedNames string[]

An array of readable identifiers by which this report was known in some previous version of the analysis tool.

minItems=0uniqueItems=true
shortDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
fullDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
messageStrings Record<string, object>

A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

defaultConfiguration object

Information about a rule or notification that can be configured at runtime.

5 nested properties
enabled boolean

Specifies whether the report may be produced during the scan.

Default: true
level enum

Specifies the failure level for the report.

Default: "warning"
Values: "none" "note" "warning" "error"
rank number

Specifies the relative priority of the report. Used for analysis output only.

Default: -1
min=-1max=100
parameters object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
helpUri string

A URI where the primary documentation for the report can be found.

format=uri
help object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true

An array of objects that describe relationships between this reporting descriptor and others.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
reportingConfiguration object

Information about a rule or notification that can be configured at runtime.

enabled boolean

Specifies whether the report may be produced during the scan.

Default: true
level enum

Specifies the failure level for the report.

Default: "warning"
Values: "none" "note" "warning" "error"
rank number

Specifies the relative priority of the report. Used for analysis output only.

Default: -1
min=-1max=100
parameters object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
reportingDescriptorReference object

Information about how to locate a relevant reporting descriptor.

id string

The id of the descriptor.

index integer

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

Default: -1
min=-1
guid string

A guid that uniquely identifies the descriptor.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
toolComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
reportingDescriptorRelationship object

Information about the relation of one reporting descriptor to another.

target object required

Information about how to locate a relevant reporting descriptor.

Any of: variant, variant, variant
5 nested properties
id string

The id of the descriptor.

index integer

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

Default: -1
min=-1
guid string

A guid that uniquely identifies the descriptor.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
toolComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
kinds string[]

A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.

Default:
[
  "relevant"
]
uniqueItems=true
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
result object

A result produced by an analysis tool.

message object required

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
ruleId string

The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.

ruleIndex integer

The index within the tool component rules array of the rule object associated with this result.

Default: -1
min=-1
rule object

Information about how to locate a relevant reporting descriptor.

Any of: variant, variant, variant
5 nested properties
id string

The id of the descriptor.

index integer

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

Default: -1
min=-1
guid string

A guid that uniquely identifies the descriptor.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
toolComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
kind enum

A value that categorizes results by evaluation state.

Default: "fail"
Values: "notApplicable" "pass" "fail" "review" "open" "informational"
level enum

A value specifying the severity level of the result.

Default: "warning"
Values: "none" "note" "warning" "error"
analysisTarget object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
locations location[]

The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

Default:
[]
minItems=0
guid string

A stable, unique identifier for the result in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
correlationGuid string

A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
occurrenceCount integer

A positive integer specifying the number of times this logically unique result was observed in this run.

min=1
partialFingerprints Record<string, string>

A set of strings that contribute to the stable, unique identity of the result.

fingerprints Record<string, string>

A set of strings each of which individually defines a stable, unique identity for the result.

stacks stack[]

An array of 'stack' objects relevant to the result.

Default:
[]
minItems=0uniqueItems=true
codeFlows codeFlow[]

An array of 'codeFlow' objects relevant to the result.

Default:
[]
minItems=0
graphs graph[]

An array of zero or more unique graph objects associated with the result.

Default:
[]
minItems=0uniqueItems=true
graphTraversals graphTraversal[]

An array of one or more unique 'graphTraversal' objects.

Default:
[]
minItems=0uniqueItems=true
relatedLocations location[]

A set of locations relevant to this result.

Default:
[]
minItems=0uniqueItems=true
suppressions suppression[]

A set of suppressions relevant to this result.

minItems=0uniqueItems=true
baselineState enum

The state of a result relative to a baseline of a previous run.

Values: "new" "unchanged" "updated" "absent"
rank number

A number representing the priority or importance of the result.

Default: -1
min=-1max=100
attachments attachment[]

A set of artifacts relevant to the result.

Default:
[]
minItems=0uniqueItems=true
hostedViewerUri string

An absolute URI at which the result can be viewed.

format=uri
workItemUris string[]

The URIs of the work items associated with this result.

minItems=0uniqueItems=true
provenance object

Contains information about how and when a result was detected.

7 nested properties
firstDetectionTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
lastDetectionTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
firstDetectionRunGuid string

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
lastDetectionRunGuid string

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
invocationIndex integer

The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.

Default: -1
min=-1
conversionSources physicalLocation[]

An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
fixes fix[]

An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

Default:
[]
minItems=0uniqueItems=true

An array of references to taxonomy reporting descriptors that are applicable to the result.

Default:
[]
minItems=0uniqueItems=true
webRequest object

A web request object.

9 nested properties
index integer

The index within the run.webRequests array of the request object associated with this result.

Default: -1
min=-1
protocol string

The request protocol. Example: 'http'.

version string

The request version. Example: '1.1'.

target string

The target of the request.

method string

The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.

headers Record<string, string>

The request headers.

parameters Record<string, string>

The request parameters.

body object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
webResponse object

A web response object.

9 nested properties
index integer

The index within the run.webResponses array of the response object associated with this result.

Default: -1
min=-1
protocol string

The response protocol. Example: 'http'.

version string

The response version. Example: '1.1'.

statusCode integer

The response status code. Example: 451.

reasonPhrase string

The response reason. Example: 'Not found'.

headers Record<string, string>

The response headers.

body object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

properties object

Key/value pairs that provide additional information about the object.

noResponseReceived boolean

Specifies whether a response was received from the server.

Default: false
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
resultProvenance object

Contains information about how and when a result was detected.

firstDetectionTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
lastDetectionTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
firstDetectionRunGuid string

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
lastDetectionRunGuid string

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
invocationIndex integer

The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.

Default: -1
min=-1
conversionSources physicalLocation[]

An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
run object

Describes a single run of an analysis tool, and contains the reported output of that run.

tool object required

The analysis tool that was run.

3 nested properties
driver object required

A component, such as a plug-in or the driver, of the analysis tool that was run.

28 nested properties
name string required

The name of the tool component.

guid string

A unique identifier for the tool component in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
organization string

The organization or company that produced the tool component.

product string

A product suite to which the tool component belongs.

productSuite string

A localizable string containing the name of the suite of products to which the tool component belongs.

shortDescription object

A message string or message format string rendered in multiple formats.

fullDescription object

A message string or message format string rendered in multiple formats.

fullName string

The name of the tool component along with its version and any other useful identifying information, such as its locale.

version string

The tool component version, in whatever format the component natively provides.

semanticVersion string

The tool component version in the format specified by Semantic Versioning 2.0.

dottedQuadFileVersion string

The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

pattern=[0-9]+(\.[0-9]+){3}
releaseDateUtc string

A string specifying the UTC date (and optionally, the time) of the component's release.

downloadUri string

The absolute URI from which the tool component can be downloaded.

format=uri
informationUri string

The absolute URI at which information about this version of the tool component can be found.

format=uri
globalMessageStrings Record<string, object>

A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

notifications reportingDescriptor[]

An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

Default:
[]
minItems=0uniqueItems=true
locations artifactLocation[]

An array of the artifactLocation objects associated with the tool component.

Default:
[]
minItems=0
language string

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Default: "en-US"
pattern=^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$
contents enum[]

The kinds of data contained in this object.

Default:
[
  "localizedData",
  "nonLocalizedData"
]
uniqueItems=true
isComprehensive boolean

Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

Default: false
localizedDataSemanticVersion string

The semantic version of the localized strings defined in this component; maintained by components that provide translations.

minimumRequiredLocalizedDataSemanticVersion string

The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

associatedComponent object
translationMetadata object

Provides additional metadata related to translation.

supportedTaxonomies toolComponentReference[]

An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

extensions toolComponent[]

Tool extensions that contributed to or reconfigured the analysis tool that was run.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
invocations invocation[]

Describes the invocation of the analysis tool.

Default:
[]
minItems=0
conversion object

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

4 nested properties
tool object required

The analysis tool that was run.

3 nested properties
driver object required

A component, such as a plug-in or the driver, of the analysis tool that was run.

extensions toolComponent[]

Tool extensions that contributed to or reconfigured the analysis tool that was run.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

invocation object

The runtime environment of the analysis tool run.

26 nested properties
executionSuccessful boolean required

Specifies whether the tool's execution completed successfully.

commandLine string

The command line used to invoke the tool.

arguments string[]

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

minItems=0
responseFiles artifactLocation[]

The locations of any response files specified on the tool's command line.

minItems=0uniqueItems=true
startTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
endTimeUtc string

The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
exitCode integer

The process exit code.

ruleConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe rules related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
notificationConfigurationOverrides configurationOverride[]

An array of configurationOverride objects that describe notifications related runtime overrides.

Default:
[]
minItems=0uniqueItems=true
toolExecutionNotifications notification[]

A list of runtime conditions detected by the tool during the analysis.

Default:
[]
minItems=0
toolConfigurationNotifications notification[]

A list of conditions detected by the tool that are relevant to the tool's configuration.

Default:
[]
minItems=0
exitCodeDescription string

The reason for the process exit.

exitSignalName string

The name of the signal that caused the process to exit.

exitSignalNumber integer

The numeric value of the signal that caused the process to exit.

processStartFailureMessage string

The reason given by the operating system that the process failed to start.

machine string

The machine that hosted the analysis tool run.

account string

The account that ran the analysis tool.

processId integer

The process id for the analysis tool run.

executableLocation object

Specifies the location of an artifact.

workingDirectory object

Specifies the location of an artifact.

environmentVariables Record<string, string>

The environment variables associated with the analysis tool process, expressed as key/value pairs.

stdin object

Specifies the location of an artifact.

stdout object

Specifies the location of an artifact.

stderr object

Specifies the location of an artifact.

stdoutStderr object

Specifies the location of an artifact.

properties object

Key/value pairs that provide additional information about the object.

analysisToolLogFiles artifactLocation[]

The locations of the analysis tool's per-run log files.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
language string

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Default: "en-US"
pattern=^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$
versionControlProvenance versionControlDetails[]

Specifies the revision in version control of the artifacts that were scanned.

Default:
[]
minItems=0uniqueItems=true
originalUriBaseIds Record<string, object>

The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.

artifacts artifact[]

An array of artifact objects relevant to the run.

minItems=0uniqueItems=true
logicalLocations logicalLocation[]

An array of logical locations such as namespaces, types or functions.

Default:
[]
minItems=0uniqueItems=true
graphs graph[]

An array of zero or more unique graph objects associated with the run.

Default:
[]
minItems=0uniqueItems=true
results result[]

The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

minItems=0
automationDetails object

Information that describes a run's identity and role within an engineering system process.

5 nested properties
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

id string

A hierarchical string that uniquely identifies this object's containing run object.

guid string

A stable, unique identifier for this object's containing run object in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
correlationGuid string

A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
runAggregates runAutomationDetails[]

Automation details that describe the aggregate of runs to which this run belongs.

Default:
[]
minItems=0uniqueItems=true
baselineGuid string

The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
redactionTokens string[]

An array of strings used to replace sensitive information in a redaction-aware property.

Default:
[]
minItems=0uniqueItems=true
defaultEncoding string

Specifies the default encoding for any artifact object that refers to a text file.

defaultSourceLanguage string

Specifies the default source language for any artifact object that refers to a text file that contains source code.

newlineSequences string[]

An ordered list of character sequences that were treated as line breaks when computing region information for the run.

Default:
[
  "\r\n",
  "\n"
]
minItems=1uniqueItems=true
columnKind enum

Specifies the unit in which the tool measures columns.

Values: "utf16CodeUnits" "unicodeCodePoints"
externalPropertyFileReferences object

References to external property files that should be inlined with the content of a root log file.

17 nested properties
conversion object
Any of: variant, variant
4 nested properties
location object

Specifies the location of an artifact.

guid string

A stable, unique identifier for the external property file in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
itemCount integer

A non-negative integer specifying the number of items contained in the external property file.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

An array of external property files containing a run.graphs object to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
externalizedProperties object
Any of: variant, variant
4 nested properties
location object

Specifies the location of an artifact.

guid string

A stable, unique identifier for the external property file in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
itemCount integer

A non-negative integer specifying the number of items contained in the external property file.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

An array of external property files containing run.artifacts arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.invocations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.logicalLocations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
threadFlowLocations externalPropertyFileReference[]

An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.results arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.taxonomies arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.addresses arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
driver object
Any of: variant, variant
4 nested properties
location object

Specifies the location of an artifact.

guid string

A stable, unique identifier for the external property file in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
itemCount integer

A non-negative integer specifying the number of items contained in the external property file.

Default: -1
min=-1
properties object

Key/value pairs that provide additional information about the object.

An array of external property files containing run.extensions arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.policies arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.translations arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.requests arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true

An array of external property files containing run.responses arrays to be merged with the root log file.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
threadFlowLocations threadFlowLocation[]

An array of threadFlowLocation objects cached at run level.

Default:
[]
minItems=0uniqueItems=true
taxonomies toolComponent[]

An array of toolComponent objects relevant to a taxonomy in which results are categorized.

Default:
[]
minItems=0uniqueItems=true
addresses address[]

Addresses associated with this run instance, if any.

Default:
[]
minItems=0
translations toolComponent[]

The set of available translations of the localized data provided by the tool.

Default:
[]
minItems=0uniqueItems=true
policies toolComponent[]

Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).

Default:
[]
minItems=0uniqueItems=true
webRequests webRequest[]

An array of request objects cached at run level.

Default:
[]
minItems=0uniqueItems=true
webResponses webResponse[]

An array of response objects cached at run level.

Default:
[]
minItems=0uniqueItems=true
specialLocations object

Defines locations of special significance to SARIF consumers.

2 nested properties
displayBase object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
runAutomationDetails object

Information that describes a run's identity and role within an engineering system process.

description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
id string

A hierarchical string that uniquely identifies this object's containing run object.

guid string

A stable, unique identifier for this object's containing run object in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
correlationGuid string

A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
specialLocations object

Defines locations of special significance to SARIF consumers.

displayBase object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
stack object

A call stack that is relevant to a result.

frames stackFrame[] required

An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=0
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
stackFrame object

A function call within a stack trace.

location object

A location within a programming artifact.

7 nested properties
id integer

Value that distinguishes this location from all other locations within a single result object.

Default: -1
min=-1
physicalLocation object

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Any of: variant, variant
5 nested properties
address object

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

artifactLocation object

Specifies the location of an artifact.

region object

A region within an artifact where a result was detected.

contextRegion object

A region within an artifact where a result was detected.

properties object

Key/value pairs that provide additional information about the object.

logicalLocations logicalLocation[]

The logical locations associated with the result.

Default:
[]
minItems=0uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

annotations region[]

A set of regions relevant to the location.

Default:
[]
minItems=0uniqueItems=true
relationships locationRelationship[]

An array of objects that describe relationships between this location and others.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
module string

The name of the module that contains the code of this stack frame.

threadId integer

The thread identifier of the stack frame.

parameters string[]

The parameters of the call that is executing.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
suppression object

A suppression that is relevant to a result.

kind enum required

A string that indicates where the suppression is persisted.

Values: "inSource" "external"
guid string

A stable, unique identifier for the suppression in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
state enum

A string that indicates the state of the suppression.

Values: "accepted" "underReview" "rejected"
justification string

A string representing the justification for the suppression.

location object

A location within a programming artifact.

7 nested properties
id integer

Value that distinguishes this location from all other locations within a single result object.

Default: -1
min=-1
physicalLocation object

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Any of: variant, variant
5 nested properties
address object

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

artifactLocation object

Specifies the location of an artifact.

region object

A region within an artifact where a result was detected.

contextRegion object

A region within an artifact where a result was detected.

properties object

Key/value pairs that provide additional information about the object.

logicalLocations logicalLocation[]

The logical locations associated with the result.

Default:
[]
minItems=0uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

annotations region[]

A set of regions relevant to the location.

Default:
[]
minItems=0uniqueItems=true
relationships locationRelationship[]

An array of objects that describe relationships between this location and others.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
threadFlow object
locations threadFlowLocation[] required

A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

minItems=1
id string

An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
initialState Record<string, object>

Values of relevant expressions at the start of the thread flow that may change during thread flow execution.

immutableState Record<string, object>

Values of relevant expressions at the start of the thread flow that remain constant.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
threadFlowLocation object

A location visited by an analysis tool while simulating or monitoring the execution of a program.

index integer

The index within the run threadFlowLocations array.

Default: -1
min=-1
location object

A location within a programming artifact.

7 nested properties
id integer

Value that distinguishes this location from all other locations within a single result object.

Default: -1
min=-1
physicalLocation object

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Any of: variant, variant
5 nested properties
address object

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

artifactLocation object

Specifies the location of an artifact.

region object

A region within an artifact where a result was detected.

contextRegion object

A region within an artifact where a result was detected.

properties object

Key/value pairs that provide additional information about the object.

logicalLocations logicalLocation[]

The logical locations associated with the result.

Default:
[]
minItems=0uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

annotations region[]

A set of regions relevant to the location.

Default:
[]
minItems=0uniqueItems=true
relationships locationRelationship[]

An array of objects that describe relationships between this location and others.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
stack object

A call stack that is relevant to a result.

3 nested properties
frames stackFrame[] required

An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=0
message object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
kinds string[]

A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.

Default:
[]
minItems=0uniqueItems=true

An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.

Default:
[]
minItems=0uniqueItems=true
module string

The name of the module that contains the code that is executing.

state Record<string, object>

A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

nestingLevel integer

An integer representing a containment hierarchy within the thread flow.

min=0
executionOrder integer

An integer representing the temporal order in which execution reached this location.

Default: -1
min=-1
executionTimeUtc string

The Coordinated Universal Time (UTC) date and time at which this location was executed.

format=date-time
importance enum

Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

Default: "important"
Values: "important" "essential" "unimportant"
webRequest object

A web request object.

9 nested properties
index integer

The index within the run.webRequests array of the request object associated with this result.

Default: -1
min=-1
protocol string

The request protocol. Example: 'http'.

version string

The request version. Example: '1.1'.

target string

The target of the request.

method string

The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.

headers Record<string, string>

The request headers.

parameters Record<string, string>

The request parameters.

body object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
webResponse object

A web response object.

9 nested properties
index integer

The index within the run.webResponses array of the response object associated with this result.

Default: -1
min=-1
protocol string

The response protocol. Example: 'http'.

version string

The response version. Example: '1.1'.

statusCode integer

The response status code. Example: 451.

reasonPhrase string

The response reason. Example: 'Not found'.

headers Record<string, string>

The response headers.

body object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

properties object

Key/value pairs that provide additional information about the object.

noResponseReceived boolean

Specifies whether a response was received from the server.

Default: false
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
tool object

The analysis tool that was run.

driver object required

A component, such as a plug-in or the driver, of the analysis tool that was run.

28 nested properties
name string required

The name of the tool component.

guid string

A unique identifier for the tool component in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
organization string

The organization or company that produced the tool component.

product string

A product suite to which the tool component belongs.

productSuite string

A localizable string containing the name of the suite of products to which the tool component belongs.

shortDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

fullDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

fullName string

The name of the tool component along with its version and any other useful identifying information, such as its locale.

version string

The tool component version, in whatever format the component natively provides.

semanticVersion string

The tool component version in the format specified by Semantic Versioning 2.0.

dottedQuadFileVersion string

The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

pattern=[0-9]+(\.[0-9]+){3}
releaseDateUtc string

A string specifying the UTC date (and optionally, the time) of the component's release.

downloadUri string

The absolute URI from which the tool component can be downloaded.

format=uri
informationUri string

The absolute URI at which information about this version of the tool component can be found.

format=uri
globalMessageStrings Record<string, object>

A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

notifications reportingDescriptor[]

An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

Default:
[]
minItems=0uniqueItems=true
locations artifactLocation[]

An array of the artifactLocation objects associated with the tool component.

Default:
[]
minItems=0
language string

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Default: "en-US"
pattern=^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$
contents enum[]

The kinds of data contained in this object.

Default:
[
  "localizedData",
  "nonLocalizedData"
]
uniqueItems=true
isComprehensive boolean

Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

Default: false
localizedDataSemanticVersion string

The semantic version of the localized strings defined in this component; maintained by components that provide translations.

minimumRequiredLocalizedDataSemanticVersion string

The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

associatedComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

translationMetadata object

Provides additional metadata related to translation.

7 nested properties
name string required

The name associated with the translation metadata.

fullName string

The full name associated with the translation metadata.

shortDescription object

A message string or message format string rendered in multiple formats.

fullDescription object

A message string or message format string rendered in multiple formats.

downloadUri string

The absolute URI from which the translation metadata can be downloaded.

format=uri
informationUri string

The absolute URI from which information related to the translation metadata can be downloaded.

format=uri
properties object

Key/value pairs that provide additional information about the object.

supportedTaxonomies toolComponentReference[]

An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
extensions toolComponent[]

Tool extensions that contributed to or reconfigured the analysis tool that was run.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
toolComponent object

A component, such as a plug-in or the driver, of the analysis tool that was run.

name string required

The name of the tool component.

guid string

A unique identifier for the tool component in the form of a GUID.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
organization string

The organization or company that produced the tool component.

product string

A product suite to which the tool component belongs.

productSuite string

A localizable string containing the name of the suite of products to which the tool component belongs.

shortDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
fullDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
fullName string

The name of the tool component along with its version and any other useful identifying information, such as its locale.

version string

The tool component version, in whatever format the component natively provides.

semanticVersion string

The tool component version in the format specified by Semantic Versioning 2.0.

dottedQuadFileVersion string

The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

pattern=[0-9]+(\.[0-9]+){3}
releaseDateUtc string

A string specifying the UTC date (and optionally, the time) of the component's release.

downloadUri string

The absolute URI from which the tool component can be downloaded.

format=uri
informationUri string

The absolute URI at which information about this version of the tool component can be found.

format=uri
globalMessageStrings Record<string, object>

A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

notifications reportingDescriptor[]

An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

Default:
[]
minItems=0uniqueItems=true

An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

Default:
[]
minItems=0uniqueItems=true
locations artifactLocation[]

An array of the artifactLocation objects associated with the tool component.

Default:
[]
minItems=0
language string

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Default: "en-US"
pattern=^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$
contents enum[]

The kinds of data contained in this object.

Default:
[
  "localizedData",
  "nonLocalizedData"
]
uniqueItems=true
isComprehensive boolean

Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

Default: false
localizedDataSemanticVersion string

The semantic version of the localized strings defined in this component; maintained by components that provide translations.

minimumRequiredLocalizedDataSemanticVersion string

The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

associatedComponent object
4 nested properties
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
translationMetadata object

Provides additional metadata related to translation.

7 nested properties
name string required

The name associated with the translation metadata.

fullName string

The full name associated with the translation metadata.

shortDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

fullDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

downloadUri string

The absolute URI from which the translation metadata can be downloaded.

format=uri
informationUri string

The absolute URI from which information related to the translation metadata can be downloaded.

format=uri
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
supportedTaxonomies toolComponentReference[]

An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
toolComponentReference object
name string

The 'name' property of the referenced toolComponent.

index integer

An index into the referenced toolComponent in tool.extensions.

Default: -1
min=-1
guid string

The 'guid' property of the referenced toolComponent.

pattern=^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
translationMetadata object

Provides additional metadata related to translation.

name string required

The name associated with the translation metadata.

fullName string

The full name associated with the translation metadata.

shortDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
fullDescription object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
downloadUri string

The absolute URI from which the translation metadata can be downloaded.

format=uri
informationUri string

The absolute URI from which information related to the translation metadata can be downloaded.

format=uri
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
versionControlDetails object

Specifies the information necessary to retrieve a desired revision from a version control system.

repositoryUri string required

The absolute URI of the repository.

format=uri
revisionId string

A string that uniquely and permanently identifies the revision within the repository.

branch string

The name of a branch containing the revision.

revisionTag string

A tag that has been applied to the revision.

asOfTimeUtc string

A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.

format=date-time
mappedTo object

Specifies the location of an artifact.

5 nested properties
uri string

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

index integer

The index within the run artifacts array of the artifact object associated with the artifact location.

Default: -1
min=-1
description object

Encapsulates a message intended to be read by the end user.

Any of: variant, variant
5 nested properties
text string

A plain text message string.

markdown string

A Markdown message string.

id string

The identifier for this message.

arguments string[]

An array of strings to substitute into the message string.

Default:
[]
minItems=0
properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
webRequest object

A web request object.

index integer

The index within the run.webRequests array of the request object associated with this result.

Default: -1
min=-1
protocol string

The request protocol. Example: 'http'.

version string

The request version. Example: '1.1'.

target string

The target of the request.

method string

The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.

headers Record<string, string>

The request headers.

parameters Record<string, string>

The request parameters.

body object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
webResponse object

A web response object.

index integer

The index within the run.webResponses array of the response object associated with this result.

Default: -1
min=-1
protocol string

The response protocol. Example: 'http'.

version string

The response version. Example: '1.1'.

statusCode integer

The response status code. Example: 451.

reasonPhrase string

The response reason. Example: 'Not found'.

headers Record<string, string>

The response headers.

body object

Represents the contents of an artifact.

4 nested properties
text string

UTF-8-encoded content from a text artifact.

binary string

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

rendered object

A message string or message format string rendered in multiple formats.

3 nested properties
text string required

A plain text message string or format string.

markdown string

A Markdown message string or format string.

properties object

Key/value pairs that provide additional information about the object.

properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true
noResponseReceived boolean

Specifies whether a response was received from the server.

Default: false
properties object

Key/value pairs that provide additional information about the object.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
minItems=0uniqueItems=true