Update a change request

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PATCH https://api.ap1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.ap2.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.datadoghq.eu/api/v2/change-management/change-request/{change_request_id}https://api.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}https://api.us2.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}https://api.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.us3.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.us5.datadoghq.com/api/v2/change-management/change-request/{change_request_id}

Overview

Update the properties of a change request.

OAuth apps require the cases_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

change_request_id [required]

string

The identifier of the change request.

Request

Body Data (required)

Change request update payload.

Expand All

Field

Type

Description

data [required]

object

Data object to update a change request.

attributes

object

Attributes for updating a change request.

change_request_plan

string

The plan associated with the change request.

change_request_risk

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

end_date

date-time

The planned end date of the change request.

id

string

The identifier of the change request to update.

start_date

date-time

The planned start date of the change request.

relationships

object

Relationships for updating a change request.

change_request_decisions

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_decision

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[object]

Included resources for the change request update.

attributes

object

Attributes for creating a change request decision.

change_request_status

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

request_reason

string

The reason for requesting the decision.

id [required]

string

The decision identifier.

relationships

object

Relationships for creating a change request decision.

requested_user

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": {
      "change_request_plan": "Updated deployment plan",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "end_date": "2024-01-02T15:00:00Z",
      "id": "CHM-1234",
      "start_date": "2024-01-01T03:00:00Z"
    },
    "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"
    }
  ]
}

Response

OK

Response object for a change request.

Expand All

Field

Type

Description

data [required]

object

Data object for a change request response.

attributes [required]

object

Attributes of a change request response.

archived_at

date-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,HIGH

change_request_type [required]

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

closed_at

date-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_date

date-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_date

date-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.

relationships

object

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_decision

created_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_request

included

[ <oneOf>]

Included resources related to the change request.

Option 1

object

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.

Option 2

object

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,DECLINED

decided_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.

relationships

object

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.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export change_request_id="CHM-1234"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/change-management/change-request/${change_request_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "change_request_plan": "Updated deployment plan", "change_request_risk": "LOW", "change_request_type": "NORMAL", "end_date": "2024-01-02T15:00:00Z", "id": "CHM-1234", "start_date": "2024-01-01T03:00:00Z" }, "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
"""
Update a change request returns "OK" response
"""

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_change_type import ChangeRequestChangeType
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_decisions_relationship import ChangeRequestDecisionsRelationship
from datadog_api_client.v2.model.change_request_resource_type import ChangeRequestResourceType
from datadog_api_client.v2.model.change_request_risk_level import ChangeRequestRiskLevel
from datadog_api_client.v2.model.change_request_update_attributes import ChangeRequestUpdateAttributes
from datadog_api_client.v2.model.change_request_update_data import ChangeRequestUpdateData
from datadog_api_client.v2.model.change_request_update_relationships import ChangeRequestUpdateRelationships
from datadog_api_client.v2.model.change_request_update_request import ChangeRequestUpdateRequest
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
from datetime import datetime
from dateutil.tz import tzutc

