How to write to a custom field using the FileWave API

How

Writing JSONback Result

"CustomFields__school_type":a {Custom "updateTime":Field null,relies "value":upon "None",the "type":following "string"details:
},

Some {Custom "updateTime":Fields "2020-07-28T19:15:34.568518Z",may "value":have "2019-05-28T15:15:09.672000Z",restricted "type":values.  "datetime"Only },one "CustomFields__school_name":of {these "updateTime":values "2020-07-28T19:15:34.571554Z",should "value":be "Deckardposted ES",in "type":the "string"API }

"CustomFields__school_type": {
"updateTime": null,
"value": "None",
"type": "string"
},
"CustomFields__user_role": {
"updateTime": null,
"value": "Student",
"type": "string"
},
"CustomFields__asset_tag": {
"updateTime": "2020-07-28T18:47:20.604074Z",
"value": "FW-123456",
"type": "string"
},
"CustomFields__phase_1": {
"updateTime": null,
"value": false,
"type": "bool"
},
"CustomFields__image_date": {
"updateTime": "2020-07-28T19:15:34.568518Z",
"value": "2019-05-28T15:15:09.672000Z",
"type": "datetime"
},
"CustomFields__school_name": {
"updateTime": "2020-07-28T19:15:34.571554Z",
"value": "Deckard ES",
"type": "string"
}

#!/bin/zsh

SERVER=# Environment Variables
# $auth - base64 authentication token
# $device_id  - Device ID

server_fqdn=$(defaults read /usr/local/etc/fwcld.plist server) TOKEN=# FW Server FQDN
serial_number=$(ioreg -l -d 2 | awk -F "base_64_token"\"" DATE='/IOPlatformSerialNumber/ {print $(NF-1)}') # device serial number

It is of course possible that all of these values could be supplied to the script as Executable variables.

The start of a PowerShell script may look like:

# Environment Variables
# $Env:auth - base64 authentication token
# $Env:device_id - Device ID
# $Env:serial_number - device serial number
# $Env:server_fqdn - FW Server FQDN

Reading a Custom Field

It may be necessary to read the Custom Field during the script execution.  A JSON will be required for the data portion of the command:

{"criteria":
  {
    "column":"serial_number",
    "component":"Client",
    "operator":"is",
    "qualifier":'\"$serial_number\"'
  },
  "fields":
  [
    {
      "column":"apple_battery_replace_2015",
      "component":"CustomFields"
    }
  ],
  "main_component":"Client"
}

To continue the scripts, this could be assigned in the script as a variable

macOS script:

query='{"criteria":{"column":"serial_number","component":"Client","operator":"is","qualifier":'\"$serial_number\"'},"fields":[{"column":"apple_battery_replace_2015","component":"CustomFields"}],"main_component":"Client"}'

Windows PowerShell:

$query = '{"criteria":{"column":"serial_number","component":"Client","operator":"is","qualifier":"' + $serial_number + '"},"fields":[{"column":"apple_battery_replace_2015","component":"CustomFields"}],"main_component":"Client"}'

With the server details and JSON configured, it is now possible to read the value with a command:

macOS script:

curl -s -H "Authorization: $auth" https://$server_fqdn:20445/inv/api/v1/query_result/ --data $query -H "Content-Type: application/json"

The response may look something like:

{"offset":0,"fields":["CustomFields_apple_battery_replace_2015"],"values":[["Replaced"]],"filter_results":1,"total_results":1,"version":0}

Windows PowerShell script:

