Objective-C / Datadog API Collection / Update a single service object
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": {
// "id": "<string>",
// "type": "opsgenie-service",
// "attributes": {
// "custom_url": "<string>",
// "name": "<string>",
// "opsgenie_api_key": "<string>",
// "region": "eu"
// }
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data.id" value: @"<string>"];
[json UpdateString: @"data.type" value: @"opsgenie-service"];
[json UpdateString: @"data.attributes.custom_url" value: @"<string>"];
[json UpdateString: @"data.attributes.name" value: @"<string>"];
[json UpdateString: @"data.attributes.opsgenie_api_key" value: @"<string>"];
[json UpdateString: @"data.attributes.region" value: @"eu"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoHttpResponse *resp = [http PTextSb: @"PATCH" url: @"https://api.app.ddog-gov.com/api/v2/integration/opsgenie/services/:integration_service_id" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "<string>",
// "type": "opsgenie-service",
// "attributes": {
// "custom_url": "<string>",
// "name": "<string>",
// "region": "eu"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *Id = [jResp StringOf: @"data.id"];
NSString *v_Type = [jResp StringOf: @"data.type"];
NSString *Custom_url = [jResp StringOf: @"data.attributes.custom_url"];
NSString *Name = [jResp StringOf: @"data.attributes.name"];
NSString *Region = [jResp StringOf: @"data.attributes.region"];
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "opsgenie-service",
"attributes": {
"custom_url": "<string>",
"name": "<string>",
"opsgenie_api_key": "<string>",
"region": "eu"
}
}
}'
https://api.app.ddog-gov.com/api/v2/integration/opsgenie/services/:integration_service_id
Postman Collection Item JSON
{
"name": "Update a single service object",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"opsgenie_api_key\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id",
"value": "<string>"
}
]
},
"description": "Update a single service object in the Datadog Opsgenie integration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"opsgenie_api_key\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"opsgenie_api_key\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"opsgenie_api_key\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"opsgenie_api_key\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"opsgenie_api_key\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"opsgenie-service\",\n \"attributes\": {\n \"custom_url\": \"<string>\",\n \"name\": \"<string>\",\n \"opsgenie_api_key\": \"<string>\",\n \"region\": \"eu\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/integration/opsgenie/services/:integration_service_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"integration",
"opsgenie",
"services",
":integration_service_id"
],
"variable": [
{
"key": "integration_service_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}