[Index]

API Reference for view/GS_LinkedSite_UpdateChildRoleName_VIEW

VIEW to trigger rename of roles at child sites. This is required if the parent is to be renamed

Model ref.: view/GS_LinkedSite_UpdateChildRoleName_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.

• [pkid] is the ID of the resource instance. Refer to the List reference below.
• [filename] refers to a file

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "oldSiteName": {
               "readonly": true,
               "type": "string",
               "title": "Current Site Name"
          },
          "newSiteName": {
               "readonly": false,
               "type": "string",
               "title": "New Site Name"
          },
          "confirm": {
               "description": "Confirmation role name update",
               "title": "Confirmation",
               "required": true,
               "choices": [
                    {
                         "value": "yes",
                         "title": "Yes, I confirm"
                    }
               ],
               "type": "string"
          }
     },
     "schema_version": "0.1"
}
    

tool/Transaction/[trans pkid]

Instance API Reference

• [pkid] is the ID of the resource instance.
• If a payload is required, inspect the schema for payload details.