API Reference for view/INI_Purge_Tool_View

Tool to purge Number Inventory entries overriding guardrails allowing re-audit.

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

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.

as UUID. For example: 6t0ggef2c0deab00hb595101
in dot notation. E.g. ProviderName.CustomerName.LocationName

[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/INI_Purge_Tool_View/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "range_end": {
               "type": "string", 
               "title": "Range End Number"
          }, 
          "specific": {
               "type": "string", 
               "title": "Select specific Number"
          }, 
          "range_begin": {
               "type": "string", 
               "title": "Range Start Number"
          }, 
          "ini_option": {
               "default": "all", 
               "choices": [
                    {
                         "value": "all", 
                         "title": "All Number Inventory entries at current Hierarchy"
                    }, 
                    {
                         "value": "range", 
                         "title": "Range of Number Inventory entries"
                    }, 
                    {
                         "value": "picked", 
                         "title": "Selected list of Number Inventory entries"
                    }, 
                    {
                         "value": "specific", 
                         "title": "Specific Number Inventory entry"
                    }
               ], 
               "type": "string", 
               "description": "Define Purge Scope - All, List, Specific entry", 
               "title": "Purge Scope"
          }, 
          "picked_entries": {
               "items": {
                    "type": "string"
               }, 
               "type": "array", 
               "title": "Select list of Numbers"
          }
     }, 
     "schema_version": "1.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/INI_Purge_Tool_View/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/INI_Purge_Tool_View 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/INI_Purge_Tool_View/	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.

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	Response
Get	GET	/api/view/INI_Purge_Tool_View/[pkid]/	hierarchy=[hierarchy]	The view/INI_Purge_Tool_View instance with [pkid].

API Reference for view/INI_Purge_Tool_View

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

Get the Add form

Create

Instance API Reference

Get