This request method allows you to retrieve a Data Source from the platform.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/datasource?format=xml/json

ADDITIONAL INFO

CONTENTS

Endpoints & API Explorer
Parameters
Example

Endpoints & API Explorer

Node	Endpoint	API Explorer
US	https://www.taskform.nl:443/api/v2/datasource	Model Description/Schema & Parameters
EU	https://dashboard.taskform.io:443/api/v2/datasource	Model Description/Schema & Parameters
AU	https://dashboard.taskform.nl:443/api/v2/datasource	Model Description/Schema & Parameters

Parameters

The GET verb allows you to retrieve a single DataSource, identified by its unique Id.
The required and optional parameters for a GET call to the DataSource API are outlined below.

Name	Type	Description	Required
CompanyId	Integer	Your unique Company Id found on the Organisation Setup page of the secure website	✓
IntegrationKey	String	Your unique Integration Key found on the Organisation Setup page of the secure website	✓
Name	String	The data source name to search for
Id or ExternalId	GUID or String	The unique identifier of the DataSource you wish to retrieve The external identifier for the DataSource to retrieve	✓
ReturnRows	Boolean	Whether or not to return the Rows for this Data Source in the response. Defaults to False. If set to True, then will return Rows in a paginated form, using the PageSize and PageNo values below
PageNo	Integer	The number of Rows returned per page. Maximum value of 100. Defaults to 100.
PageSize	Integer	The page number of the Rows result set that you wish to receive back. Defaults to 0, which is the first page of the Rows result set.

Example

Given that the API is REST-based, you can access the API directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.

Request URL

https://www.taskform.nl:443/api/v2/datasource?Id=1f12e179-2393-4f19-a03b-a96e00XXXXXX&CompanyId=51XXX&IntegrationKey=78eec3032af240fdb642218afbXXXXXX&ReturnRows=true&&

Response Body

{
  "DataSource": {
  "Id": "1f12e17923934f19a03ba96e00XXXXXX",
  "Name": "Assess Data",
  "ExternalId": "AssessData",
  "Headers": [
  {
  "Name": "ACN",
  "DisplayAt": "None"
  },
  {
  "Name": "AssessNo",
  "DisplayAt": "Title"
  },
  {
  "Name": "AssessDate",
  "DisplayAt": "None"
  }
  ],
  "Rows": [
  [
  "ACN 000 000 019",
  "1001",
  null
  ],
  [
  "ACN 000 000 020",
  "1002",
  "2018-10-03"
  ],
  [
  "ACN 000 000 021",
  "1003",
  null
  ],
  [
  "ACN 000 000 022",
  "1004",
  null
  ],
  [
  "e5b4ac5d-4aee-4d63-8719-a96e011079b9",
  "1005",
  "2018-10-04"
  ],
  [
  "ACN 333 222 111",
  "1008",
  "2018-10-04"
  ],
  [
  "ACN 222 111 333",
  "1007",
  "2018-10-04"
  ]
  ],
  "TotalRows": 7,
  "LastUpdated": "2022-06-20T13:27:11.4270000Z",
  "CompanyId": 51XXX
  }
 }

Tags: