Some commands produce JSON data streams intended for other applications to consume. The structures are documented below. Note that any field may be missing in the JSON messages, so consumers of this JSON stream should deal with that appropriately.

change

The Gerrit change being reviewed, or that was already reviewed.

project

Project path in Gerrit.

branch

Branch name within project.

topic

Topic name specified by the uploader for this change series.

id

Change identifier, as scraped out of the Change-Id field in the commit message, or as assigned by the server if it was missing.

number

Change number (deprecated).

subject

Description of change.

owner

Owner in account attribute.

url

Canonical URL to reach this change.

commitMessage

The full commit message for the change.

lastUpdated

Time in seconds since the UNIX epoch when this change was last updated.

sortKey

Internal key used to sort changes, based on lastUpdated.

open

Boolean indicating if the change is still open for review.

status

Current state of this change.

NEW

Change is still being reviewed.

SUBMITTED

Change has been submitted and is in the merge queue. It may be waiting for one or more dependencies.

MERGED

Change has been merged to its branch.

ABANDONED

Change was abandoned by its owner or administrator.

trackingIds

Issue tracking system links in trackingid attribute, scraped out of the commit message based on the server’s trackingid sections.

currentPatchSet

Current patchSet attribute.

patchSets

All patchSet attribute for this change.

submitRecords

The submitRecord attribute contains information about whether this change has been or can be submitted.

trackingid

A link to an issue tracking system.

system

Name of the system. This comes straight from the gerrit.config file.

id

Id number as scraped out of the commit message.

account

A user account.

name

User’s full name, if configured.

email

User’s preferred email address.

username

User’s username, if configured.

patchSet

Refers to a specific patchset within a change.

number

The patchset number.

revision

Git commit for this patchset.

ref

Git reference pointing at the revision. This reference is available through the Gerrit Code Review server’s Git interface for the containing change.

uploader

Uploader of the patch set in account attribute.

approvals

The approval attribute granted.

approval

Records the code review approval granted to a patch set.

type

Internal name of the approval given.

description

Human readable category of the approval.

value

Value assigned by the approval, usually a numerical score.

grantedOn

Time in seconds since the UNIX epoch when this approval was added or last updated.

by

Reviewer of the patch set in account attribute.

refUpdate

Information about a ref that was updated.

oldRev

The old value of the ref, prior to the update.

newRev

The new value the ref was updated to.

project

Project path in Gerrit.

refName

Ref name within project.

queryLimit

Information about the queryLimit of a user.

min

lower limit

max

upper limit

submitRecord

Information about the submit status of a change.

status

Current submit status.

OK

The change is ready for submission or already submitted.

NOT_READY

The change is missing a required label.

RULE_ERROR

An internal server error occurred preventing computation.

labels

This describes the state of each code review label attribute, unless the status is RULE_ERROR.

label

Information about a code review label for a change.

label

The name of the label.

status

The status of the label.

OK

This label provides what is necessary for submission.

REJECT

This label prevents the change from being submitted.

NEED

The label is required for submission, but has not been satisfied.

MAY

The label may be set, but it’s neither necessary for submission nor does it block submission if set.

IMPOSSIBLE

The label is required for submission, but is impossible to complete. The likely cause is access has not been granted correctly by the project owner or site administrator.

by

The account that applied the label.

SEE ALSO

Part of Gerrit Code Review