[Index]

API Reference for view/UcsMaintainMultiInternalNumberInventoryVIEW

View to add, modify and delete Internal Number Inventory in a range. Enter the start and end of the range and a set of internal number inventory numbers will be created or deleted at the current hierarchy level. For single range make the start and end the same number.

Model ref.: view/UcsMaintainMultiInternalNumberInventoryVIEW

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "start_number": {
               "pattern": "^[0-9]*$", 
               "type": "string", 
               "description": "Start number of the range to create or delete.", 
               "title": "Start Number"
          }, 
          "end_number": {
               "pattern": "^[0-9]*$", 
               "type": "string", 
               "description": "End number of the range to create or delete.", 
               "title": "End Number"
          }, 
          "description": {
               "type": "string", 
               "description": "Description field", 
               "title": "Description"
          }, 
          "extra1": {
               "type": "string", 
               "description": "Extra field 1", 
               "title": "Extra1"
          }, 
          "e164number": {
               "pattern": "^\\+?[1-9]\\d{1,14}$", 
               "type": "string", 
               "description": "Number in E164 format", 
               "title": "E164Number"
          }, 
          "extra2": {
               "type": "string", 
               "description": "Extra field 2", 
               "title": "Extra2"
          }, 
          "tag": {
               "type": "string", 
               "description": "Tag used for filtering INI numbers. This can be any free text to identify or comment a range of internal numbers.", 
               "title": "Tag"
          }, 
          "extra4": {
               "type": "string", 
               "description": "Extra field 4", 
               "title": "Extra4"
          }, 
          "extra5": {
               "type": "string", 
               "description": "Extra field 5", 
               "title": "Extra5"
          }, 
          "extra6": {
               "type": "string", 
               "description": "Extra field 6", 
               "title": "Extra6"
          }, 
          "extra7": {
               "type": "string", 
               "description": "Extra field 7", 
               "title": "Extra7"
          }, 
          "extra8": {
               "type": "string", 
               "description": "Extra field 8", 
               "title": "Extra8"
          }, 
          "extra9": {
               "type": "string", 
               "description": "Extra field 9", 
               "title": "Extra9"
          }, 
          "operation": {
               "default": "add", 
               "choices": [
                    {
                         "value": "add", 
                         "title": "Add"
                    }, 
                    {
                         "value": "modify", 
                         "title": "Modify"
                    }, 
                    {
                         "value": "delete", 
                         "title": "Delete"
                    }
               ], 
               "type": "string", 
               "description": "Select operation Add, Modify or Delete.", 
               "title": "Operation"
          }, 
          "extra3": {
               "type": "string", 
               "description": "Extra field 3", 
               "title": "Extra3"
          }
     }, 
     "schema_version": "2.0"
}

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

Task	Call	URL	Parameters	Response
Get the on-line Help for view/UcsMaintainMultiInternalNumberInventoryVIEW.	GET	/api/view/UcsMaintainMultiInternalNumberInventoryVIEW/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/UcsMaintainMultiInternalNumberInventoryVIEW 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/UcsMaintainMultiInternalNumberInventoryVIEW/[pkid]/+tag/	hierarchy=[hierarchy]	If payload required:

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

API Reference for view/UcsMaintainMultiInternalNumberInventoryVIEW

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

Get the Add form

Create

Export Bulk Load Template

Help

Instance API Reference

Tag

Help