[Index]

API Reference for view/AccessProfileTool

Tool to manage access profiles.

Model ref.: view/AccessProfileTool

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/view/AccessProfileTool/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "hierarchy_level": {
               "default": "{{ fn.hierarchy_friendly_path }}", 
               "readonly": true, 
               "type": "string", 
               "title": "Hierarchy level"
          }, 
          "description": {
               "default": "Access Profile Tool", 
               "readonly": true, 
               "type": "string", 
               "title": " "
          }, 
          "target_hierarchy": {
               "default": "{{ fn.hierarchy_friendly_path }}", 
               "type": "string", 
               "title": "Target Hierarchy"
          }, 
          "access_profile_operation": {
               "choices": [
                    {
                         "value": "create_snippet", 
                         "title": "Create Snippet"
                    }, 
                    {
                         "value": "merge", 
                         "title": "Merge"
                    }
               ], 
               "type": "string", 
               "description": "Access Profile Operation", 
               "title": "Access Profile Operation"
          }, 
          "target_access_profile": {
               "type": "string", 
               "description": "The access profile that will be updated or merged into.", 
               "title": "Target Access Profile"
          }, 
          "source_access_profile_list": {
               "items": {
                    "type": "string"
               }, 
               "type": "array", 
               "title": "Source Access Profile List"
          }, 
          "new_access_profile_name": {
               "type": "string", 
               "description": "Name of the access profile to create.", 
               "title": "New Access Profile Name"
          }, 
          "new": {
               "type": "boolean", 
               "description": "Create a new access profile with a custom name.", 
               "title": "New Access Profile"
          }, 
          "backup": {
               "type": "boolean", 
               "description": "When selected a backup of the target access profile will be made.", 
               "title": "Backup Access Profile"
          }, 
          "notes": {
               "default": "This view allows you to merge access profile items from one access profile to another.", 
               "readonly": true, 
               "type": "string", 
               "title": " "
          }, 
          "source_access_profile": {
               "type": "string", 
               "description": "The access profile that will be merged or updated from.", 
               "title": "Source Access Profile"
          }
     }
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/AccessProfileTool/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/AccessProfileTool as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/view/AccessProfileTool/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for view/AccessProfileTool	POST	/api/view/AccessProfileTool/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/AccessProfileTool	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/AccessProfileTool/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get the on-line Help for view/AccessProfileTool.	GET	/api/view/AccessProfileTool/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/AccessProfileTool as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/view/AccessProfileTool/[pkid]/+tag/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Help	GET	/api/view/AccessProfileTool/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/AccessProfileTool.

API Reference for view/AccessProfileTool

GET http://[host-proxy]/api/view/AccessProfileTool/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Export Bulk Load Template

Configuration Template

Help

Instance API Reference

Tag

Help