l4i
...
Box Connection
File Operations

Update File

1min

This method will Update an existing file in box. The method allows for either a file update, which versions the document, or an update to the Box metadata, which does not version the document.

Input Parameters:

  • File ID: ID of the document to update
  • File Content: (Optional - when provided versions the document)
  • Metadata Values: These are the values for either Enterprise Metadata (defined in a metadata template) or Global Metadata (string value pairs directly attributed to a document)
    • Click on the pencil icon in the top right to edit the definition of metadata
    • Drag an 'Available Parameter' from the Available Parameters to the middle section called 'Defined Parameters'
    • There are three types of Parameters
      • Description: This allows the setting of the description on the document. No additional configuration/naming is required. The name should be left as 'Description' and the datatype left as 'String'
      • Enterprise Metadata Value: This allows setting of Enterprise Metadata that is defined on a pre-defined Metadata Template.
        • Name: This is required to be the name of the metadata value defined in Box. It will include the Metadata Template name that it is assoicated with. (e.g. trexMetadata.trexTextField)
        • Data Type: The type value assigned in the Box metadata definition
      • Global Metadata Value: This allows the setting of key/value pair strings to be added to a document
        • Name: This should match the metadata value of a Custom Attribute already defined on the document. it will always be prefixed with the value 'document' followed by the name of the box value (e.g. document.trexMyCustomString)