$header = @{Authorization=“$auth"}
$api = "https://" + $server_dns + ":20445/inv/api/v1/query_result/"

Invoke-RestMethod -Method GET -Headers $header -Uri $api

Due to this being a Custom Field designed for an Apple replacement programme, hopefully the response will look something like:

{"offset":0,"fields":["CustomFields_apple_battery_replace_2015"],"values":[["NA"]],"filter_results":1,"total_results":1,"version":0}

Handling JSON response

As noted earlier, since the response is also a JSON block, the desired information is somewhat buried within the response.  Windows PowerShell has tools to directly work with JSON and as such the desired item is more easily attainable.  

ConvertFrom-Json

ConvertTo-Json

macOS on the other hand, it would be beneficial to either instal Python and use Pythons tools to extract the response or get crazy with a tool like 'AWK'.

curl -s -H "Authorization: $auth" \
  https://$server_fqdn:20445/inv/api/v1/query_result/ \
  --data $query -H "Content-Type: application/json" \
  | awk -F  '[\\\[|\\\]]' '{gsub(/\"/,"",$0);print  substr( $(NF-2), 1, length($(NF-2)))}'

Response with AWK:

Replaced

Writing a Custom Field

Once the script has continued and actioned anything else desired, it then may be desirable to set the Custom Field to a new value, which may vary depending upon the outcome of the scripting.

In this example, we will consider the script will be writing back NA to the Custom Field:

current_time=$(date -u +"%Y-%m-%dT%H:%M:%SZ"FT%TZ")
TAG="FW-198724"
DEVICE=$1
QUERY=data='{"CustomFields":{"asset_tag"apple_battery_replace_2015":{"exitCode":null,"status":0,"updateTime":"'$DATE'current_time'","value":"'$TAG'"NA"}}}'

curl -X PATCH https://$SERVER:server_fqdn:20445/inv/api/v1/client/$DEVICEdevice_id -Hd "authorization: $TOKEN" -H 'cache-control: no-cache'data" -H 'content-type: application/json'  -d $QUERY
 
exit 0

$server = (Get-ItemProperty -Path REgistry::HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\FileWave\WinClient).server
$token = "base_64_token"
$api = "https://" + $server +  ":20445/inv/api/v1/client/" + $args[0]
$header = @{Authorization=$token}
$date = Get-Date -Format "o"
$tag = "FW-198724"
$data = '{"CustomFields":{"asset_tag":{"exitCode":null,"status":0,"updateTime":"' + $date + '","value":"' + $tag + '"}}}'
  
Invoke-RestMethod -Method PATCH -Headers $header -Body $data -ContentType application/json -Uri $api

#!/bin/zsh
SERVER=$(defaults read /usr/local/etc/fwcld.plist server)
TOKEN="base_64_token"
DATE=$(date -u +"%Y-%m-%d %H:%M:%S")
DEVICE=$1
QUERY='{"CustomFields":{"image_date":{"exitCode":null,"status":0,"updateTime":"'$DATE'","value":"'$DATE'"}}}'
 
curl -X PATCH https://$SERVER:20445/inv/api/v1/client/$DEVICEs -H '"authorization: '$TOKEN''auth_key"
-H 'cache-control: no-cache' -H 'content-type: application/json' -d $QUERY

$server = (Get-ItemProperty -Path REgistry::HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\FileWave\WinClient).server
$token = "base_64_token"
$api = "https://" + $server +  ":20445/inv/api/v1/client/" + $args[0]
$header = @{Authorization=$token}
$date = Get-Date -Format "o"
$data = '{"CustomFields":{"image_date":{"exitCode":null,"status":0,"updateTime":"' + $date + '","value":"' + $date + '"}}}'
 
Invoke-RestMethod -Methodthe PATCH -Headersoption, $headersince -Bodyan $dataalready -ContentTypeexisting application/json -Uri $api

#!/bin/zsh
SERVER=$(defaults read /usr/local/etc/fwcld.plist server)
TOKEN="base_64_token"
DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
FLAG=1
DEVICE=$1
QUERY='{"CustomFields":{"phase_1":{"exitCode":null,"status":0,"updateTime":"'$DATE'","value":"'$FLAG'"}}}'
 
curl -X PATCH https://$SERVER:20445/inv/api/v1/client/$DEVICE -H 'authorization: '$TOKEN'' -H 'cache-control: no-cache' -H 'content-type: application/json' -d $QUERY

$server = (Get-ItemProperty -Path REgistry::HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\FileWave\WinClient).server
$token = "base_64_token"
$api = "https://" + $server +  ":20445/inv/api/v1/client/" + $args[0]
$header = @{Authorization=$token}
$date = Get-Date -Format "o"
$flag = 1
$data = '{"CustomFields":{"phase_1":{"exitCode":null,"status":0,"updateTime":"' + $date + '","value":"' + $flag + '"}}}'
  
Invoke-RestMethod -Method PATCH -Headers $header -Body $data -ContentType application/json -Uri $api