Change Requests
Base path: /change-requests
POST /change-requests/CreateChangeRequest
Section titled “POST /change-requests/CreateChangeRequest”Request (CreateChangeRequestRequest)
| Field | Type | Description |
|---|---|---|
type | ChangeRequestType | |
idempotency_key | string? | Safe retry key for button-click retries. |
conflict_behavior | ConflictBehavior? | Default should be RETURN_EXISTING_OPEN. |
Response (CreateChangeRequestResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest | |
reused_existing_open | bool |
POST /change-requests/GetChangeRequest
Section titled “POST /change-requests/GetChangeRequest”Request (GetChangeRequestRequest)
| Field | Type | Description |
|---|---|---|
request_id | string |
Response (GetChangeRequestResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest |
POST /change-requests/ListChangeRequests
Section titled “POST /change-requests/ListChangeRequests”Request (ListChangeRequestsRequest)
| Field | Type | Description |
|---|---|---|
page_size | int32? | Return newest-first. |
page_token | string? | |
type | ChangeRequestType? | |
status | ChangeRequestStatus[] |
Response (ListChangeRequestsResponse)
| Field | Type | Description |
|---|---|---|
requests | ChangeRequest[] | |
next_page_token | string? |
POST /change-requests/ListChangeRequestEvents
Section titled “POST /change-requests/ListChangeRequestEvents”Request (ListChangeRequestEventsRequest)
| Field | Type | Description |
|---|---|---|
request_id | string | |
page_size | int32? | |
page_token | string? |
Response (ListChangeRequestEventsResponse)
| Field | Type | Description |
|---|---|---|
events | ChangeRequestEvent[] | |
next_page_token | string? |
POST /change-requests/ProvideChangeRequestInfo
Section titled “POST /change-requests/ProvideChangeRequestInfo”Request (ProvideChangeRequestInfoRequest)
| Field | Type | Description |
|---|---|---|
request_id | string |
Response (ProvideChangeRequestInfoResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest |
POST /change-requests/CancelChangeRequest
Section titled “POST /change-requests/CancelChangeRequest”Request (CancelChangeRequestRequest)
| Field | Type | Description |
|---|---|---|
request_id | string | |
reason | string? |
Response (CancelChangeRequestResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest |