Set Dataset Data Permission Request

Modified on Wed, 21 May at 7:18 PM

Description: 

This API is used to assign or update dataset-level data access permissions for specific users and roles.


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 

<dat:permissions>

String

Wrapper for access permissions (can repeat).

<dat:rolename>

String

Role name to which access is granted.

<dat:userName>

String

User for which permission is to be configured.


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-18365B4E2F836D831816944182320932">

            <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:setDatasetDataPermissionRequest>

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

         <!--Zero or more repetitions:-->

         <dat:permissions>

            <dat:dataAccessPermissionId></dat:dataAccessPermissionId>

            <dat:roles>

               <dat:roleName>Role</dat:roleName>

               <dat:read>true</dat:read>

            </dat:roles>

            <!--Zero or more repetitions:-->

            <dat:users>

               <dat:userName>username</dat:userName>

               <dat:read>true</dat:read>

            </dat:users>

         </dat:permissions>

      </dat:setDatasetDataPermissionRequest>

   </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

 

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-1747337693638-1069532304">

                <wsse:Username>user</wsse:Username>

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

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

                <wsu:Created>2025-05-19T11:58:34.880Z</wsu:Created>

            </wsse:UsernameToken>

        </wsse:Security>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

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

            <ns2:status>

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

            </ns2:status>

            <ns2:id>61</ns2:id>

        </ns2:setDatasetDataPermissionResponse>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Postman Example: 

 

You can import the example below into Postman. 

curl --location 'https://<SMARTENURL>/smarten/ws/DatasetManagementService' \

--header 'Cookie: JSESSIONID=yBAcu2wemGRUuCsZB_5-wmDLJKS0Sngf6oHMksQM.ip-172-31-8-13' \

--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-18365B4E2F836D831816944182320932">

            <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:setDatasetDataPermissionRequest>

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

         <!--Zero or more repetitions:-->

         <dat:permissions>

            <dat:dataAccessPermissionId></dat:dataAccessPermissionId>

            <dat:roles>

               <dat:roleName>role</dat:roleName>

               <dat:read>true</dat:read>

            </dat:roles>

            <!--Zero or more repetitions:-->

            <dat:users>

               <dat:userName>username</dat:userName>

               <dat:read>true</dat:read>

            </dat:users>

         </dat:permissions>

      </dat:setDatasetDataPermissionRequest>

   </soapenv:Body>

</soapenv:Envelope>'


Tags: Dataset Permission, Permissions, User permissions, Data access permissions,

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article