Chilkat Online Tools

Objective-C / Core Services API / CreateByoipRange

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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.

// {
//   "compartmentId": "{{compartment_ocid}}",
//   "cidrBlock": "amet eu enim",
//   "definedTags": {},
//   "displayName": "sit consequat officia quis",
//   "freeformTags": {}
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"compartmentId" value: @"{{compartment_ocid}}"];
[json UpdateString: @"cidrBlock" value: @"amet eu enim"];
[json UpdateNewObject: @"definedTags"];
[json UpdateString: @"displayName" value: @"sit consequat officia quis"];
[json UpdateNewObject: @"freeformTags"];

[http SetRequestHeader: @"opc-retry-token" value: @"aliqua enim i"];
[http SetRequestHeader: @"opc-request-id" value: @"8wF"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"x-content-sha256" value: @"{{content_sha256}}"];
[http SetRequestHeader: @"Authorization" value: @"{{signature}}"];
[http SetRequestHeader: @"Date" value: @"{{date}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://iaas.{{region}}.oraclecloud.com/20160918/byoipRanges" contentType: @"application/json" json: json];
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)

// {
//   "id": "fugiat adipisicing quis anim commodo",
//   "compartmentId": "tempor culpa mollit nisi",
//   "cidrBlock": "laboredese",
//   "lifecycleState": "UPDATING",
//   "validationToken": "nisi",
//   "timeCreated": "2002-03-26T06:43:06.961Z",
//   "definedTags": {},
//   "displayName": "Ut labore in nostrud",
//   "freeformTags": {},
//   "lifecycleDetails": "CREATING",
//   "timeAdvertised": "1959-09-07T20:00:34.371Z",
//   "timeValidated": "2018-04-14T04:07:30.549Z",
//   "timeWithdrawn": "1961-12-25T13:30:04.079Z"
// }

// 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: @"id"];
NSString *compartmentId = [jResp StringOf: @"compartmentId"];
NSString *cidrBlock = [jResp StringOf: @"cidrBlock"];
NSString *lifecycleState = [jResp StringOf: @"lifecycleState"];
NSString *validationToken = [jResp StringOf: @"validationToken"];
NSString *timeCreated = [jResp StringOf: @"timeCreated"];
NSString *displayName = [jResp StringOf: @"displayName"];
NSString *lifecycleDetails = [jResp StringOf: @"lifecycleDetails"];
NSString *timeAdvertised = [jResp StringOf: @"timeAdvertised"];
NSString *timeValidated = [jResp StringOf: @"timeValidated"];
NSString *timeWithdrawn = [jResp StringOf: @"timeWithdrawn"];

Curl Command

curl -X POST
	-H "opc-request-id: 8wF"
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "compartmentId": "{{compartment_ocid}}",
    "cidrBlock": "amet eu enim",
    "definedTags": {},
    "displayName": "sit consequat officia quis",
    "freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/byoipRanges

Postman Collection Item JSON

{
  "name": "CreateByoipRange",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"compartmentId\": \"{{compartment_ocid}}\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/byoipRanges",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "byoipRanges"
      ]
    },
    "description": "Creates a subrange of the BYOIP CIDR block.\n"
  },
  "response": [
    {
      "name": "The BYOIP CIDR block was created.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compartmentId\": \"ullamco sit\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/byoipRanges",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "byoipRanges"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"fugiat adipisicing quis anim commodo\",\n \"compartmentId\": \"tempor culpa mollit nisi\",\n \"cidrBlock\": \"laboredese\",\n \"lifecycleState\": \"UPDATING\",\n \"validationToken\": \"nisi\",\n \"timeCreated\": \"2002-03-26T06:43:06.961Z\",\n \"definedTags\": {},\n \"displayName\": \"Ut labore in nostrud\",\n \"freeformTags\": {},\n \"lifecycleDetails\": \"CREATING\",\n \"timeAdvertised\": \"1959-09-07T20:00:34.371Z\",\n \"timeValidated\": \"2018-04-14T04:07:30.549Z\",\n \"timeWithdrawn\": \"1961-12-25T13:30:04.079Z\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compartmentId\": \"ullamco sit\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/byoipRanges",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "byoipRanges"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compartmentId\": \"ullamco sit\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/byoipRanges",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "byoipRanges"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compartmentId\": \"ullamco sit\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/byoipRanges",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "byoipRanges"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compartmentId\": \"ullamco sit\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/byoipRanges",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "byoipRanges"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compartmentId\": \"ullamco sit\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/byoipRanges",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "byoipRanges"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compartmentId\": \"ullamco sit\",\n    \"cidrBlock\": \"amet eu enim\",\n    \"definedTags\": {},\n    \"displayName\": \"sit consequat officia quis\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/byoipRanges",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "byoipRanges"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}