Update a change request decision
ADVERTENCIANote: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
PATCH
https://api.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.us3.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.us5.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.datadoghq.eu/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.ap1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.ap2.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.uk1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.us2.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}Descripción general
Update a decision on a change request, such as approving or declining it.
OAuth apps require the cases_write authorization scope to access this endpoint.
Argumentos
Parámetros de ruta
Nombre
Type
Descripción
change_request_id [required]string
The identifier of the change request.
decision_id [required]string
The identifier of the change request decision.
Solicitud
Body Data (required)
Decision update payload.
Campo
Type
Descripción
data [required]object
Data object to update a change request decision.
attributesobject
Attributes of the parent change request for a decision update.
idstring
The identifier of the change request.
relationshipsobject
Relationships for updating a change request decision.
change_request_decisions [required]object
Relationship to change request decisions.
data [required][object]
Array of decision relationship data.
id [required]string
The decision UUID.
type [required]enum
Change request decision resource type.
Allowed enum values:
change_request_decisiontype [required]enum
Change request resource type.
Allowed enum values:
change_requestincluded[object]
Included resources for the change request update.
attributesobject
Attributes for creating a change request decision.
change_request_statusenum
The status of a change request decision.
Allowed enum values:
REQUESTED, APPROVED, DECLINEDrequest_reasonstring
The reason for requesting the decision.
id [required]string
The decision identifier.
relationshipsobject
Relationships for creating a change request decision.
requested_userobject
Relationship to a user.
data [required]object
User relationship data.
id [required]string
The user UUID.
type [required]string
The user resource type.
type [required]enum
Change request decision resource type.
Allowed enum values:
change_request_decision{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"relationships": {
"requested_user": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
}
},
"type": "change_request_decision"
}
]
}Respuesta
OK
Response object for a change request.
Campo
Type
Descripción
data [required]object
Data object for a change request response.
attributes [required]object
Attributes of a change request response.
archived_atdate-time
Timestamp of when the change request was archived.
attributes [required]object
Custom attributes of the change request as key-value pairs.
<any-key>[string]
change_request_linked_incident_uuid [required]string
The UUID of the linked incident.
change_request_maintenance_window_query [required]string
The maintenance window query for the change request.
change_request_plan [required]string
The plan associated with the change request.
change_request_risk [required]enum
The risk level of the change request.
Allowed enum values:
UNDEFINED, LOW, MEDIUM, HIGHchange_request_type [required]enum
The type of the change request.
Allowed enum values:
NORMAL, STANDARD, EMERGENCYclosed_atdate-time
Timestamp of when the change request was closed.
created_at [required]date-time
Timestamp of when the change request was created.
creation_source [required]string
The source from which the change request was created.
description [required]string
The description of the change request.
end_datedate-time
The planned end date of the change request.
key [required]string
The human-readable key of the change request.
modified_at [required]date-time
Timestamp of when the change request was last modified.
plan_notebook_id [required]int64
The notebook ID associated with the change request plan.
priority [required]string
The priority of the change request.
project_id [required]string
The project UUID associated with the change request.
start_datedate-time
The planned start date of the change request.
status [required]string
The current status of the change request.
title [required]string
The title of the change request.
type [required]string
The case type.
id [required]string
The identifier of the change request.
relationshipsobject
Relationships of a change request.
change_request_decisions [required]object
Relationship to change request decisions.
data [required][object]
Array of decision relationship data.
id [required]string
The decision UUID.
type [required]enum
Change request decision resource type.
Allowed enum values:
change_request_decisioncreated_by [required]object
Relationship to a user.
data [required]object
User relationship data.
id [required]string
The user UUID.
type [required]string
The user resource type.
modified_by [required]object
Relationship to a user.
data [required]object
User relationship data.
id [required]string
The user UUID.
type [required]string
The user resource type.
type [required]enum
Change request resource type.
Allowed enum values:
change_requestincluded[<oneOf>]
Included resources related to the change request.
Object 1object
An included user resource.
attributes [required]object
Attributes of an included user.
email [required]string
The email of the user.
handle [required]string
The handle of the user.
name [required]string
The name of the user.
id [required]string
The user UUID.
type [required]string
The resource type.
Object 2object
An included change request decision resource.
attributes [required]object
Attributes of a change request decision in a response.
change_request_status [required]enum
The status of a change request decision.
Allowed enum values:
REQUESTED, APPROVED, DECLINEDdecided_at [required]date-time
Timestamp of when the decision was made.
decision_reason [required]string
The reason for the decision.
deleted_at [required]date-time
Timestamp of when the decision was deleted.
request_reason [required]string
The reason for requesting the decision.
requested_at [required]date-time
Timestamp of when the decision was requested.
id [required]string
The decision UUID.
relationshipsobject
Relationships of a change request decision.
modified_by [required]object
Relationship to a user.
data [required]object
User relationship data.
id [required]string
The user UUID.
type [required]string
The user resource type.
requested_by_user [required]object
Relationship to a user.
data [required]object
User relationship data.
id [required]string
The user UUID.
type [required]string
The user resource type.
requested_user [required]object
Relationship to a user.
data [required]object
User relationship data.
id [required]string
The user UUID.
type [required]string
The user resource type.
type [required]enum
Change request decision resource type.
Allowed enum values:
change_request_decision{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"attributes": {
"<any-key>": []
},
"change_request_linked_incident_uuid": "",
"change_request_maintenance_window_query": "",
"change_request_plan": "",
"change_request_risk": "LOW",
"change_request_type": "NORMAL",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2024-01-01T00:00:00Z",
"creation_source": "CS_MANUAL",
"description": "Deploying new payment service v2.1",
"end_date": "2024-01-02T15:00:00Z",
"key": "CHM-1234",
"modified_at": "2024-01-01T00:00:00Z",
"plan_notebook_id": 0,
"priority": "NOT_DEFINED",
"project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
"start_date": "2024-01-01T03:00:00Z",
"status": "OPEN",
"title": "Deploy new payment service",
"type": "CHANGE_REQUEST"
},
"id": "CHM-1234",
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0",
"type": "change_request_decision"
}
]
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"email": "john.doe@example.com",
"handle": "john.doe@example.com",
"name": "John Doe"
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
]
}Bad Request
API error response.
Campo
Type
Descripción
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
Campo
Type
Descripción
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Ejemplo de código
Update a change request decision
# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOF# Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"id": "CHM-1234"
},
"relationships": {
"change_request_decisions": {
"data": [
{
"id": "decision-id-0"
}
]
}
},
"type": "change_request"
},
"included": [
{
"attributes": {
"change_request_status": "REQUESTED",
"request_reason": "Please review and approve this change"
},
"id": "decision-id-0",
"type": "change_request_decision"
}
]
}
EOFUpdate a change request decision
// Update a change request decision returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.ChangeRequestDecisionUpdateRequest{
Data: datadogV2.ChangeRequestDecisionUpdateData{
Attributes: &datadogV2.ChangeRequestDecisionUpdateDataAttributes{
Id: datadog.PtrString("CHM-1234"),
},
Relationships: &datadogV2.ChangeRequestDecisionUpdateDataRelationships{
ChangeRequestDecisions: datadogV2.ChangeRequestDecisionsRelationship{
Data: []datadogV2.ChangeRequestDecisionRelationshipData{
{
Id: "decision-id-0",
Type: datadogV2.CHANGEREQUESTDECISIONRESOURCETYPE_CHANGE_REQUEST_DECISION,
},
},
},
},
Type: datadogV2.CHANGEREQUESTRESOURCETYPE_CHANGE_REQUEST,
},
Included: []datadogV2.ChangeRequestDecisionCreateItem{
{
Attributes: &datadogV2.ChangeRequestDecisionCreateAttributes{
ChangeRequestStatus: datadogV2.CHANGEREQUESTDECISIONSTATUSTYPE_REQUESTED.Ptr(),
RequestReason: datadog.PtrString("Please review and approve this change"),
},
Id: "decision-id-0",
Relationships: &datadogV2.ChangeRequestDecisionCreateRelationships{
RequestedUser: &datadogV2.ChangeRequestUserRelationship{
Data: *datadogV2.NewNullableChangeRequestUserRelationshipData(&datadogV2.ChangeRequestUserRelationshipData{
Id: "00000000-0000-0000-0000-000000000000",
Type: "user",
}),
},
},
Type: datadogV2.CHANGEREQUESTDECISIONRESOURCETYPE_CHANGE_REQUEST_DECISION,
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.UpdateChangeRequestDecision", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewChangeManagementApi(apiClient)
resp, r, err := api.UpdateChangeRequestDecision(ctx, "change_request_id", "decision_id", body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ChangeManagementApi.UpdateChangeRequestDecision`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `ChangeManagementApi.UpdateChangeRequestDecision`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Update a change request decision
// Update a change request decision returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ChangeManagementApi;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateAttributes;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateItem;
import com.datadog.api.client.v2.model.ChangeRequestDecisionCreateRelationships;
import com.datadog.api.client.v2.model.ChangeRequestDecisionRelationshipData;
import com.datadog.api.client.v2.model.ChangeRequestDecisionResourceType;
import com.datadog.api.client.v2.model.ChangeRequestDecisionStatusType;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateData;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateDataAttributes;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateDataRelationships;
import com.datadog.api.client.v2.model.ChangeRequestDecisionUpdateRequest;
import com.datadog.api.client.v2.model.ChangeRequestDecisionsRelationship;
import com.datadog.api.client.v2.model.ChangeRequestResourceType;
import com.datadog.api.client.v2.model.ChangeRequestResponse;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationship;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationshipData;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.updateChangeRequestDecision", true);
ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);
ChangeRequestDecisionUpdateRequest body =
new ChangeRequestDecisionUpdateRequest()
.data(
new ChangeRequestDecisionUpdateData()
.attributes(new ChangeRequestDecisionUpdateDataAttributes().id("CHM-1234"))
.relationships(
new ChangeRequestDecisionUpdateDataRelationships()
.changeRequestDecisions(
new ChangeRequestDecisionsRelationship()
.data(
Collections.singletonList(
new ChangeRequestDecisionRelationshipData()
.id("decision-id-0")
.type(
ChangeRequestDecisionResourceType
.CHANGE_REQUEST_DECISION)))))
.type(ChangeRequestResourceType.CHANGE_REQUEST))
.included(
Collections.singletonList(
new ChangeRequestDecisionCreateItem()
.attributes(
new ChangeRequestDecisionCreateAttributes()
.changeRequestStatus(ChangeRequestDecisionStatusType.REQUESTED)
.requestReason("Please review and approve this change"))
.id("decision-id-0")
.relationships(
new ChangeRequestDecisionCreateRelationships()
.requestedUser(
new ChangeRequestUserRelationship()
.data(
new ChangeRequestUserRelationshipData()
.id("00000000-0000-0000-0000-000000000000")
.type("user"))))
.type(ChangeRequestDecisionResourceType.CHANGE_REQUEST_DECISION)));
try {
ChangeRequestResponse result =
apiInstance.updateChangeRequestDecision("CHM-1234", "decision-id-0", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChangeManagementApi#updateChangeRequestDecision");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Update a change request decision
"""
Update a change request decision returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.change_management_api import ChangeManagementApi
from datadog_api_client.v2.model.change_request_decision_create_attributes import ChangeRequestDecisionCreateAttributes
from datadog_api_client.v2.model.change_request_decision_create_item import ChangeRequestDecisionCreateItem
from datadog_api_client.v2.model.change_request_decision_create_relationships import (
ChangeRequestDecisionCreateRelationships,
)
from datadog_api_client.v2.model.change_request_decision_relationship_data import ChangeRequestDecisionRelationshipData
from datadog_api_client.v2.model.change_request_decision_resource_type import ChangeRequestDecisionResourceType
from datadog_api_client.v2.model.change_request_decision_status_type import ChangeRequestDecisionStatusType
from datadog_api_client.v2.model.change_request_decision_update_data import ChangeRequestDecisionUpdateData
from datadog_api_client.v2.model.change_request_decision_update_data_attributes import (
ChangeRequestDecisionUpdateDataAttributes,
)
from datadog_api_client.v2.model.change_request_decision_update_data_relationships import (
ChangeRequestDecisionUpdateDataRelationships,
)
from datadog_api_client.v2.model.change_request_decision_update_request import ChangeRequestDecisionUpdateRequest
from datadog_api_client.v2.model.change_request_decisions_relationship import ChangeRequestDecisionsRelationship
from datadog_api_client.v2.model.change_request_resource_type import ChangeRequestResourceType
from datadog_api_client.v2.model.change_request_user_relationship import ChangeRequestUserRelationship
from datadog_api_client.v2.model.change_request_user_relationship_data import ChangeRequestUserRelationshipData
body = ChangeRequestDecisionUpdateRequest(
data=ChangeRequestDecisionUpdateData(
attributes=ChangeRequestDecisionUpdateDataAttributes(
id="CHM-1234",
),
relationships=ChangeRequestDecisionUpdateDataRelationships(
change_request_decisions=ChangeRequestDecisionsRelationship(
data=[
ChangeRequestDecisionRelationshipData(
id="decision-id-0",
type=ChangeRequestDecisionResourceType.CHANGE_REQUEST_DECISION,
),
],
),
),
type=ChangeRequestResourceType.CHANGE_REQUEST,
),
included=[
ChangeRequestDecisionCreateItem(
attributes=ChangeRequestDecisionCreateAttributes(
change_request_status=ChangeRequestDecisionStatusType.REQUESTED,
request_reason="Please review and approve this change",
),
id="decision-id-0",
relationships=ChangeRequestDecisionCreateRelationships(
requested_user=ChangeRequestUserRelationship(
data=ChangeRequestUserRelationshipData(
id="00000000-0000-0000-0000-000000000000",
type="user",
),
),
),
type=ChangeRequestDecisionResourceType.CHANGE_REQUEST_DECISION,
),
],
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["update_change_request_decision"] = True
with ApiClient(configuration) as api_client:
api_instance = ChangeManagementApi(api_client)
response = api_instance.update_change_request_decision(
change_request_id="change_request_id", decision_id="decision_id", body=body
)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Update a change request decision
# Update a change request decision returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.update_change_request_decision".to_sym] = true
end
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new
body = DatadogAPIClient::V2::ChangeRequestDecisionUpdateRequest.new({
data: DatadogAPIClient::V2::ChangeRequestDecisionUpdateData.new({
attributes: DatadogAPIClient::V2::ChangeRequestDecisionUpdateDataAttributes.new({
id: "CHM-1234",
}),
relationships: DatadogAPIClient::V2::ChangeRequestDecisionUpdateDataRelationships.new({
change_request_decisions: DatadogAPIClient::V2::ChangeRequestDecisionsRelationship.new({
data: [
DatadogAPIClient::V2::ChangeRequestDecisionRelationshipData.new({
id: "decision-id-0",
type: DatadogAPIClient::V2::ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
}),
],
}),
}),
type: DatadogAPIClient::V2::ChangeRequestResourceType::CHANGE_REQUEST,
}),
included: [
DatadogAPIClient::V2::ChangeRequestDecisionCreateItem.new({
attributes: DatadogAPIClient::V2::ChangeRequestDecisionCreateAttributes.new({
change_request_status: DatadogAPIClient::V2::ChangeRequestDecisionStatusType::REQUESTED,
request_reason: "Please review and approve this change",
}),
id: "decision-id-0",
relationships: DatadogAPIClient::V2::ChangeRequestDecisionCreateRelationships.new({
requested_user: DatadogAPIClient::V2::ChangeRequestUserRelationship.new({
data: DatadogAPIClient::V2::ChangeRequestUserRelationshipData.new({
id: "00000000-0000-0000-0000-000000000000",
type: "user",
}),
}),
}),
type: DatadogAPIClient::V2::ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
}),
],
})
p api_instance.update_change_request_decision("change_request_id", "decision_id", body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Update a change request decision
// Update a change request decision returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_change_management::ChangeManagementAPI;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionCreateAttributes;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionCreateItem;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionCreateRelationships;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionRelationshipData;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionResourceType;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionStatusType;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionUpdateData;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionUpdateDataAttributes;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionUpdateDataRelationships;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionUpdateRequest;
use datadog_api_client::datadogV2::model::ChangeRequestDecisionsRelationship;
use datadog_api_client::datadogV2::model::ChangeRequestResourceType;
use datadog_api_client::datadogV2::model::ChangeRequestUserRelationship;
use datadog_api_client::datadogV2::model::ChangeRequestUserRelationshipData;
#[tokio::main]
async fn main() {
let body = ChangeRequestDecisionUpdateRequest::new(
ChangeRequestDecisionUpdateData::new(ChangeRequestResourceType::CHANGE_REQUEST)
.attributes(ChangeRequestDecisionUpdateDataAttributes::new().id("CHM-1234".to_string()))
.relationships(ChangeRequestDecisionUpdateDataRelationships::new(
ChangeRequestDecisionsRelationship::new(vec![
ChangeRequestDecisionRelationshipData::new(
"decision-id-0".to_string(),
ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
),
]),
)),
)
.included(vec![ChangeRequestDecisionCreateItem::new(
"decision-id-0".to_string(),
ChangeRequestDecisionResourceType::CHANGE_REQUEST_DECISION,
)
.attributes(
ChangeRequestDecisionCreateAttributes::new()
.change_request_status(ChangeRequestDecisionStatusType::REQUESTED)
.request_reason("Please review and approve this change".to_string()),
)
.relationships(
ChangeRequestDecisionCreateRelationships::new().requested_user(
ChangeRequestUserRelationship::new(Some(ChangeRequestUserRelationshipData::new(
"00000000-0000-0000-0000-000000000000".to_string(),
"user".to_string(),
))),
),
)]);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.update_change_request_decision", true);
let api = ChangeManagementAPI::with_config(configuration);
let resp = api
.update_change_request_decision(
"change_request_id".to_string(),
"decision_id".to_string(),
body,
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runUpdate a change request decision
/**
* Update a change request decision returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
configuration.unstableOperations["v2.updateChangeRequestDecision"] = true;
const apiInstance = new v2.ChangeManagementApi(configuration);
const params: v2.ChangeManagementApiUpdateChangeRequestDecisionRequest = {
body: {
data: {
attributes: {
id: "CHM-1234",
},
relationships: {
changeRequestDecisions: {
data: [
{
id: "decision-id-0",
type: "change_request_decision",
},
],
},
},
type: "change_request",
},
included: [
{
attributes: {
changeRequestStatus: "REQUESTED",
requestReason: "Please review and approve this change",
},
id: "decision-id-0",
relationships: {
requestedUser: {
data: {
id: "00000000-0000-0000-0000-000000000000",
type: "user",
},
},
},
type: "change_request_decision",
},
],
},
changeRequestId: "change_request_id",
decisionId: "decision_id",
};
apiInstance
.updateChangeRequestDecision(params)
.then((data: v2.ChangeRequestResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"