Akomi API Info

Akomi XML API info (4-2016)

Note: This document is currently under review and should be considered a draft. Contact North Shore support before undertaking any serious development based on this information

Akomi has an XML based API for data input and update operations.

All data output from Akomi is to CatDV Server via the CatDV REST API

The current input and update operations supported via XML input are:

• • Asset publishing

    • Send

      • CatDV formatted XML

      • Primary Media Format (Proxy)

    • Optional

      • Thumbnail

      • Alternate formats

  • Asset metadata update

    • Send

      • CatDV formatted XML

      • Overwrites all fields with data from CatDV

        • As CatDV is instantly updated with data coming back from Akomi this is not an issue for sync

        • Note: Event Markers are not sent from CatDV, only written back from Akomi

  • Asset media update

    • Send

      • CatDV formatted XML

      • Primary Media Format (Proxy)

    • Optional

      • Thumbnail

      • Alternate formats

    • Any new version of a media asset, sent with an XML will replace any previously existing  version

    • New Alternate Formats will be added to the record

  • Asset deletion

    • Send

      • Akomi deletion XML

      • See Sample Below

  • Account creation

    • Send

      • Akomi account creation XML

The current output operations supported via CatDV REST API are:

• • Automatic metadata update to CatDV upon editing a field in Akomi

    • This includes Event Markers & Comments, which are both excluded from XML ingest and only originate in Akomi

  • Download Request

    • HiRes Request/HighRes Send

      • Send field values:

        • User/Email

        • Date & Time of Request

        • Set “Request” Field to trigger Worker Node action

      • ###

Akomi XML Samples

Akomi Import XML

See article here: http://kb.northshoreautomation.com/akomi-portal/akomi-admin-guide-1/akomi-tech-faq-articles#TOC-XML-format-for-Akomi-import

Akomi Deletion XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<akomiCommand version="20140710">

<deleteRecord>

<filename>nsa-test.mov</filename>

<clipref>BEFE89CD8</clipref>

<mediapath>/Volumes/SAN/media/nsa-test.mov</mediapath>

<datetimeReceived>2014-08-01T23:20:22-0500</datetimeReceived>

</deleteRecord>

</akomiCommand>

Akomi User Creation XML

<?xml version="1.0" encoding="utf-8" standalone="yes"?><akomiCommand version="2015-1022">

<createUser><username>user@fake-co.com</username><email>user@fake-co.com</email><firstname>User</firstname><lastname>Name</lastname><company>Fake Co. Inc</company>

<group>

<groupname>Global</groupname>

<edit>false</edit>

<download>true</download>

<share>true</share>

<delete>false</delete>

<hires>false</hires>

</group>

<valid-to>2050-01-01T00:00:00-000</valid-to>

<mark_viewed>true</mark_viewed>

<approve_reject>true</approve_reject>

<edit_users>true</edit_users>

<access_library>true</access_library>

<move_to_library>false</move_to_library>

<upload_inbox>false</upload_inbox>

<upload_library>false</upload_library>

<email_notifications>false</email_notifications>

<daily_digest>true</daily_digest>

<active>1</active>

<datetimeReceived>2016-03-21T04:09:05-000</datetimeReceived>

</createUser>

</akomiCommand>

Note: This document is currently under review and should be considered a draft. Contact North Shore support before undertaking any serious development based on this information