[Index]

API Reference for view/OffboardAssuranceAssets

This tool offboards selected assets and related config off of a selected Assurance arbitrator server.

Model ref.: view/OffboardAssuranceAssets

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "arbitrator": {
               "required": true,
               "type": "string",
               "description": "Select an Arbitrator server from which to remove an asset.",
               "title": "Assurance Arbitrator Server"
          },
          "arbitrator_pkid": {
               "type": "string",
               "description": "Hidden field to store the selected arbitrator's PKID.",
               "title": "Assurance Arbitrator PKID"
          },
          "assets": {
               "description": "Select one or more assets to remove.",
               "title": "Assets",
               "items": {
                    "type": "string"
               },
               "required": true,
               "type": "array"
          }
     },
     "schema_version": "1.1"
}

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/OffboardAssuranceAssets/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
Field Display Policy	GET	/api/view/OffboardAssuranceAssets/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy 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/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get the on-line Help for view/OffboardAssuranceAssets.	GET	/api/view/OffboardAssuranceAssets/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/OffboardAssuranceAssets 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	Response
Get	GET	/api/view/OffboardAssuranceAssets/[pkid]	hierarchy=[hierarchy]	The view/OffboardAssuranceAssets instance with [pkid].

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

API Reference for view/OffboardAssuranceAssets

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

Get the Add form

Create

Export Bulk Load Template

Configuration Template

Field Display Policy

Help

Instance API Reference

Get

Help