Resource settings:settings

Overview

The settings:settings resource provides links to query and manipulate the settings of a system.

Properties

The settings:settings resource has no properties.

Link Relations

settings:root-section

Get the resource representing the very root section.

settings:section-by-path

Retrieves the resource representing the specified section.

Description

The settings:settings resource provides links to query and manipulate the settings of a system.

Known settings

Setting

Description

Section: avid-pmplus

Section: avid-pmplus/system-settings

Section: avid-pmplus/system-settings/property-layout

RegisterNewUserPropertiesAutomatically

Register new user properties automatically

  • System: Avid Production Management

  • Type: boolean

EnableNewResolutionsAutomatically

Enable used resolutions automatically

  • System: Avid Production Management

  • Type: boolean

Section: avid-pmplus/system-settings/production-media-services

ArchiveSegmentSize

Archive Segment Size (frames)

  • System: Avid Production Management

  • Type: integer (1, 99999)

  • Flags: "deletable"

ArchiveEngine

Production Archive Engine

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

BestEffortRestore

Use best effort restore

  • System: Avid Production Management

  • Type: boolean

OptimizedPartialRestore

Optimized partial restore

  • System: Avid Production Management

  • Type: enum ("Enabled (process clip when available)", "Disabled (wait for clip list verification)")

PMSEngine

Production Media Services Engine

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

Section: avid-pmplus/system-settings/sequence-aaf-backup

SequenceAAFBackupEnabled

Enable backup copy of Sequence AAF during check-in

  • System: Avid Production Management

  • Type: boolean

SequenceAAFBackupSameUser

Create backup for check-in by different user only

  • System: Avid Production Management

  • Type: boolean

Section: avid-pmplus/system-settings/application-database-settings

Section: avid-pmplus/system-settings/application-database-settings/audio-effects

CenterPannedSound

Center-Panned Sound on Tape and Voice Over

  • System: Avid Production Management

  • Type: boolean

  • Flags: "deletable"

DissolveDuration

Dissolve Duration [frames]

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-patching

SoundOnTape

Sound on Tape

  • System: Avid Production Management

  • Type: enum ("1-Channel", "2-Channel")

  • Flags: "deletable"

NaturalSound

Natural Sound

  • System: Avid Production Management

  • Type: enum ("1-Channel", "2-Channel")

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-general-settings

AudioSampleRate

Audio Sample Rate

  • System: Avid Production Management

  • Type: enum ("48kHz")

Ducking

Ducking [-dB]

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

AudioFileFormat

Audio File Format

  • System: Avid Production Management

  • Type: enum ("PCM")

MediaCreationWorkspace

Media Creation Workspace

  • System: Avid Production Management

  • Type: enum

  • Flags: "computed", "deletable"

SampleBitDepth

Sample Bit Depth

  • System: Avid Production Management

  • Type: enum ("16", "24")

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-general-settings/format

VideoFormat

Video Format

  • System: Avid Production Management

  • Type: enum ("NTSC_23_976P", "NTSC_24P", "NTSC_30I", "HDOFFLINE_23_976P", "PAL_24P", "PAL_25P", "PAL_25I", "HD1080I_50", "HD1080I_60", "HD1080P_23_976", "HD1080P_24", "HD1080P_25", "HD1080P_30", "HD720P_60", "HD720P_30", "HD720P_23_976", "HD720P_50", "Any")

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-general-settings/audio-storyline-audio-patching

SoundOnTapeTrack1

Sound on Tape Track 1

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5")

  • Flags: "deletable"

SoundOnTapeTrack2

Sound on Tape Track 2

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5")

  • Flags: "deletable"

VoiceOverTrack

Voice Over Track

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5")

  • Flags: "deletable"

NaturalSoundTrack1

Natural Sound Track 1

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5")

  • Flags: "deletable"

NaturalSoundTrack2

Natural Sound Track 2

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5")

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-general-settings/auto-reservation

Duration

Duration [h]

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

AssetTypes

Asset Types Triggering Auto Reservation

  • System: Avid Production Management

  • Type: list of enum ("All", "Masterclip", "Sequence", "Subclip", "Group", "Motion Effect", "Effect", "Render Effect", "Stereoscopic Masterclip", "Stereoscopic Subclip")

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-general-settings/check-in-and-check-out

BackgroundCheckIn

Use Background Check-in from Editors

  • System: Avid Production Management

  • Type: boolean

  • Flags: "deletable"

UpdateRestrictions

Update Restrictions on Check Out

  • System: Avid Production Management

  • Type: boolean

  • Flags: "deletable"

CheckInBins

Check in Bins when closing

  • System: Avid Production Management

  • Type: enum ("Always check in", "Never check in", "Ask user")

  • Flags: "deletable"

UpdateMasterClip

Update Masterclip during Subclip Checkout

  • System: Avid Production Management

  • Type: boolean

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-track-labels

