Chilkat Online Tools

SQL Server / Squadcast API V3 / Incident Export

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, 'start_time', '2020-08-16T11:43:51.947Z'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'end_time', '2020-08-16T11:43:51.947Z'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'status', 'resolved'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'type', 'csv'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'services', '5c7cf6bff8dde3001282aa56'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'services', '5c7cf6bff8dde3001282aa57'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'assigned_to', '5c7cf6bff8dde3001282aa33'

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.squadcast.com/v3/incidents/export/', @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 "start_time=2020-08-16T11%3A43%3A51.947Z"
	-d "end_time=2020-08-16T11%3A43%3A51.947Z"
	-d "status=resolved"
	-d "type=csv"
	-d "services=5c7cf6bff8dde3001282aa56"
	-d "services=5c7cf6bff8dde3001282aa57"
	-d "assigned_to=5c7cf6bff8dde3001282aa33"
	-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/incidents/export/

Postman Collection Item JSON

{
  "name": "Incident Export",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{sq_pb_auth_header}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/incidents/export/?start_time=2020-08-16T11:43:51.947Z&end_time=2020-08-16T11:43:51.947Z&status=resolved&type=csv&services=5c7cf6bff8dde3001282aa56&services=5c7cf6bff8dde3001282aa57&assigned_to=5c7cf6bff8dde3001282aa33",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "incidents",
        "export",
        ""
      ],
      "query": [
        {
          "key": "start_time",
          "value": "2020-08-16T11:43:51.947Z"
        },
        {
          "key": "end_time",
          "value": "2020-08-16T11:43:51.947Z"
        },
        {
          "key": "status",
          "value": "resolved"
        },
        {
          "key": "type",
          "value": "csv"
        },
        {
          "key": "services",
          "value": "5c7cf6bff8dde3001282aa56"
        },
        {
          "key": "services",
          "value": "5c7cf6bff8dde3001282aa57"
        },
        {
          "key": "assigned_to",
          "value": "5c7cf6bff8dde3001282aa33"
        }
      ]
    },
    "description": "- This endpoint is used to export the incident details into a `csv` or `json` file.\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header.\n- Header field/value: `Content-Type`: `text/csv`\n\n\nQuery Params:\n```\ntype: csv or json\n\nstart_time: filter by date range\n\nend_time: filter by date range\n\nservices: filter by services\n\nsources: filter by alert sources\n\nassigned_to: filter by assignee\n\nstatus: filter by incident status\n```"
  },
  "response": [
    {
      "name": "200 OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/incidents/export/?start_time=2020-08-16T11:43:51.947Z&end_time=2020-08-16T11:43:51.947Z&status=resolved&type=csv&services=5c7cf6bff8dde3001282aa56&services=5c7cf6bff8dde3001282aa57&assigned_to=5c7cf6bff8dde3001282aa33",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "incidents",
            "export",
            ""
          ],
          "query": [
            {
              "key": "start_time",
              "value": "2020-08-16T11:43:51.947Z"
            },
            {
              "key": "end_time",
              "value": "2020-08-16T11:43:51.947Z"
            },
            {
              "key": "status",
              "value": "resolved"
            },
            {
              "key": "type",
              "value": "csv"
            },
            {
              "key": "services",
              "value": "5c7cf6bff8dde3001282aa56"
            },
            {
              "key": "services",
              "value": "5c7cf6bff8dde3001282aa57"
            },
            {
              "key": "assigned_to",
              "value": "5c7cf6bff8dde3001282aa33"
            }
          ]
        }
      },
      "_postman_previewlanguage": null,
      "header": null,
      "cookie": [
      ],
      "body": null
    },
    {
      "name": "401 Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/incidents/export/?start_time=2020-08-16T11:43:51.947Z&end_time=2020-08-16T11:43:51.947Z&status=resolved&type=csv&services=5c7cf6bff8dde3001282aa56&services=5c7cf6bff8dde3001282aa57&assigned_to=5c7cf6bff8dde3001282aa33",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "incidents",
            "export",
            ""
          ],
          "query": [
            {
              "key": "start_time",
              "value": "2020-08-16T11:43:51.947Z"
            },
            {
              "key": "end_time",
              "value": "2020-08-16T11:43:51.947Z"
            },
            {
              "key": "status",
              "value": "resolved"
            },
            {
              "key": "type",
              "value": "csv"
            },
            {
              "key": "services",
              "value": "5c7cf6bff8dde3001282aa56"
            },
            {
              "key": "services",
              "value": "5c7cf6bff8dde3001282aa57"
            },
            {
              "key": "assigned_to",
              "value": "5c7cf6bff8dde3001282aa33"
            }
          ]
        }
      },
      "_postman_previewlanguage": null,
      "header": null,
      "cookie": [
      ],
      "body": null
    },
    {
      "name": "400 Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/incidents/export/?start_time=2020-08-16T11:43:51.947Z&end_time=2020-08-16T11:43:51.947Z&status=resolved&type=csv&services=5c7cf6bff8dde3001282aa56&services=5c7cf6bff8dde3001282aa57&assigned_to=5c7cf6bff8dde3001282aa33",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "incidents",
            "export",
            ""
          ],
          "query": [
            {
              "key": "start_time",
              "value": "2020-08-16T11:43:51.947Z"
            },
            {
              "key": "end_time",
              "value": "2020-08-16T11:43:51.947Z"
            },
            {
              "key": "status",
              "value": "resolved"
            },
            {
              "key": "type",
              "value": "csv"
            },
            {
              "key": "services",
              "value": "5c7cf6bff8dde3001282aa56"
            },
            {
              "key": "services",
              "value": "5c7cf6bff8dde3001282aa57"
            },
            {
              "key": "assigned_to",
              "value": "5c7cf6bff8dde3001282aa33"
            }
          ]
        }
      },
      "_postman_previewlanguage": null,
      "header": null,
      "cookie": [
      ],
      "body": null
    }
  ]
}