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 Optional

If true then merges value with the settings from the original file, giving precedence to value.

If false then uses value as-is, ignoring the settings from the original file.

Default: false

Type: Boolean

setForAllArtifacts Optional

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

value Optional

The value to set into the field.

Default: empty object / empty array

Type: FileMetadata

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:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

ProcessedFileMetadata

Structure

Example

Properties

merge Optional

setForAllArtifacts Optional

value Optional

Used by

You are using an outdated browser.