[Index]

API Reference for view/NumberInventoryAudit

New tool that audits line and utility number (Pilots)

Model ref.: view/NumberInventoryAudit

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "iniModel": {
               "default": "Site",
               "choices": [
                    {
                         "value": "Customer",
                         "title": "Customer"
                    },
                    {
                         "value": "Site",
                         "title": "Site"
                    }
               ],
               "type": "string",
               "title": "Is Number Inventory deployed at Customer or Site Level ?"
          },
          "scope": {
               "default": "All",
               "choices": [
                    {
                         "value": "All",
                         "title": "All"
                    },
                    {
                         "value": "Specific",
                         "title": "Specific"
                    }
               ],
               "type": "string",
               "title": "Would you like to audit all sites or a subset of sites ?"
          },
          "site_X": {
               "items": {
                    "attr_props": [
                         {
                              "type": "string",
                              "name": "sites_x",
                              "title": "Chosen Sites"
                         }
                    ],
                    "type": "string"
               },
               "type": "array",
               "title": "Sites"
          },
          "iniNumber": {
               "type": "string",
               "description": "When populated only this number will be audited",
               "title": "Number"
          }
     },
     "schema_version": "3.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/NumberInventoryAudit/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/NumberInventoryAudit 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/NumberInventoryAudit	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/NumberInventoryAudit	POST	/api/view/NumberInventoryAudit/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/NumberInventoryAudit	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Get the on-line Help for view/NumberInventoryAudit.	GET	/api/view/NumberInventoryAudit/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/NumberInventoryAudit 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	Response
Get	GET	/api/view/NumberInventoryAudit/[pkid]	hierarchy=[hierarchy]	The view/NumberInventoryAudit instance with [pkid].

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

API Reference for view/NumberInventoryAudit

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

Get the Add form

Create

Export Bulk Load Template

Help

Instance API Reference

Get

Help