Chilkat Online Tools

SQL Server / DocuSign REST API / Gets a list of the envelopes in the specified folder.

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 @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'from_date', '{{from_date}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include_items', '{{include_items}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'owner_email', '{{owner_email}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'owner_name', '{{owner_name}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'search_text', '{{search_text}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'start_position', '{{start_position}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'status', '{{status}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'to_date', '{{to_date}}'

    -- Adds the "Authorization: Bearer {{accessToken}}" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/v2.1/accounts/{{accountId}}/folders/{{folderId}}', @queryParams
    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 @queryParams
        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 @queryParams


END
GO

Curl Command

curl -G -d "from_date=%7B%7Bfrom_date%7D%7D"
	-d "include_items=%7B%7Binclude_items%7D%7D"
	-d "owner_email=%7B%7Bowner_email%7D%7D"
	-d "owner_name=%7B%7Bowner_name%7D%7D"
	-d "search_text=%7B%7Bsearch_text%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-d "to_date=%7B%7Bto_date%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/folders/{{folderId}}

Postman Collection Item JSON

{
  "name": "Gets a list of the envelopes in the specified folder.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/folders/{{folderId}}?from_date={{from_date}}&include_items={{include_items}}&owner_email={{owner_email}}&owner_name={{owner_name}}&search_text={{search_text}}&start_position={{start_position}}&status={{status}}&to_date={{to_date}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "folders",
        "{{folderId}}"
      ],
      "query": [
        {
          "key": "from_date",
          "value": "{{from_date}}"
        },
        {
          "key": "include_items",
          "value": "{{include_items}}"
        },
        {
          "key": "owner_email",
          "value": "{{owner_email}}"
        },
        {
          "key": "owner_name",
          "value": "{{owner_name}}"
        },
        {
          "key": "search_text",
          "value": "{{search_text}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "to_date",
          "value": "{{to_date}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "folderId",
          "value": "{{folderId}}"
        }
      ]
    },
    "description": "Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters."
  },
  "response": [
  ]
}