[Index]

API Reference for view/SystemUserAudit

VIEW that wraps System User Audit.

Model ref.: view/SystemUserAudit

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "notes": {
               "title": "Info",
               "type": "string",
               "readonly": true,
               "default": "!!!ATTENTION!!!\n\nRunning this tool at a higher hierarchy can severely impact performance. Please execute with caution!\n\nAudit actions performed:\n- Create system users for associated vendor users if missing\n- Update system user sync source and service status\n- Align system user hierarchy to match the associated vendor user\n\nNote: If 'Create a Report' is selected, no changes are made\u2014only a .csv report is generated for download."
          },
          "hierarchy_level": {
               "title": "Select a hierarchy",
               "description": "Choose a hierarchy to run the audit from.",
               "type": "string",
               "required": true,
               "readonly": false,
               "displayable": true
          },
          "create_report": {
               "title": "Create a report",
               "description": "Generate a .csv report for further impact analysis. This option will take precedence over processing of the system user audit.",
               "type": "boolean",
               "required": false,
               "readonly": false,
               "default": "true"
          },
          "confirm": {
               "title": "Confirmation",
               "description": "Confirmation of System User Audit execution",
               "type": "string",
               "required": true,
               "default": "",
               "choices": [
                    {
                         "value": "yes",
                         "title": "Yes, I confirm that the System User Audit can be run."
                    }
               ]
          }
     }
}

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/SystemUserAudit/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

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

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

API Reference for view/SystemUserAudit

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

Get the Add form

Create

Tag

Configuration Template

Help

Instance API Reference

Tag

Help