Chilkat Online Tools

SQL Server / Salesforce Platform APIs / Bulk Spec

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    DECLARE @sbRequestBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @sbRequestBody, 'Append', @success OUT, 'Salesforce Field,Csv Header,Value,Hint' + CHAR(10)
    EXEC sp_OAMethod @sbRequestBody, 'Append', @success OUT, 'Name,Full Name,,'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'text/csv'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-SFDC-Session', '{{_accessToken}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept-Encoding', 'gzip'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'charset', 'UTF-8'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Encoding', 'gzip'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'POST', 'https://domain.com/services/async/{{version}}/job/{{_jobId}}/spec', @sbRequestBody, 'utf-8', 'text/csv', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbRequestBody
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-SFDC-Session: {{_accessToken}}"
	-H "Content-Type: text/csv"
	-H "charset: UTF-8"
	-H "Accept-Encoding: gzip"
	-H "Content-Encoding: gzip"
	-d 'Salesforce Field,Csv Header,Value,Hint
Name,Full Name,,'
https://domain.com/services/async/{{version}}/job/{{_jobId}}/spec

Postman Collection Item JSON

{
  "name": "Bulk Spec",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-SFDC-Session",
        "value": "{{_accessToken}}"
      },
      {
        "key": "Content-Type",
        "value": "text/csv"
      },
      {
        "key": "charset",
        "value": "UTF-8"
      },
      {
        "key": "Accept-Encoding",
        "value": "gzip"
      },
      {
        "key": "Content-Encoding",
        "value": "gzip"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "Salesforce Field,Csv Header,Value,Hint\nName,Full Name,,"
    },
    "url": {
      "raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}/spec",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "async",
        "{{version}}",
        "job",
        "{{_jobId}}",
        "spec"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Bulk Spec",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "X-SFDC-Session",
            "value": "{{_accessToken}}"
          },
          {
            "key": "Content-Type",
            "value": "text/csv"
          },
          {
            "key": "charset",
            "value": "UTF-8"
          },
          {
            "key": "Accept-Encoding",
            "value": "gzip"
          },
          {
            "key": "Content-Encoding",
            "value": "gzip"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "Salesforce Field,Csv Header,Value,Hint\nName,Full Name,,"
        },
        "url": {
          "raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}/spec",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "async",
            "{{version}}",
            "job",
            "{{_jobId}}",
            "spec"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "plain",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 16:12:34 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Content-Security-Policy",
          "value": "upgrade-insecure-requests"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Location",
          "value": "/services/async/58.0/job/7502o00000kjNCsAAM/spec/0Aj2o000000PbakCAC"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": null
    }
  ]
}