Get Event By ID Using GET

Get Event By ID Using GET

Get a gerrit Event based on id

Request
URI
GET
http://cava-s-182-041.eng.vmware.com//codestream/api/gerrit-events/{id}
COPY
Path Parameters
string
id
Required

id

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about


Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with gerrit Event

Returns GerritEvent of type(s) */*
{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "actionTaken": "Verified +1",
    "branch": "master",
    "changeNumber": 18823,
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "createdOn": "2019-09-18T07:38:25.907+0000",
    "description": "string",
    "executionIndex": 1,
    "executionLink": "/codestream/api/executions/08c20cb8-17b6-4d9c-9f15-c77cf4913bc5",
    "executionStatus": "STARTED",
    "gerritProject": "TestGerritProject",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "listener": "Demo-Listener",
    "message": "Execution Completed",
    "name": "My-Name",
    "owner": "Dummy User",
    "patchSetNumber": 32,
    "pipeline": "DemoPipeline",
    "project": "My-Project",
    "properties": {
        "GERRIT_BRANCH": "master",
        "GERRIT_EVENT_CREATED_ON": "1568792304",
        "GERRIT_PATCHSET_REVISION": "8a3edf15d36d0fe8026ffefbd58bafdb77b4ab80",
        "GERRIT_HOST": "gerrit.eng.vmware.com",
        "GERRIT_CHANGE_OWNER_EMAIL": "[email protected]",
        "GERRIT_EVENT_ACCOUNT_NAME": "Demo User",
        "GERRIT_CHANGE_URL": "https://gerrit.eng.vmware.com/18868",
        "GERRIT_PATCHSET_UPLOADER_EMAIL": "[email protected]",
        "GERRIT_EVENT_TYPE": "patchset-created",
        "GERRIT_PROJECT": "TestProjectForCodestream",
        "GERRIT_PATCHSET_UPLOADER_USERNAME": "demouser",
        "GERRIT_CHANGE_FILELIST": "[/COMMIT_MSG, file.txt]",
        "GERRIT_CHANGE_NUMBER": "18868",
        "GERRIT_SCHEME": "ssh",
        "GERRIT_PATCHSET_UPLOADER": "Demo User [email protected]",
        "GERRIT_URL": "http://gerrit.eng.vmware.com:8080",
        "GERRIT_PORT": "29418",
        "GERRIT_REFSPEC": "refs/changes/68/18868/32",
        "GERRIT_PATCHSET_UPLOADER_NAME": "Demo User",
        "GERRIT_CHANGE_OWNER": "Demo User \n [email protected]",
        "GERRIT_CHANGE_COMMIT_MESSAGE": "1sdfsf\n\nChange-Id: I522eab3b678dedd68dad3e2c04d3cccc0eb9fa00\n",
        "GERRIT_NAME": "gerrit-listener",
        "GERRIT_TOPIC": "branch",
        "GERRIT_CHANGE_SUBJECT": "1sdfsf",
        "GERRIT_EVENT_ACCOUNT_USERNAME": "demouser",
        "GERRIT_CHANGE_OWNER_USERNAME": "demouser",
        "GERRIT_EVENT_ACCOUNT": "Demo User \n [email protected]",
        "GERRIT_CHANGE_ID": "I522eab3b678dedd68dad3e2c04d3cccc0eb9fa00",
        "GERRIT_VERSION": "Not supported",
        "GERRIT_EVENT_ACCOUNT_EMAIL": "[email protected]",
        "GERRIT_PATCHSET_NUMBER": "32",
        "GERRIT_CHANGE_OWNER_NAME": "Demo User"
    },
    "subject": "Demo Commit Message",
    "trigger": "Demo-Trigger",
    "triggerType": "AUTOMATIC",
    "type": "patchset-created",
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1"
}
integer As int64 As int64
_createTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string
_createdBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

string
_link
Optional

Partial URL that provides details of the resource.

integer As int64 As int64
_updateTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds

string
_updatedBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field

string
actionTaken
Optional

Verified Label value along with the action posted to the gerrit server.

string
branch
Optional

Gerrit Project branch on which the change has happened.

integer As int64 As int64
changeNumber
Optional

Gerrit ChangeSet Number provided by Gerrit Server in the event.

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string
createdBy
Optional

The user that created this entity

integer As int64 As int64
createdOn
Optional

Date and time on which this event is created.

string
description
Required

A human-friendly description.

integer As int64 As int64
executionIndex
Optional

Index of the Execution.

string
executionLink
Optional

Link of the execution.

string
executionStatus
Optional

Indicates the current status of the Execution.

string
gerritProject
Optional

Gerrit Project on which the change has happened.

string
id
Optional

The id of this resource.

string
listener
Optional

Name of the Gerrit Listener which contains details of the Gerrit Server which has sent this event.

string
message
Optional

This includes detailed message regarding state of the execution.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

string
owner
Optional

Name and Email details of ChangeSet Owner.

integer As int64 As int64
patchSetNumber
Optional

Patch number of the ChangeSet provided by Gerrit Server in the event.

string
pipeline
Optional

Name of the pipeline which got triggered.

string
project
Optional

The project this entity belongs to.

object
properties
Optional

Map containing all ChangeSet related details.

string
subject
Optional

Contains the commit message.

string
trigger
Optional

Name of the Gerrit Trigger which contains the configuration leading to this event.

string
triggerType
Optional

Indicates whether it was a manual trigger or not.

string
type
Optional

Type of the gerrit event.

string
updatedAt
Optional

Date when the entity was last updated. The date is in ISO 8601 with time zone.

string
updatedBy
Optional

The user that last updated this entity

string
version
Optional

Version of the resource.


401

Unauthorized Request

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Server Error

Operation doesn't return any data structure

Triggers Operations
POST
Clone Listener Using POST
POST
Clone Trigger Using POST
POST
Create Docker Registry Webhook Using POST
POST
Create Gerrit Listener Using POST
POST
Create Git Webhook Using POST
POST
Create Using POST 2
DELETE
Delete By Id Using DELETE
DELETE
Delete By Id Using DELETE 1
DELETE
Delete By Name Using DELETE
DELETE
Delete By Name Using DELETE 1
DELETE
Delete By Name Using DELETE 2
DELETE
Delete By Name Using DELETE 3
DELETE
Delete Using DELETE
DELETE
Delete Using DELETE 4
DELETE
Delete Using DELETE 5
DELETE
Delete Using DELETE 6
DELETE
Delete Using DELETE 7
GET
Get All Docker Events Using GET
GET
Get All Docker Registry Webhooks Using GET
GET
Get All Events Using GET
GET
Get All Gerrit Listeners Using GET
GET
Get All Git Events Using GET
GET
Get All Git Webhooks Using GET
GET
Get All Using GET 2
GET
Get Docker Event By ID Using GET
GET
Get Docker Registry Webhook By ID Using GET
GET
Get Docker Registry Webhook By Name Using GET
GET
Get Event By ID Using GET
GET
Get Gerrit Listener By ID Using GET
GET
Get Gerrit Listener By Name Using GET
GET
Get Gerrit Projects Using GET
GET
Get Gerrit Projects Using GET 1
GET
Get Git Event By ID Using GET
GET
Get Git Webhook By ID Using GET
GET
Get Git Webhook By Name Using GET
GET
Get Trigger By Name Using GET
GET
Get Trigger Using GET
POST
Manual Trigger Using POST
PATCH
Patch By Id Using PATCH
PATCH
Patch By Id Using PATCH 1
PATCH
Patch By Id Using PATCH 2
PATCH
Patch By Name Using PATCH
PATCH
Patch By Name Using PATCH 1
PATCH
Patch By Name Using PATCH 2
POST
Resume Or Rerun Event Using POST
POST
Resume Or Rerun Event Using POST 1
POST
Resume Or Rerun Event Using POST 2
PUT
Update By Id Using PUT 2
PUT
Update By Id Using PUT 3
PUT
Update By Name Using PUT
PUT
Update By Name Using PUT 2
PUT
Update By Name Using PUT 3
PUT
Update By Name Using PUT 4
PUT
Update Using PUT
PUT
Update Using PUT 1
POST
Validate Gerrit Listener Using POST