[Index]

API Reference for view/GS_FMCConvert_VIEW

Model ref.: view/GS_FMCConvert_VIEW

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 [auth_token]:
1. The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
2. Model schemas show that the auth_token parameter is still supported.

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "bulkConvert": {
               "default": "true",
               "type": "boolean",
               "title": "Convert all users at this site"
          },
          "TransformPatternCount": {
               "type": "string",
               "description": "Number of anti-loop transformation patterns at this site",
               "title": "Total number of FMC transformations"
          },
          "CIMCount": {
               "type": "string",
               "description": "Number of Carrier Integrated Mobile devices at this site",
               "title": "Total number of Carrier Integrated Mobile devices"
          },
          "username": {
               "type": "string",
               "description": "User to convert",
               "title": "Username"
          },
          "duplicateScope": {
               "description": "Scope of check for duplicate mobile number, or disable the check. Note that duplicate mobile numbers can cause functional problems.",
               "title": "Scope of duplicate check",
               "default": "provider",
               "choices": [
                    {
                         "value": "provider",
                         "title": "Provider"
                    },
                    {
                         "value": "customer",
                         "title": "Customer"
                    },
                    {
                         "value": "disabled",
                         "title": "Disabled"
                    }
               ],
               "type": "string"
          }
     }
}

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

API Reference for view/GS_FMCConvert_VIEW

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

Get the Add form

Create

Instance API Reference