Update By Id Using PUT 2

Update By Id Using PUT 2

Update a Gerrit Listener with id

Request
URI
PUT
http://cava-s-182-041.eng.vmware.com//codestream/api/gerrit-listeners/{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

Request Body
GerritListenerSpec2 of type(s) application/json
Optional 
{
    "apiToken": "cKNNVCSHijnaxlrfnVsxUYr6wM2g5Bg11tfnotmWb9XdA5kpUCvI2ubJojTIGp9g",
    "connected": true,
    "description": "string",
    "endpoint": "Gerrit-Endpoint",
    "name": "My-Name",
    "project": "My-Project"
}
string
apiToken
Required

This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.

boolean
connected
Optional

Indicates whether the connection with the Gerrit Server to start receiving events is created or not.

string
description
Required

A human-friendly description.

string
endpoint
Required

The name of the Gerrit Endpoint.

string
name
Required

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

string
project
Optional

The project this entity belongs to.

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with Gerrit Listener Update

Returns GerritListener of type(s) */* 
{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_expiresAt": "2019-09-16 09:25:38.065065+00",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_reason": "Validation Failed due to invalid credentials",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "apiToken": "cKNNVCSHijnaxlrfnVsxUYr6wM2g5Bg11tfnotmWb9XdA5kpUCvI2ubJojTIGp9g",
    "connected": true,
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "endpoint": "Gerrit-Endpoint",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "name": "My-Name",
    "project": "My-Project",
    "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
_expiresAt
Optional

Date when the API token will expire.

string
_link
Optional

Partial URL that provides details of the resource.

string
_reason
Optional

Contains reasons for validation failure.

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
apiToken
Optional

This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.

boolean
connected
Optional

Indicates whether the connection with the Gerrit Server to start receiving events is created or not.

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

string
description
Required

A human-friendly description.

string
endpoint
Optional

The name of the Gerrit Endpoint.

string
id
Optional

The id of this resource.

string
name
Required

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

string
project
Optional

The project this entity belongs to.

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

On This Page
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