Chilkat Online Tools

PureBasic / MongoDB Atlas / Return Status of One Specific Validation Job

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkDigestAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(http, "password")

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "source": {
    ;     "clusterName": "exampleClusterA",
    ;     "groupId": "9b43a5b329223c3a1591a678",
    ;     "username": "example",
    ;     "password": "string",
    ;     "ssl": true,
    ;     "caCertificatePath": "/path/to/ca",
    ;     "managedAuthentication": false
    ;   },
    ;   "destination": {
    ;     "groupId": "e01c9427f054fe80745f3f6c",
    ;     "clusterName": "exampleClusterB"
    ;   },
    ;   "migrationHosts": [
    ;     "vm001.example.com"
    ;   ],
    ;   "dropEnabled": true
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"source.clusterName","exampleClusterA")
    CkJsonObject::ckUpdateString(json,"source.groupId","9b43a5b329223c3a1591a678")
    CkJsonObject::ckUpdateString(json,"source.username","example")
    CkJsonObject::ckUpdateString(json,"source.password","string")
    CkJsonObject::ckUpdateBool(json,"source.ssl",1)
    CkJsonObject::ckUpdateString(json,"source.caCertificatePath","/path/to/ca")
    CkJsonObject::ckUpdateBool(json,"source.managedAuthentication",0)
    CkJsonObject::ckUpdateString(json,"destination.groupId","e01c9427f054fe80745f3f6c")
    CkJsonObject::ckUpdateString(json,"destination.clusterName","exampleClusterB")
    CkJsonObject::ckUpdateString(json,"migrationHosts[0]","vm001.example.com")
    CkJsonObject::ckUpdateBool(json,"dropEnabled",1)

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"GET","https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/liveMigrations/validate/{{VALIDATION-ID}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	--digest -u 'username:password'
	-d '{
    "source": {
        "clusterName": "exampleClusterA",
        "groupId": "9b43a5b329223c3a1591a678",
        "username": "example",
        "password": "string",
        "ssl": true,
        "caCertificatePath": "/path/to/ca",
        "managedAuthentication": false
    },
    "destination": {
        "groupId": "e01c9427f054fe80745f3f6c",
        "clusterName": "exampleClusterB"
    },
    "migrationHosts": [
        "vm001.example.com"
    ],
    "dropEnabled": true
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/liveMigrations/validate/{{VALIDATION-ID}}

Postman Collection Item JSON

{
  "name": "Return Status of One Specific Validation Job",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"source\": {\n        \"clusterName\": \"exampleClusterA\",\n        \"groupId\": \"9b43a5b329223c3a1591a678\",\n        \"username\": \"example\",\n        \"password\": \"string\",\n        \"ssl\": true,\n        \"caCertificatePath\": \"/path/to/ca\",\n        \"managedAuthentication\": false\n    },\n    \"destination\": {\n        \"groupId\": \"e01c9427f054fe80745f3f6c\",\n        \"clusterName\": \"exampleClusterB\"\n    },\n    \"migrationHosts\": [\n        \"vm001.example.com\"\n    ],\n    \"dropEnabled\": true\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/groups/{{ProjectID}}/liveMigrations/validate/{{VALIDATION-ID}}",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "liveMigrations",
        "validate",
        "{{VALIDATION-ID}}"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/live-migration/return-one-specific-validation-job/"
  },
  "response": [
  ]
}