ProcessedFileMetadata

Arbitrary JSON to store against the processed file(s) as metadata.

You can retrieve this later via a GetFileDetails request.

Structure

{
  "merge": Boolean,
  "setForAllArtifacts": Boolean,
  "value": FileMetadata
}

Example

{
  "merge": true,
  "setForAllArtifacts": true,
  "value": {
    "myCustomField1": true,
    "myCustomField2": {
      "hello": "world"
    },
    "anotherCustomField": 42
  }
}

Properties

merge

If true then merges value with the original file's existing data, else uses value as-is.

Default: false

Type: Boolean

Required: No

setForAllArtifacts

If true then sets the value for all files generated by the transformation, else only sets the value for the root output file.

Default: true

Type: Boolean

Required: No

value

The value to set or merge into the field.

Default: empty object / empty array

Type: FileMetadata

Required: No

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

File Uploading

File Processing APIs

Data Types

More Resources

ProcessedFileMetadata

Structure

Example

Properties

merge

setForAllArtifacts

value

Used by

You are using an outdated browser.