SoundOnTapeLabel

Sound on Tape Label

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

NaturalSoundLabel

Natural Sound Label

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

VoiceOverLabel

Voice Over Label

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/send-to-playback

SampleRate

Sample Rate

  • System: Avid Production Management

  • Type: enum ("32kHz", "44.1kHz", "48kHz", "96kHz")

  • Flags: "deletable"

SecondaryTargetField

Secondary Target Field * System: Avid Production Management

  • Type: string

  • Flags: "deletable"

TargetResPrimary

Primary Target Resolution

  • System: Avid Production Management

  • Type: enum

  • Flags: "computed", "deletable"

TargetResSecondary

Secondary Target Resolution

  • System: Avid Production Management

  • Type: enum

  • Flags: "computed", "deletable"

AudioMixdownMode

Audio Mixdown Mode

  • System: Avid Production Management

  • Type: enum ("Mono", "Stereo", "Direct Out")

  • Flags: "deletable"

AudioTargetResolution

Audio Target Resolution

  • System: Avid Production Management

  • Type: enum ("PCM")

BitDepth

Bit Depth

  • System: Avid Production Management

  • Type: enum ("16", "24")

  • Flags: "deletable"

PrepareEditorSequencesForReview

Prepare Editor Sequences for Review * System: Avid Production Management

  • Type: boolean

Section: avid-pmplus/system-settings/application-database-settings/dynamic-relink

Enabled

Dynamic Relink Enabled * System: Avid Production Management

  • Type: boolean

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-source-audio-patching

SoundOnTapeTrack1

Sound on Tape Track 1

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5", "A6", "A7", "A8", "A9", "A10", "A11", "A12", "A13", "A14", "A15", "A16", "A17", "A18", "A19", "A20", "A21", "A22", "A23", "A24")

  • Flags: "deletable"

SoundOnTapeTrack2

Sound on Tape Track 2

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5", "A6", "A7", "A8", "A9", "A10", "A11", "A12", "A13", "A14", "A15", "A16", "A17", "A18", "A19", "A20", "A21", "A22", "A23", "A24")

  • Flags: "deletable"

VoiceOverTrack

Voice Over Track

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5", "A6", "A7", "A8", "A9", "A10", "A11", "A12", "A13", "A14", "A15", "A16", "A17", "A18", "A19", "A20", "A21", "A22", "A23", "A24")

  • Flags: "deletable"

NaturalSoundTrack1

Natural Sound Track 1

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5", "A6", "A7", "A8", "A9", "A10", "A11", "A12", "A13", "A14", "A15", "A16", "A17", "A18", "A19", "A20", "A21", "A22", "A23", "A24")

  • Flags: "deletable"

NaturalSoundTrack2

Natural Sound Track 2

  • System: Avid Production Management

  • Type: enum ("A1", "A2", "A3", "A4", "A5", "A6", "A7", "A8", "A9", "A10", "A11", "A12", "A13", "A14", "A15", "A16", "A17", "A18", "A19", "A20", "A21", "A22", "A23", "A24")

  • Flags: "deletable"

Section: avid-pmplus/system-settings/application-database-settings/audio-mixing-defaults

DefaultShotlistStartTimecode

Default Shotlist Start Timecode

  • System: Avid Production Management

  • Type: string

EnableAudioMixingDefaults

Enable Audio Mixing Defaults

  • System: Avid Production Management

  • Type: boolean

Audio1

Audio Track 1

  • System: Avid Production Management

  • Type: boolean

Audio2

Audio Track 2

  • System: Avid Production Management

  • Type: boolean

Audio3

Audio Track 3

  • System: Avid Production Management

  • Type: boolean

Audio4

Audio Track 4

  • System: Avid Production Management

  • Type: boolean

Audio5

Audio Track 5

  • System: Avid Production Management

  • Type: boolean

Audio6

Audio Track 6

  • System: Avid Production Management

  • Type: boolean

Audio7

Audio Track 7

  • System: Avid Production Management

  • Type: boolean

Audio8

Audio Track 8

  • System: Avid Production Management

  • Type: boolean

Audio9

Audio Track 9

  • System: Avid Production Management

  • Type: boolean

Audio10

Audio Track 10

  • System: Avid Production Management

  • Type: boolean

Audio11

Audio Track 11

  • System: Avid Production Management

  • Type: boolean

Audio12

Audio Track 12

  • System: Avid Production Management

  • Type: boolean

Audio13

Audio Track 13

  • System: Avid Production Management

  • Type: boolean

Audio14

Audio Track 14

  • System: Avid Production Management

  • Type: boolean

Audio15

Audio Track 15

  • System: Avid Production Management

  • Type: boolean

Audio16

Audio Track 16

  • System: Avid Production Management

  • Type: boolean

Audio1Pan

Audio Track 1 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio2Pan

Audio Track 2 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio3Pan

