Chilkat Online Tools

autoit / Core Services API / AttachService

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "serviceId": "in"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("serviceId","in")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "x-content-sha256","{{content_sha256}}"
$oHttp.SetRequestHeader "Authorization","{{signature}}"
$oHttp.SetRequestHeader "Date","{{date}}"
$oHttp.SetRequestHeader "if-match","officia sed"

Local $oResp = $oHttp.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways/:serviceGatewayId/actions/attachService","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "compartmentId": "Ut eu esse consectetur",
;   "id": "eu ad anim",
;   "lifecycleState": "TERMINATING",
;   "vcnId": "ea culpa et Duis deserunt",
;   "blockTraffic": false,
;   "services": [
;     {
;       "value": "<Error: Too many levels of nesting to fake this schema>"
;     },
;     {
;       "value": "<Error: Too many levels of nesting to fake this schema>"
;     }
;   ],
;   "definedTags": {},
;   "displayName": "Lorem Excepteur mini",
;   "freeformTags": {},
;   "routeTableId": "ex",
;   "timeCreated": "2015-12-17T16:51:12.199Z"
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sValue

Local $sCompartmentId = $oJResp.StringOf("compartmentId")
Local $sId = $oJResp.StringOf("id")
Local $sLifecycleState = $oJResp.StringOf("lifecycleState")
Local $sVcnId = $oJResp.StringOf("vcnId")
Local $blockTraffic = $oJResp.BoolOf("blockTraffic")
Local $sDisplayName = $oJResp.StringOf("displayName")
Local $sRouteTableId = $oJResp.StringOf("routeTableId")
Local $sTimeCreated = $oJResp.StringOf("timeCreated")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("services")
While $i < $iCount_i
    $oJResp.I = $i
    $sValue = $oJResp.StringOf("services[i].value")
    $i = $i + 1
Wend

Curl Command

curl -X POST
	-H "if-match: officia sed"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "serviceId": "in"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways/:serviceGatewayId/actions/attachService

Postman Collection Item JSON

{
  "name": "AttachService",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
        "key": "if-match",
        "value": "officia sed"
      },
      {
        "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    \"serviceId\": \"in\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "serviceGateways",
        ":serviceGatewayId",
        "actions",
        "attachService"
      ],
      "variable": [
        {
          "key": "serviceGatewayId",
          "value": "amet ut",
          "description": "(Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
        }
      ]
    },
    "description": "Adds the specified [Service](#/en/iaas/latest/Service/) to the list of enabled\n`Service` objects for the specified gateway. You must also set up a route rule with the\n`cidrBlock` of the `Service` as the rule's destination and the service gateway as the rule's\ntarget. See [Route Table](#/en/iaas/latest/RouteTable/).\n\n**Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call.\n"
  },
  "response": [
    {
      "name": "The service has been enabled for the service gateway.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"serviceId\": \"in\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways",
            ":serviceGatewayId",
            "actions",
            "attachService"
          ],
          "variable": [
            {
              "key": "serviceGatewayId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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 \"compartmentId\": \"Ut eu esse consectetur\",\n \"id\": \"eu ad anim\",\n \"lifecycleState\": \"TERMINATING\",\n \"vcnId\": \"ea culpa et Duis deserunt\",\n \"blockTraffic\": false,\n \"services\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"definedTags\": {},\n \"displayName\": \"Lorem Excepteur mini\",\n \"freeformTags\": {},\n \"routeTableId\": \"ex\",\n \"timeCreated\": \"2015-12-17T16:51:12.199Z\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"serviceId\": \"in\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways",
            ":serviceGatewayId",
            "actions",
            "attachService"
          ],
          "variable": [
            {
              "key": "serviceGatewayId"
            }
          ]
        }
      },
      "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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"serviceId\": \"in\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways",
            ":serviceGatewayId",
            "actions",
            "attachService"
          ],
          "variable": [
            {
              "key": "serviceGatewayId"
            }
          ]
        }
      },
      "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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"serviceId\": \"in\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways",
            ":serviceGatewayId",
            "actions",
            "attachService"
          ],
          "variable": [
            {
              "key": "serviceGatewayId"
            }
          ]
        }
      },
      "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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"serviceId\": \"in\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways",
            ":serviceGatewayId",
            "actions",
            "attachService"
          ],
          "variable": [
            {
              "key": "serviceGatewayId"
            }
          ]
        }
      },
      "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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"serviceId\": \"in\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways",
            ":serviceGatewayId",
            "actions",
            "attachService"
          ],
          "variable": [
            {
              "key": "serviceGatewayId"
            }
          ]
        }
      },
      "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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"serviceId\": \"in\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/attachService",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways",
            ":serviceGatewayId",
            "actions",
            "attachService"
          ],
          "variable": [
            {
              "key": "serviceGatewayId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}