body = ChangeRequestUpdateRequest(
    data=ChangeRequestUpdateData(
        attributes=ChangeRequestUpdateAttributes(
            change_request_plan="Updated deployment plan",
            change_request_risk=ChangeRequestRiskLevel.LOW,
            change_request_type=ChangeRequestChangeType.NORMAL,
            end_date=datetime(2024, 1, 2, 15, 0, tzinfo=tzutc()),
            id="CHM-1234",
            start_date=datetime(2024, 1, 1, 3, 0, tzinfo=tzutc()),
        ),
        relationships=ChangeRequestUpdateRelationships(
            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.unstable_operations["update_change_request"] = True
with ApiClient(configuration) as api_client:
    api_instance = ChangeManagementApi(api_client)
    response = api_instance.update_change_request(change_request_id="change_request_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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Update a change request returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.update_change_request".to_sym] = true
end
api_instance = DatadogAPIClient::V2::ChangeManagementAPI.new

body = DatadogAPIClient::V2::ChangeRequestUpdateRequest.new({
  data: DatadogAPIClient::V2::ChangeRequestUpdateData.new({
    attributes: DatadogAPIClient::V2::ChangeRequestUpdateAttributes.new({
      change_request_plan: "Updated deployment plan",
      change_request_risk: DatadogAPIClient::V2::ChangeRequestRiskLevel::LOW,
      change_request_type: DatadogAPIClient::V2::ChangeRequestChangeType::NORMAL,
      end_date: "2024-01-02T15:00:00Z",
      id: "CHM-1234",
      start_date: "2024-01-01T03:00:00Z",
    }),
    relationships: DatadogAPIClient::V2::ChangeRequestUpdateRelationships.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("change_request_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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Update a change request returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	"time"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.ChangeRequestUpdateRequest{
		Data: datadogV2.ChangeRequestUpdateData{
			Attributes: &datadogV2.ChangeRequestUpdateAttributes{
				ChangeRequestPlan: datadog.PtrString("Updated deployment plan"),
				ChangeRequestRisk: datadogV2.CHANGEREQUESTRISKLEVEL_LOW.Ptr(),
				ChangeRequestType: datadogV2.CHANGEREQUESTCHANGETYPE_NORMAL.Ptr(),
				EndDate:           datadog.PtrTime(time.Date(2024, 1, 2, 15, 0, 0, 0, time.UTC)),
				Id:                datadog.PtrString("CHM-1234"),
				StartDate:         datadog.PtrTime(time.Date(2024, 1, 1, 3, 0, 0, 0, time.UTC)),
			},
			Relationships: &datadogV2.ChangeRequestUpdateRelationships{
				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())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.UpdateChangeRequest", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewChangeManagementApi(apiClient)
	resp, r, err := api.UpdateChangeRequest(ctx, "change_request_id", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ChangeManagementApi.UpdateChangeRequest`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ChangeManagementApi.UpdateChangeRequest`:\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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Update a change request 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.ChangeRequestChangeType;
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.ChangeRequestDecisionsRelationship;
import com.datadog.api.client.v2.model.ChangeRequestResourceType;
import com.datadog.api.client.v2.model.ChangeRequestResponse;
import com.datadog.api.client.v2.model.ChangeRequestRiskLevel;
import com.datadog.api.client.v2.model.ChangeRequestUpdateAttributes;
import com.datadog.api.client.v2.model.ChangeRequestUpdateData;
import com.datadog.api.client.v2.model.ChangeRequestUpdateRelationships;
import com.datadog.api.client.v2.model.ChangeRequestUpdateRequest;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationship;
import com.datadog.api.client.v2.model.ChangeRequestUserRelationshipData;
import java.time.OffsetDateTime;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.updateChangeRequest", true);
    ChangeManagementApi apiInstance = new ChangeManagementApi(defaultClient);

    ChangeRequestUpdateRequest body =
        new ChangeRequestUpdateRequest()
            .data(
                new ChangeRequestUpdateData()
                    .attributes(
                        new ChangeRequestUpdateAttributes()
                            .changeRequestPlan("Updated deployment plan")
                            .changeRequestRisk(ChangeRequestRiskLevel.LOW)
                            .changeRequestType(ChangeRequestChangeType.NORMAL)
                            .endDate(OffsetDateTime.parse("2024-01-02T15:00:00Z"))
                            .id("CHM-1234")
                            .startDate(OffsetDateTime.parse("2024-01-01T03:00:00Z")))
                    .relationships(
                        new ChangeRequestUpdateRelationships()
                            .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.updateChangeRequest("CHM-1234", body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ChangeManagementApi#updateChangeRequest");
      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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// Update a change request returns "OK" response
use chrono::{DateTime, Utc};
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_change_management::ChangeManagementAPI;
use datadog_api_client::datadogV2::model::ChangeRequestChangeType;
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::ChangeRequestDecisionsRelationship;
use datadog_api_client::datadogV2::model::ChangeRequestResourceType;
use datadog_api_client::datadogV2::model::ChangeRequestRiskLevel;
use datadog_api_client::datadogV2::model::ChangeRequestUpdateAttributes;
use datadog_api_client::datadogV2::model::ChangeRequestUpdateData;
use datadog_api_client::datadogV2::model::ChangeRequestUpdateRelationships;
use datadog_api_client::datadogV2::model::ChangeRequestUpdateRequest;
use datadog_api_client::datadogV2::model::ChangeRequestUserRelationship;
use datadog_api_client::datadogV2::model::ChangeRequestUserRelationshipData;

#[tokio::main]
async fn main() {
    let body = ChangeRequestUpdateRequest::new(
        ChangeRequestUpdateData::new(ChangeRequestResourceType::CHANGE_REQUEST)
            .attributes(
                ChangeRequestUpdateAttributes::new()
                    .change_request_plan("Updated deployment plan".to_string())
                    .change_request_risk(ChangeRequestRiskLevel::LOW)
                    .change_request_type(ChangeRequestChangeType::NORMAL)
                    .end_date(
                        DateTime::parse_from_rfc3339("2024-01-02T15:00:00+00:00")
                            .expect("Failed to parse datetime")
                            .with_timezone(&Utc),
                    )
                    .id("CHM-1234".to_string())
                    .start_date(
                        DateTime::parse_from_rfc3339("2024-01-01T03:00:00+00:00")
                            .expect("Failed to parse datetime")
                            .with_timezone(&Utc),
                    ),
            )
            .relationships(
                ChangeRequestUpdateRelationships::new().change_request_decisions(
                    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.UpdateChangeRequest", true);
    let api = ChangeManagementAPI::with_config(configuration);
    let resp = api
        .update_change_request("change_request_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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Update a change request returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.updateChangeRequest"] = true;
const apiInstance = new v2.ChangeManagementApi(configuration);

const params: v2.ChangeManagementApiUpdateChangeRequestRequest = {
  body: {
    data: {
      attributes: {
        changeRequestPlan: "Updated deployment plan",
        changeRequestRisk: "LOW",
        changeRequestType: "NORMAL",
        endDate: new Date(2024, 1, 2, 15, 0, 0, 0),
        id: "CHM-1234",
        startDate: new Date(2024, 1, 1, 3, 0, 0, 0),
      },
      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",
};

apiInstance
  .updateChangeRequest(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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"