Get Dataset

Description: 

This API will return dataset information along with metadata. 

API Endpoint: 

/ws/DatasetManagementService

 

Method: 

POST

 

Header: 

 

Field	Value
SOAPAction	/ws/datasetManagement.wsdl

 

Request:

 

XML Element	Type	Value
<wsse:Username>	String	Smarten username
<wsse:Password>	String	Smarten user password
<dat: datasetId >	String	Smarten dataset id, you can access it from Smarten Menu – Data – Dataset

Request Example: 

<soapenv:Envelope xmlns:dat="http://www.elegantjbi.com/ws/DatasetManagement" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

   <soapenv:Header>

      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

         <wsse:UsernameToken wsu:Id="UsernameToken-123">

            <wsse:Username>username</wsse:Username>

            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>       

         </wsse:UsernameToken>

      </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

      <dat:getDatasetRequest>

         <dat:datasetId>datasetId.dtst</dat:datasetId>

      </dat:getDatasetRequest>

   </soapenv:Body>

</soapenv:Envelope>

Response:  

 

Return a response with SOAP XML as object. 

 

XML Element	Type	Value
<ns2:statusCode>	String	Return the API status response
<ns2:dataSet>		Element with datasetId, displayName and Columns (nested)
<ns2:datasetId>	String	Dataset id
<ns2:displayName>	String	Dataset name
<ns2:Columns>		Element with multiple nested rows with columnId, displayName and columnType
<ns2:columntId>	Number	Dataset column id
<ns2:displayName>	String	Dataset column name
<ns2:columnType>	Number	Dataset column type

 

Response Example: 

 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

    <SOAP-ENV:Header>

        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1">

            <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="XWSSGID-1744864111557507530544">

                <wsse:Username>admin</wsse:Username>

                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">J2/pdCHLjSk+ugfWAI84dlmer68=</wsse:Password>

                <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">abOa3kK0IRVrqkoufMX1OHFD</wsse:Nonce>

                <wsu:Created>2025-04-25T13:33:07.060Z</wsu:Created>

            </wsse:UsernameToken>

        </wsse:Security>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <ns2:getDatasetResponse xmlns:ns2="http://www.elegantjbi.com/ws/DatasetManagement">

            <ns2:status>

                <ns2:statusCode>Success</ns2:statusCode>

            </ns2:status>

            <ns2:dataSet>

                <ns2:datasetId>datasetId.dtst</ns2:datasetId>

                <ns2:displayName>datasetName</ns2:displayName>

                <ns2:Columns>

                    <ns2:columntId>columnId</ns2:columntId>

                    <ns2:displayName>Id</ns2:displayName>

                    <ns2:columnType>columnType</ns2:columnType>

                </ns2:Columns> 

            </ns2:dataSet>

        </ns2:getDatasetResponse>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Postman Example: 

 

You can import the example below into Postman. 

 

curl --location 'https://smartenURL.com/smarten/ws/DatasetManagementService' \

--data '<soapenv:Envelope xmlns:dat="http://www.elegantjbi.com/ws/DatasetManagement" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

   <soapenv:Header>

      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

         <wsse:UsernameToken wsu:Id="UsernameToken-123">

            <wsse:Username>username</wsse:Username>

            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>

         </wsse:UsernameToken>

      </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

      <dat:getDatasetRequest>

         <dat:datasetId>datasetId</dat:datasetId>

      </dat:getDatasetRequest>

   </soapenv:Body>

</soapenv:Envelope>'

 

Tags: API, SOAP API, Dataset, getDataset, SOAP-based web services, SOAP, cURL,