Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Contract Renewer API

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

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "context": {
    ;     "masterContractId": null,
    ;     "renewedContracts": [
    ;       {
    ;         "attributes": {
    ;           "type": "Contract"
    ;         },
    ;         "Id": "800540000006LLVAA2"
    ;       }
    ;     ]
    ;   }
    ; }

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

    CkJsonObject::ckUpdateNull(json,"context.masterContractId")
    CkJsonObject::ckUpdateString(json,"context.renewedContracts[0].attributes.type","Contract")
    CkJsonObject::ckUpdateString(json,"context.renewedContracts[0].Id","800540000006LLVAA2")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

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

    success = CkHttp::ckHttpSb(http,"PATCH","https://domain.com/services/apexrest/SBQQ/ServiceRouter?loader=SBQQ.ContractManipulationAPI.ContractRenewer",sbRequestBody,"utf-8","application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

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


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


    ProcedureReturn
EndProcedure

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "context": {
        "masterContractId": null,
        "renewedContracts": [
            {
                "attributes": {
                    "type": "Contract"
                },
                "Id": "800540000006LLVAA2"
            }
        ]
    }
}'
https://domain.com/services/apexrest/SBQQ/ServiceRouter?loader=SBQQ.ContractManipulationAPI.ContractRenewer

Postman Collection Item JSON

{
  "name": "Contract Renewer API",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"context\": {\n        \"masterContractId\": null,\n        \"renewedContracts\": [\n            {\n                \"attributes\": {\n                    \"type\": \"Contract\"\n                },\n                \"Id\": \"800540000006LLVAA2\"\n            }\n        ]\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/apexrest/SBQQ/ServiceRouter?loader=SBQQ.ContractManipulationAPI.ContractRenewer",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "apexrest",
        "SBQQ",
        "ServiceRouter"
      ],
      "query": [
        {
          "key": "loader",
          "value": "SBQQ.ContractManipulationAPI.ContractRenewer"
        }
      ]
    },
    "description": "Receive a CPQ contract in a request, and return quote data for one or more renewal quotes.\nAvailable in: Salesforce CPQ Summer ’16 and later\nSpecial Access Rules: All of these user permissions are required.\nInsert and update on quote and opportunity objects\nRead on quote, opportunity, and product2 objects\nDelete on quote object\n\nhttps://developer.salesforce.com/docs/atlas.en-us.cpq_dev_api.meta/cpq_dev_api/cpq_api_contract_renewer.htm"
  },
  "response": [
  ]
}