‘file’ Structure

The 'file' structure represents file property of activity and inventory. Its format is more complex than that of a regular property. The 'file' structure consists of the following elements:

'file' structure elements

Name

Required

Type

Description

property_label

Yes

string

name of the file property, unique for the corresponding property list

filename

Yes

string

original file name with extension

mime_type

Yes

string

MIME type of the file

encoding

Yes

string

encoding of the 'contents' node

valid values: 'plain-text' or 'base64'

contents

Yes

string

file contents, in either plain text or base64

maximum file size is 512000 bytes but the Base64-encoded file may be larger – it is only checked after being decoded

  • 'file' Structure Example

<files> 
	<file> 
		<property_label>ii_fileprop</property_label> 
		<filename>bummer.txt</filename> 
		<mime_type>application/octet-stream</mime_type> <
		encoding>base64</encoding> 
		<contents> 
			Tm90IGEgd29yZCBmcm9tIHRoZWlyIG1vdXRoIGNhbiBiZSB0cnVzdGVkOwp0a GVpciBoZWFydCBpcyBmaWxsZWQgd2l0aCBkZXN0cnVjdGlvbi4KVGhlaXIgdG hyb2F0IGlzIGFuIG9wZW4gZ3JhdmU7CndpdGggdGhlaXIgdG9uZ3VlIHRoZXk gc3BlYWsgZGVjZWl0Lg== 
		</contents> 
	</file> 
</files>