API Reference for view/GS_FMCv2_SSUPDATE_VIEW

called by self service for FMC enable/disable

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

For [auth_token]:

The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
Model schemas show that the auth_token parameter is still supported.

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "dn": {
               "type": "string",
               "description": "directory number associated with FMC",
               "title": "dn"
          },
          "username": {
               "type": "string",
               "description": "users username",
               "title": "username"
          },
          "isCliMaskLoaded": {
               "type": "boolean",
               "description": "comes from evaluating macro.GS_FMCv2_CLIMaskInUse_MCR",
               "title": "isCliMaskLoaded"
          },
          "dnE164": {
               "type": "string",
               "description": "comes from evaluating macro.GS_FMCv2_E164orPubNum_MCR with input.dn set to value of dn in view",
               "title": "dnE164"
          },
          "cliOption": {
               "description": "for non CLI mask customers only. Take from GUI for those customers, otherwise E164",
               "title": "cliOption",
               "default": "E164",
               "choices": [
                    {
                         "value": "E164",
                         "title": "E164"
                    },
                    {
                         "value": "msisdn",
                         "title": "msisdn"
                    }
               ],
               "type": "string"
          },
          "fmc": {
               "type": "object",
               "title": "fmc",
               "properties": {
                    "enabled": {
                         "type": "boolean",
                         "description": "enabled/disabled flag from GUI",
                         "title": "enabled"
                    },
                    "mobile": {
                         "type": "string",
                         "description": "mobile number from rd destination",
                         "title": "mobile"
                    },
                    "called_party_transformation_pattern_route_partition": {
                         "type": "string",
                         "description": "comes from evaluating macro.GS_FMCv2_CalledPartyTransPT_MCR",
                         "title": "called_party_transformation_pattern_route_partition"
                    }
               }
          }
     }
}

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

API Reference for view/GS_FMCv2_SSUPDATE_VIEW

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

Get the Add form

Create

Instance API Reference

Get