[Index]
Model ref.: device/mssecurity/MachineAction
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$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
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/mssecurity/MachineAction |
|
{"hrefs": ["/api/device/mssecurity/MachineAction/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/mssecurity/MachineAction |
|
{"hrefs": ["/api/device/mssecurity/MachineAction/[pkid1]", "/api/device/mssecurity/MachineAction/[pkid2]",...]} |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/mssecurity/MachineAction/ |
|
The device/mssecurity/MachineAction schema and all instances as JSON. |
(The list will return 0 to 3 device/mssecurity/MachineAction instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "type",
"direction": "asc",
"current": "/api/device/mssecurity/MachineAction/?skip=0&limit=3&order_by=type&direction=asc&traversal=down"
},
"operations": [
"list"
],
"meta": {
"model_type": "device/mssecurity/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": []
},
"model_specific_actions": [
"list",
"get",
"move"
],
"schema_version": "1.0",
"actions": [
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/mssecurity/MachineAction",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/mssecurity/MachineAction/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/mssecurity/MachineAction/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/mssecurity/MachineAction/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/mssecurity/MachineAction | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/mssecurity/MachineAction/[pkid] | hierarchy=[hierarchy] | The device/mssecurity/MachineAction instance with [pkid]. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/mssecurity/MachineAction/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |