MENU

📢 March Release Updates coming soon!

    Dynamic Planning: Group Access API
    • 1 Minute to read
    • Dark
    • PDF

    Dynamic Planning: Group Access API

    • Dark
    • PDF

    Article summary

    The Group Access API can be used to update Group Access permission when the number of groups exceeds the UI limit of 20 groups.

    POST: /api/modeling/model//groupAccess/update HTTP/1/1

    Content-Type: application/json or application/xml

    Accept: application/json or application/xml

    X-ACCESS-TOKEN: $ACCESS_TOKEN_GUID$

    Request Payload

    Request payload can include only a subset of the current permissions. Permissions included into request payload will be updated; those not included will keep their current values.

    Request Payload JSON

    {
    "permissions”:  [
    				{"groupName": "Alpha",
    				"artifactType": "Model",
    				"artifactName": "Test Model",
    				"modelName": "", "access": "Yes"},
    
    				{"groupName": "Beta",
    				"artifactType": "View",
    				"artifactName": "Test View",
    				"modelName": "Test Model",
    				"access": "Yes"},
    
    				{"groupName": "Gamma",
    				"artifactType": "Report",
    				"artifactName": "Test Report",
    				"modelName": "", "access": "No"}
    		   		]
    		}
    Shell

    Request Payload XML Sample

    <payload>
        <permissions>
            <permission>
                <group-name>Alpha</group-name>
                <artifact-type>Model</artifact-type>
                <artifact-name>Test Model</artifact-name>
                <model-name></model-name>
                <access>Yes</access>
            </permission>
            <permission>
                <group-name>Beta</group-name>
                <artifact-type>View</artifact-type>
                <artifact-name>Test View</artifact-name>
                <model-name>Test Model</model-name>
                <access>Yes</access>
            </permission>
            <permission>
                <group-name>Gamma</group-name>
                <artifact-type>Report</artifact-type>
                <artifact-name>Test Report</artifact-name>
                <model-name></model-name>
                <access>No</access>
            </permission>
        </permissions>
    </payload>
    Shell

    Parameters

    1. $groupName (group-name) -Name of the group. Group name should be a valid name and case insensitive.

    1. $artifactType (artifact-type) –Artifact type should be one of the following:

      • Model

      • Calculation

      • View

      • Report

    1. $artifactName (artifact-name) - Name of the artifact.

    1. $modelName (model-name) -Model name must be a valid name for Calculation and View. It will be ignored for all other artifacts.

    1. Access - Access should be one of the following:

      • Yes

      • No

     Response Payload

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <payload>
    	<permissions>
        	<permission>
                <group-name>Alpha</group-name>
                <artifact-type>Model</artifact-type>
                <artifact-name>Revenue</artifact-name>
         	   <model-name></model-name>
                <access>Yes</access>
        	</permission>
        	<permission>
                <group-name>Beta</group-name>
                <artifact-type>Report</artifact-type>
            	<artifact-name>Sample Model Report</artifact-name>
                <model-name>Sample_Model</model-name>
                <access>Yes</access>
        	</permission>
        	<permission>
                <group-name>Gamma</group-name>
                <artifact-type>View</artifact-type>
            	<artifact-name>template</artifact-name>
                <model-name>Revenue</model-name>
                <access>Yes</access>
        	</permission>
    	</permissions>
    </payload>
    Shell

    Was this article helpful?