Audio Track 3 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio4Pan

Audio Track 4 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio5Pan

Audio Track 5 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio6Pan

Audio Track 6 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio7Pan

Audio Track 7 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio8Pan

Audio Track 8 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio9Pan

Audio Track 9 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio10Pan

Audio Track 10 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio11Pan

Audio Track 11 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio12Pan

Audio Track 12 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio13Pan

Audio Track 13 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio14Pan

Audio Track 14 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio15Pan

Audio Track 15 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Audio16Pan

Audio Track 16 Pan

  • System: Avid Production Management

  • Type: enum ("Left", "Center", "Right")

Section: avid-pmplus/system-settings/categories

Categories

Configured Categories

  • System: Avid Production Management

  • Type: list of string

  • Flags: "deletable"

Section: avid-pmplus/system-settings/delete-behavior

DelayScheduledDeletionByDays

Delay scheduled deletion by specified number of days from the asset deletion date

  • System: Avid Production Management

  • Type: integer (0, 30)

  • Flags: "deletable"

PermanentlyDeleteAssetsAndMedia

Permanently delete assets and associated online media from the Orphan Clips folder

  • System: Avid Production Management

  • Type: boolean

Section: avid-pmplus/system-settings/media-indexer-plus

MIPlusEnabled

Enable native MI Server

  • System: Avid Production Management

  • Type: boolean

NexisSystemName

Nexis System Name

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

OutpostServer

MI Outpost Server

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

AMAMetadataLocation

AMA Metadata Location (SPAAF)

  • System: Avid Production Management

  • Type: string

  • Flags: "deletable"

Section: interplay-pam

Section: interplay-pam/site-settings

Section: interplay-pam/site-settings/media-indexer

AMASharedStorage

Media Indexer AMA Shared-Storage Location

  • System: PM

  • Type: string

  • Flags: "read-only"

MIConnectionURL

Server MI Connection URL

  • System: PM

  • Type: string

WorkgroupName

Workgroup Name

  • System: PM

  • Type: string

  • Flags: "read-only"

ActiveMIConfiguration

Active MI Configuration (Dual Ingest)

  • System: PM

  • Type: enum ("1", "2")

SharedStorageServerName

Fallback Shared Storage Server

  • System: PM

  • Type: string

  • Flags: "read-only"

MIConnectionServers

MI Servers

  • System: PM

  • Type: list of string

  • Flags: "read-only"

Section: interplay-pam/site-settings/media-indexer1

AMASharedStorage

Media Indexer AMA Shared-Storage Location

  • System: PM

  • Type: string

  • Flags: "read-only"

MIConnectionURL

Server MI Connection URL

  • System: PM

  • Type: string

  • Flags: "read-only"

SharedStorageServerName

MI Servers

  • System: PM

  • Type: string

  • Flags: "read-only"

MIConnectionServers

MI Servers

  • System: PM

  • Type: list of string

  • Flags: "read-only"

Section: interplay-pam/site-settings/media-indexer2

AMASharedStorage

Media Indexer AMA Shared-Storage Location

  • System: PM

  • Type: string

  • Flags: "read-only"

MIConnectionURL

Server MI Connection URL

  • System: PM

  • Type: string

  • Flags: "read-only"

SharedStorageServerName

MI Servers

  • System: PM

  • Type: string

  • Flags: "read-only"

MIConnectionServers

MI Servers

  • System: PM

  • Type: list of string

  • Flags: "read-only"

Section: Common/Sequence

DisableMixedFramerates

Disable Mixed Framerates

  • System: AM

  • Type: boolean (default: false)

Section: Cloudux/Thumbnails

PreferredWidth

maps the preferredwidth

  • System: AM

  • Type: integer

Section: system

wordlength

Number of characters in one word, used to calculate the number of words in a story.

  • System: NM

  • Type: integer (1, 100; default: 6)

readrate

Reading speed, used to calculate story duration.

  • System: NM

  • Type: integer (1, 32767; default: 180)

display_user_realname

Enable the feature of displaying users real names in form fields.

  • System: NM

  • Type: boolean (default: false)

Section: ctc

sessiontimeout

CTC session idle timeout in seconds.

  • System: NM

  • Type: integer (1, 86400; default: 900)

editlocktimeout

Story edit lock lifetime in seconds.

  • System: NM

  • Type: integer (60, 86400; default: 300)

remoteavailability

Enable remote availability for other CloudUX systems.

  • System: NM

  • Type: boolean (default: false)

Examples

MC | Asset Management 
 
{
  "_links": {
    "curies": [
      {
        "href": "http://developer.avid.com/ctms/api/settings/linkrels/{rel}.html",
        "name": "settings",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "settings:root-section": {
      "href": "https://host/…​"
    },
    "settings:section-by-path": {
      "href": "https://host/…​{path}",
      "templated": true
    }
  }
}