API Reference for relation/MachineAction

MachineAction Relation

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "id": {
               "title": "Action ID",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "type": {
               "title": "Action Type",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "scope": {
               "title": "Scope",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "requestor": {
               "title": "Requestor",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "requestorComment": {
               "title": "Requestor Comment",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "status": {
               "title": "Status",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "machineId": {
               "title": "Machine ID",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "computerDnsName": {
               "title": "Computer DNS Name",
               "type": "string",
               "readonly": true,
               "maxLength": 1024
          },
          "creationDateTimeUtc": {
               "title": "Creation Date Time UTC",
               "type": "string",
               "format": "date-time",
               "readonly": true,
               "maxLength": 1024
          },
          "lastUpdateTimeUtc": {
               "title": "Last Update Time UTC",
               "type": "string",
               "format": "date-time",
               "readonly": true,
               "maxLength": 1024
          },
          "relatedFileInfo": {
               "title": "Related File Info",
               "type": "object",
               "properties": {
                    "fileIdentifier": {
                         "title": "File Identifier",
                         "type": "string",
                         "readonly": true,
                         "maxLength": 1024
                    },
                    "fileIdentifierType": {
                         "title": "File Identifier Type",
                         "type": "string",
                         "readonly": true,
                         "maxLength": 1024
                    }
               },
               "readonly": true
          },
          "NoInstance": {
               "title": "No Instance",
               "type": "array",
               "items": {
                    "type": "object",
                    "properties": {
                         "name": {
                              "title": "Name",
                              "type": "string",
                              "maxLength": 1024,
                              "required": true,
                              "readonly": false,
                              "is_password": false,
                              "displayable": false
                         }
                    }
               }
          }
     }
}

Task	Call	URL	Parameters	Response
List	GET	/api/relation/MachineAction/	hierarchy=[hierarchy] format=json schema=true	The relation/MachineAction schema and all instances as JSON.

(The list will return 0 to 3 relation/MachineAction instances)

GET http://[host]/api/relation/MachineAction/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "type",
          "direction": "asc",
          "current": "/api/relation/MachineAction/?skip=0&limit=3&order_by=type&direction=asc&traversal=down"
     },
     "operations": [
          "add",
          "list",
          "update",
          "export",
          "remove",
          "help",
          "configuration_template",
          "field_display_policy",
          "bulk_update",
          "get",
          "export_bulkload_template"
     ],
     "meta": {
          "model_type": "relation/MachineAction",
          "summary_attrs": [
               {
                    "name": "type",
                    "title": "Action Type"
               },
               {
                    "name": "status",
                    "title": "Status"
               },
               {
                    "name": "computerDnsName",
                    "title": "Computer DNS Name"
               },
               {
                    "name": "requestor",
                    "title": "Requestor"
               },
               {
                    "name": "creationDateTimeUtc",
                    "title": "Creation Date Time UTC"
               },
               {
                    "name": "lastUpdateTimeUtc",
                    "title": "Last Update Time UTC"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "",
          "business_key": {},
          "api_version": "21.2",
          "cached": true,
          "references": {
               "children": [],
               "parent": [
                    {
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
                         "pkid": "6t0ggef2c0deab00hb595101"
                    }
               ],
               "device": [
                    {
                         "href": "",
                         "pkid": ""
                    }
               ],
               "foreign_key": [],
               "self": [
                    {
                         "href": "/api/relation/MachineAction/None/",
                         "pkid": null
                    }
               ]
          },
          "model_specific_actions": [
               "add",
               "export",
               "list",
               "update",
               "remove",
               "get",
               "export_bulkload_template"
          ],
          "schema_version": null,
          "actions": [
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/relation/MachineAction/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               }
          ]
     },
     "resources": []
}

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/relation/MachineAction/[pkid]	hierarchy=[hierarchy]	The relation/MachineAction instance with [pkid].

Task	Call	URL	Parameters	Payload
Cancel	POST	/api/relation/MachineAction/[pkid]/+Cancel	hierarchy=[hierarchy]	If payload required:

API Reference for relation/MachineAction

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

List

GET http://[host]/api/relation/MachineAction/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Instance API Reference

Get

Cancel