{"openapi":"3.0.1","info":{"title":"ShotHub API","description":"# General\n\nThe base URL for the ShotHub API is `https://api.pomfort.com/sh`.\n\n## Security\n\nRequests to all endpoints (except the /authenticate endpoint) need to be authorized with a JWT Bearer\ntoken, provided through the Authorization header. Tokens are provided via the /authenticate endpoint.\n\nPlease refer to your Quick-Start guide to find out how to create credentials which can be used on the\n/authenticate endpoint.\n\n## Pagination\n\nOn some endpoints, results will be paginated. All of these endpoints will provide the total item count\nin the `x-total-count` response header.\n\nPagination is controlled with two URL parameters:\n\n* `page` is the page number (starting at 0)\n* `pageSize` is the number of items per page. Generally, values from 1 to 50 are allowed.\n\nFor example, using the parameters `?page=3&pageSize=20` will return items 60 through 79.\n\n## Rate Limiting\n\nPlease be aware that all endpoints are rate limited. If you exceed the rate limit, all requests will return\nthe status code `429` with an appropriate error message. Please wait a few minutes before making any more\nrequests.\n\n## Sample scripts\n\nSome sample scripts are available at https://github.com/pomfort/shothub-api-samples.\n","version":"1.0"},"servers":[{"url":"https://api.pomfort.com/sh"}],"tags":[{"name":"Authentication","description":"Obtain access tokens"},{"name":"Projects","description":"Interact with Shothub projects"},{"name":"Folders","description":"Interact with the folder structure"},{"name":"Assets","description":"Find and load assets"},{"name":"Grades","description":"Interact with grades"},{"name":"CDLs","description":"Export ASC-CDL files"},{"name":"PDF Reports","description":"Generate Shooting Day and Clips reports"},{"name":"Status","description":"Check API status"}],"paths":{"/authenticate":{"post":{"tags":["Authentication"],"description":"Obtain an access token by providing your access key","operationId":"authenticate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptLogin"}}},"required":true},"responses":{"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadCredentialsException"}}}},"200":{"description":"Successful login","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTToken"}}}}}}},"/v1.0/status":{"get":{"tags":["Status"],"summary":"Status check","description":"Call this endpoint to check if you are correctly authenticated.","operationId":"getStatus","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/v1.0/projects":{"get":{"tags":["Projects"],"summary":"Get project list","description":"Returns a list of all projects available to the current user.\n\nWhen accessing this endpoint from a script, please keep in mind that the script needs to be \"invited\" to\na project via the Project Information window in ShotHub before the project will show up in this list.\n\nResults are paginated.\n","operationId":"getAllProjects","parameters":[{"name":"page","in":"query","description":"Page number, starting at 0","required":false,"schema":{"type":"string","description":"Page number, starting at 0"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"maximum":50,"minimum":0,"type":"string","description":"Page size"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}}}}}},"/v1.0/pdf-report/shooting-day/{folderId}":{"get":{"tags":["PDF Reports"],"summary":"Generate Shooting Day report","description":"Generates a Shooting Day report, based on a folder and the assets it contains.\n\nThis functionality is only available in Silverstack projects.\n","operationId":"getShootingDayReport","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Export successful","content":{"application/pdf":{"example":"PDF file"}}},"400":{"description":"When invoked in a Livegrade project","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/LivegradeFolderReportException"}}}}}}},"/v1.0/pdf-report/clips/{folderId}":{"get":{"tags":["PDF Reports"],"summary":"Generate Clips report","description":"Generates a Clips report, based on a folder and the assets it contains.\n\nThis functionality is only available in Silverstack projects.\n","operationId":"getClipsReport","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Export successful","content":{"application/pdf":{"example":"PDF file"}}},"400":{"description":"When invoked in a Livegrade project","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/LivegradeFolderReportException"}}}}}}},"/v1.0/grades/{gradeId}":{"get":{"tags":["Grades"],"operationId":"getGradeById","parameters":[{"name":"gradeId","in":"path","description":"Grade ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Grade"}}}}}}},"/v1.0/folders-tree/{projectId}":{"get":{"tags":["Folders"],"operationId":"getFoldersTree","parameters":[{"name":"projectId","in":"path","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TreeNode"}}}}}}}},"/v1.0/cdl-zip/{folderId}":{"get":{"tags":["CDLs"],"summary":"Export grades from folder","description":"Generates a ZIP file which contains all grades from a specified folder as individual ASC-CDL files.\n","operationId":"exportFolder","parameters":[{"name":"folderId","in":"path","description":"The folder which should be exported","required":true,"schema":{"type":"string"},"example":"507f191e810c19729de860ea"},{"name":"namingScheme","in":"query","description":"(Optional) Naming scheme for the CDL files inside the ZIP.
\nAccepted values in Livegrade projects: lookName (default), clipName
\nAccepted values in Silverstack projects: clipName (default)\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Export successful","content":{"application/zip":{"example":"ZIP file"}}}}}},"/v1.0/assets":{"get":{"tags":["Assets"],"summary":"Get assets in folder","description":"This operation returns a list of assets (i.e. AudioClips, VideoClips, Shots, and Documents)\ncontained within the specified folder (including all its child folders). It is possible to narrow down the\nresults to one specific type of asset, and/or to assets matching additional search criteria.\n\nResults are paginated. Only core data will be returned. In order to retrieve details (e.g. file\ninformation, audio information), query the /assets/{id} endpoint instead.\n\nIn a Silverstack project, a folder may contain assets of multiple types, and all types except Shots can be\npresent. In a Livegrade project, only Shots will be present.\n","operationId":"getAssets","parameters":[{"name":"folderId","in":"query","description":"MediaBin Id | Folder Id","required":true,"schema":{"type":"string","description":"MediaBin Id | Folder Id"}},{"name":"assetType","in":"query","description":"Limit search results to a specific asset type.\n\nIn Livegrade projects, any value except 'Shot' will result in an empty list. Conversely, in\nSilverstack projects, choosing 'Shot' will result in an empty list.\n","required":false,"schema":{"type":"string","description":"Limit search results to a specific asset type.\n\nIn Livegrade projects, any value except 'Shot' will result in an empty list. Conversely, in\nSilverstack projects, choosing 'Shot' will result in an empty list.\n","enum":["VideoClip","AudioClip","Shot","Document"]}},{"name":"searchText","in":"query","description":"Search text. If this parameter is used, searchField must also be specified.","required":false,"schema":{"type":"string","description":"Search text. If this parameter is used, searchField must also be specified."}},{"name":"searchField","in":"query","description":"Field in which to search. Possible values: 'name', 'shotId'. If this parameter is used, searchText must also be specified.","required":false,"schema":{"type":"string","description":"Field in which to search. Possible values: 'name', 'shotId'. If this parameter is used, searchText must also be specified."}},{"name":"page","in":"query","description":"Page number, starting at 0","required":false,"schema":{"type":"string","description":"Page number, starting at 0"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"maximum":50,"minimum":0,"type":"string","description":"Page size"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/BaseAsset"},{"$ref":"#/components/schemas/AudioClip"},{"$ref":"#/components/schemas/Document"},{"$ref":"#/components/schemas/Shot"},{"$ref":"#/components/schemas/VideoClip"}]}}}}}}}},"/v1.0/assets/{clipId}/dynamic-metadata":{"get":{"tags":["Assets"],"summary":"Get dynamic metadata by video clip ID","description":"Produces a CSV file which contains the dynamic metadata associated with a video clip. Not all video clips\nhave dynamic metadata available. You can check via the \"/assets/{assetId}\" endpoint, specifically through\nthe field \"hasDynamicMetadata\", if a clip has dynamic metadata.\n\nCalling this endpoint on a video clip without dynamic metadata, or on any other type of asset, will produce\na HTTP error.\n","operationId":"getDynamicMetadataAsCsv","parameters":[{"name":"clipId","in":"path","description":"Video Clip ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/csv":{"schema":{"type":"string"}}}}}}},"/v1.0/assets/{assetId}":{"get":{"tags":["Assets"],"summary":"Get asset by ID","description":"This operation returns an asset (i.e. AudioClips, VideoClips, Shots, and Documents), referenced\nby its ID. In addition to core data, you may specify additional information to be returned using the \"parts\"\nparameter.\n","operationId":"getAssetById","parameters":[{"name":"assetId","in":"path","description":"Asset ID","required":true,"schema":{"type":"string"}},{"name":"parts","in":"query","description":"Comma-separated list of information which should be returned in addition to the asset's core data. If\nnot specified, only core data will be returned. This list may contain any number of parts.\n","required":false,"schema":{"type":"array","items":{"type":"string","enum":["fileInfo","audioInfo","gradeInfo"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BaseAsset"},{"$ref":"#/components/schemas/AudioClip"},{"$ref":"#/components/schemas/Document"},{"$ref":"#/components/schemas/Shot"},{"$ref":"#/components/schemas/VideoClip"}]}}}}}}}},"components":{"schemas":{"ScriptLogin":{"required":["scriptId","scriptKey"],"type":"object","properties":{"scriptId":{"type":"string","description":"The script ID, as shown on the \"Scripts and API\" page in the Team Settings","example":"af3094b4c443dafeb39/myAwesomeScript"},"scriptKey":{"type":"string","description":"The script key","example":"pxW1O6LtixgcVZVmeWlnJZrFRluM1Xr6"}},"description":"Data model representing a login request."},"BadCredentialsException":{"type":"object","properties":{"cause":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"JWTToken":{"type":"object","properties":{"id_token":{"type":"string","description":"A JWT token granting access to ShotHub"},"expiration_date":{"type":"string","description":"Token expiration date","format":"date-time"},"current_date":{"type":"string","description":"Current date and time (on server)","format":"date-time"}},"description":"Response model representing a successful login"},"CustomLabel":{"type":"object","properties":{"label":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"CustomNames":{"type":"object","properties":{"custom1":{"type":"string"},"custom2":{"type":"string"},"custom3":{"type":"string"},"custom4":{"type":"string"},"custom5":{"type":"string"},"custom6":{"type":"string"}}},"Project":{"type":"object","properties":{"Project ID":{"type":"string","example":"60b62ce6aa6471069adc0eb0"},"Project name":{"type":"string","example":"Birthday Cake"},"customFieldTitles":{"$ref":"#/components/schemas/CustomNames"},"customLabels":{"type":"array","items":{"$ref":"#/components/schemas/CustomLabel"}},"cinematographer":{"type":"string"},"producer":{"type":"string"},"cameraAssistant":{"type":"string"},"secondAssistantCamera":{"type":"string"},"scriptSupervisor":{"type":"string"},"production":{"type":"string"},"soundMixer":{"type":"string"},"director":{"type":"string"},"copyrightInformation":{"type":"string"},"digitalImageTechnician":{"type":"string"},"location":{"type":"string"},"dataWrangler":{"type":"string"},"createdBy":{"type":"string","description":"Login of the user who created this ShotHub project"},"createdDate":{"type":"string","description":"Date and time at which this ShotHub project was created.","format":"date-time"},"lastModifiedBy":{"type":"string","description":"Login of the user who last modified this ShotHub project"},"lastModifiedDate":{"type":"string","description":"Date and time at which this ShotHub project was last modified","format":"date-time"},"type":{"type":"string","description":"Project type (Silverstack or Livegrade)","enum":["Silverstack","Livegrade"]},"rootFolderId":{"type":"string","description":"ID of the project's root folder","example":"60b62ce6aa6471069adc0eb4"}},"description":"DTO class representing a ShotHub project"},"LivegradeFolderReportException":{"type":"object","properties":{"cause":{"$ref":"#/components/schemas/ThrowableProblem"},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusType"},"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"message":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"cause":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"StatusType":{"type":"object","properties":{"reasonPhrase":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ThrowableProblem":{"type":"object","properties":{"cause":{"$ref":"#/components/schemas/ThrowableProblem"},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"instance":{"type":"string","format":"uri"},"type":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"status":{"$ref":"#/components/schemas/StatusType"},"detail":{"type":"string"},"title":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"cause":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"ACESLMTGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"lookupTableID":{"type":"string","description":"ID of the lookup table used"},"lookupTableName":{"type":"string","description":"Name of the lookup table used"},"lutDataUrl":{"type":"string","description":"URL for retrieving the lookup table"},"lutSize":{"type":"integer","format":"int32"},"lutDataFormat":{"type":"string"},"clfDescription":{"type":"string"},"clfWorkingColorspace":{"type":"string"}}}]},"ACESTransformGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"lookupTableID":{"type":"string","description":"ID of the lookup table used"},"lookupTableName":{"type":"string","description":"Name of the lookup table used"},"lutDataUrl":{"type":"string","description":"URL for retrieving the lookup table"},"lutSize":{"type":"integer","format":"int32"},"lutDataFormat":{"type":"string"},"clfDescription":{"type":"string"},"clfWorkingColorspace":{"type":"string"},"enableGamutCompression":{"type":"boolean"},"transformName":{"type":"string"},"versionName":{"type":"string"}}}]},"CDLGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"offsetR":{"type":"number","description":"Offset, red channel","format":"float"},"offsetG":{"type":"number","description":"Offset, green channel","format":"float"},"offsetB":{"type":"number","description":"Offset, blue channel","format":"float"},"powerR":{"type":"number","description":"Power, red channel","format":"float"},"powerG":{"type":"number","description":"Power, green channel","format":"float"},"powerB":{"type":"number","description":"Power, blue channel","format":"float"},"slopeR":{"type":"number","description":"Slope, red channel","format":"float"},"slopeG":{"type":"number","description":"Slope, green channel","format":"float"},"slopeB":{"type":"number","description":"Slope, blue channel","format":"float"},"sensitivity":{"type":"number","format":"float"}}}]},"CombinedCDL":{"type":"object","properties":{"offsetR":{"type":"number","description":"Offset, red channel","format":"float"},"offsetG":{"type":"number","description":"Offset, green channel","format":"float"},"offsetB":{"type":"number","description":"Offset, blue channel","format":"float"},"powerR":{"type":"number","description":"Power, red channel","format":"float"},"powerG":{"type":"number","description":"Power, green channel","format":"float"},"powerB":{"type":"number","description":"Power, blue channel","format":"float"},"slopeR":{"type":"number","description":"Slope, red channel","format":"float"},"slopeG":{"type":"number","description":"Slope, green channel","format":"float"},"slopeB":{"type":"number","description":"Slope, blue channel","format":"float"},"saturation":{"type":"number","description":"Saturation","format":"float"}},"description":"Combined Color Decision List for this grade, optional"},"CubeGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"lookupTableID":{"type":"string","description":"ID of the lookup table used"},"lookupTableName":{"type":"string","description":"Name of the lookup table used"},"lutDataUrl":{"type":"string","description":"URL for retrieving the lookup table"},"lutSize":{"type":"integer","format":"int32"},"lutDataFormat":{"type":"string"}}}]},"CurveGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"sensitivity":{"type":"number","format":"float"}}}]},"FilmlightCreativeLUTGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"}]},"FilmlightInGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"blgPipelineCacheViewingColorspace":{"type":"string"},"blgBlobString":{"type":"string"},"blgPipelineCacheDisplayRenderingTransform":{"type":"string"},"blgInputColorspace":{"type":"string"},"blgWorkingColorspaceName":{"type":"string"},"blgPipelineCacheBlobStringIsBlgBlobString":{"type":"boolean"},"blgPipelineCacheBlobString":{"type":"string"},"blgWorkingColorspace":{"type":"string"},"blgInputColorspaceName":{"type":"string"},"blgPipelineCacheInputLUTId":{"type":"string"},"blgPipelineCacheCreativeLUTId":{"type":"string"},"blgPipelineCacheOutputLUTId":{"type":"string"}}}]},"FilmlightOutGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"blgViewingColorspace":{"type":"string"},"blgDisplayRenderingTransform":{"type":"string"},"blgViewingColorspaceName":{"type":"string"}}}]},"Grade":{"type":"object","properties":{"id":{"type":"string","example":"60b4a350aa6471069adc0c51"},"mode":{"type":"string","description":"Grading mode","example":"com.pomfort.gradingmode.cdlandlut"},"name":{"type":"string","description":"Look Source Name (Silverstack projects), Look Name (Livegrade projects)","example":"Natural Rec709"},"registrationDate":{"type":"string","description":"Date and time at which this grade was first registered in Livegrade","format":"date-time"},"projectId":{"type":"string","description":"ID of the associated project","example":"60b62c36aa6471069adc0e74"},"nodes":{"type":"array","description":"List of the grade's grading nodes","items":{"oneOf":[{"$ref":"#/components/schemas/GradeNode"},{"$ref":"#/components/schemas/ACESLMTGradeNode"},{"$ref":"#/components/schemas/ACESTransformGradeNode"},{"$ref":"#/components/schemas/CDLGradeNode"},{"$ref":"#/components/schemas/CubeGradeNode"},{"$ref":"#/components/schemas/CurveGradeNode"},{"$ref":"#/components/schemas/FilmlightCreativeLUTGradeNode"},{"$ref":"#/components/schemas/FilmlightInGradeNode"},{"$ref":"#/components/schemas/FilmlightOutGradeNode"},{"$ref":"#/components/schemas/HHSGradeNode"},{"$ref":"#/components/schemas/KneeGradeNode"},{"$ref":"#/components/schemas/LUT1DGradeNode"},{"$ref":"#/components/schemas/SaturationGradeNode"},{"$ref":"#/components/schemas/VersusCurvesGradeNode"}]}},"revisionNumber":{"type":"integer","format":"int64"},"createdBy":{"type":"string","description":"Login of the user who first registered this grade in ShotHub"},"createdDate":{"type":"string","description":"Date and time at which this grade was first registered in ShotHub","format":"date-time"},"lastModifiedBy":{"type":"string","description":"Login of the user who last modified this grade"},"lastModifiedDate":{"type":"string","description":"Date and time at which this grade was last modified","format":"date-time"},"combinedCDL":{"$ref":"#/components/schemas/CombinedCDL"}},"description":"DTO class describing a Grade"},"GradeNode":{"required":["type"],"type":"object","properties":{"name":{"type":"string","description":"Node name"},"active":{"type":"boolean","description":"Indicates if the node is active or bypassed"},"type":{"type":"string"}},"description":"Root DTO class for all types of grading nodes\n","discriminator":{"propertyName":"type"}},"HHSGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"vectors":{"type":"array","items":{"$ref":"#/components/schemas/HHSVector"}},"sensitivity":{"type":"number","format":"float"}}}]},"HHSVector":{"type":"object","properties":{"hue":{"type":"number","format":"float"},"saturation":{"type":"number","format":"float"},"sourceHue":{"type":"number","format":"float"}}},"KneeGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"kneeCurveMode":{"type":"integer","format":"int32"},"kneePosition":{"type":"number","format":"float"},"kneeSlope":{"type":"number","format":"float"},"kneeLimit":{"type":"number","format":"float"},"toePosition":{"type":"number","format":"float"},"toeSlope":{"type":"number","format":"float"},"toeLimit":{"type":"number","format":"float"}}}]},"LUT1DGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"lookupTableID":{"type":"string"},"lookupTableName":{"type":"string"},"lutDataUrl":{"type":"string","description":"URL for retrieving the lookup table"},"lutSize":{"type":"integer","format":"int32"}}}]},"SaturationGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"saturation":{"type":"number","format":"float"}}}]},"VersusCurvesGradeNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/GradeNode"},{"type":"object","properties":{"sensitivity":{"type":"number","format":"float"}}}]},"TreeNode":{"type":"object","properties":{"id":{"type":"string","description":"Folder ID","example":"60b62ce6aa6471069adc0eb4"},"name":{"type":"string","description":"Folder name","example":"A003R2VJ"},"folderType":{"type":"string","description":"Folder type (regular Folder or Media Bin)","enum":["Folder","Bin"]},"folderSubtype":{"type":"string","description":"Folder subtype - can be used to identify certain special folders","example":"Simple","enum":["Root","Library","LostAndFoundRoot","TranscodedClipsRoot","TrashRoot","Standard","Transcoded","Audio"]},"registrationDate":{"type":"string","description":"Date and time at which the folder was first registered in Silverstack or Livegrade","format":"date-time"},"children":{"type":"array","description":"List containing all child folders. Note: This is not correctly displayed in Swagger UI. Elements of this list\nare of type \"TreeNode\".\n","items":{"$ref":"#/components/schemas/TreeNode"}}},"description":"DTO class representing a folder within the folder hierarchy of a ShotHub project."},"AssetPart":{"type":"object","description":"Optional information (e.g. file info, audio info) - see endpoint description for details"},"AudioClip":{"type":"object","description":"DTO class representing an audio clip","allOf":[{"$ref":"#/components/schemas/BaseAsset"},{"type":"object","properties":{"id":{"type":"string","description":"Asset ID","example":"60b62c38aa6471069adc0e7d"},"sourceCreationDate":{"type":"string","description":"Date and time at which the asset was created (e.g. the day a video clip was shot)","format":"date-time"},"productionShootingDate":{"type":"string","description":"Date only of the shooting day associated with the clips","format":"date-time"},"importPluginIdentifier":{"type":"string","description":"Identifier for the plugin used to import this asset into Silverstack or Livegrade","example":"com.pomfort.importPlugin.ffmpeg.generic"},"name":{"type":"string","description":"Asset name"},"type":{"type":"string","description":"File type","example":"wav"},"flag":{"type":"boolean","description":"Indicates if the clip has been ‘flagged' (‘circled')","example":true},"cinematographer":{"type":"string","description":"Name of the Cinematographer"},"producer":{"type":"string","description":"Name of the Producer","example":"Johnny Lindstén"},"cameraAssistant":{"type":"string","description":"Name of the Camera Assistant","example":"Luis Rollins"},"secondAssistantCamera":{"type":"string","description":"Name of the Second Camera Assistant","example":"Mónica Mendez"},"scriptSupervisor":{"type":"string","description":"Name of the Script Supervisor","example":"Wanja Hurtig"},"production":{"type":"string","description":"Production name"},"soundMixer":{"type":"string","description":"Name of the Sound Mixer","example":"Oliver Brown"},"director":{"type":"string","description":"Name of the Director","example":"Heideliese Weck"},"copyrightInformation":{"type":"string","description":"Copyright Information","example":"Pomfort"},"digitalImageTechnician":{"type":"string","description":"Name of the Digital Image Technician","example":"Xavier Vinson"},"dataWrangler":{"type":"string","description":"Name of the Data Wrangler","example":"Nova Bengtsson Hejde"},"shotDescriptors":{"type":"string"},"tags":{"type":"string","description":"Comma-separated list of tags","example":"Music,Munich"},"scan":{"type":"string","description":"Scan type of clip","example":"Progressive"},"xxHash64":{"type":"string","description":"**Deprecated** - this is a xxHash64 hash which is encoded in Little Endian, violating the xxHash64\nstandard, due to a bug in early Silverstack versions. This field exists only for backward compatibility and\nwe strongly recommend you ignore it, and use the field \"xxHash64\", which contains a standard-compliant\nhash, wherever possible.\n","example":"53E0BBC3E1D02C83"},"xxHash64BE":{"type":"string","description":"**Deprecated** - standard-compliant xxHash64 (non-cryptographic 64bit hash) of the asset\n","example":"832CD0E1C3BBE053"},"xxHash128":{"type":"string","description":"XXH128 (non-cryptographic 128bit hash) of the asset. Silverstack 8.4 and above only"},"xxHash3":{"type":"string","description":"XXH3 (non-cryptographic 64bit hash) of the asset. Silverstack 8.4 and above only"},"sha1":{"type":"string","description":"SHA-1 hash of the asset","example":"3b6419d1006d0a3950a6be896ccef4708a0d2801"},"md5":{"type":"string","description":"MD5 hash of the asset","example":"852544c5fb36c6b038881a43e54969cf"},"c4":{"type":"string","description":"Cinema Content Creation Cloud (c4) hash"},"volumes":{"type":"string","description":"Comma-separated list of the volumes the asset is stored on"},"fileSize":{"type":"integer","description":"File size, in Bytes","format":"int64","example":37450240},"revisionNumber":{"type":"integer","format":"int64"},"codec":{"type":"string","description":"The codec of this video or audio clip","example":"Apple ProRes 4444"},"shootingDate":{"type":"string","description":"Date and time of shooting or recording","format":"date-time"},"gpsPosition":{"type":"string","description":"GPS position of shooting or recording. As this field is editable in Silverstack, it is possible that it\ncontains malformed information.\n"},"serialNumber":{"type":"string","description":"Serial number of the camera or audio recorder used"},"manufacturer":{"type":"string","description":"Manufacturer of the camera or audio recorder used"},"model":{"type":"string","description":"Model of the camera or audio recorder used"},"firmwareVersion":{"type":"string","description":"Firmware version of the camera or audio recorder used"},"deviceId":{"type":"string","description":"Device ID of the camera or audio recorder used"},"reelName":{"type":"string","description":"Reel name","example":"A003R2VJ"},"fps":{"type":"number","description":"Frames per second","format":"float","example":24},"durationInSecs":{"type":"number","description":"Clip duration in seconds","format":"float","example":47},"tcStart":{"type":"string","description":"Timecode at start of clip","example":"01:51:16.00"},"tcEnd":{"type":"string","description":"Timecode at end of clip","example":"01:52:03:00"},"tcDropFlag":{"type":"boolean","description":"Indicates a drop-frame timecode"},"tcFps":{"type":"number","format":"double"},"audioTracks":{"type":"string","description":"Summary of audio tracks"},"audioTrackNames":{"type":"string","description":"Comma-separated list of audio track names"},"season":{"type":"string","description":"Season identifier","example":"S1"},"dayNight":{"type":"string","description":"Indicates if clip is day or night footage. Editable by the user, no specific format can be guaranteed.","example":"Day"},"indoorOutdoor":{"type":"string","description":"Indicates if clip is indoor or outdoor footage. Editable by the user, no specific format can be guaranteed.","example":"Indoors"},"shootingDay":{"type":"string","description":"Shooting day","example":"17"},"crewUnit":{"type":"string","description":"Crew Unit which shot or recorded this clip","example":"Second Unit"},"actors":{"type":"string","description":"Comma-separated list of actors included in this clip","example":"Ricarda Schöll, 金城正宇黄"},"bitDepth":{"type":"integer","format":"int32"},"channelCount":{"type":"integer","format":"int32"},"wildTrack":{"type":"boolean"},"fileSetFamilyUID":{"type":"string"},"fileSetIndex":{"type":"integer","format":"int32"},"tape":{"type":"string","description":"Tape metadata from AudioClip"},"estimatedDurationInSeconds":{"type":"number","format":"double"},"fileSetFamilyName":{"type":"string"},"fileSetTotalFiles":{"type":"integer","format":"int32"},"includedFileSize":{"type":"integer","format":"int64"},"slatePosition":{"type":"number","description":"Frame number of Slate Sync set by user","format":"double"},"sampleRate":{"type":"integer","description":"Audio sample rate","format":"int64","example":48000},"channels":{"type":"string"},"samplesSinceMidnight":{"type":"integer","description":"Samples since Midnight","format":"int64"},"xxHash":{"type":"string","description":"xxHash (non-cryptographic 32bit hash) of the asset","example":"61309CE8"}}}]},"AudioInfo":{"type":"object","description":"Container class for the optional \"fileInfo\" part embedded in an Asset\n","allOf":[{"$ref":"#/components/schemas/AssetPart"},{"type":"object","properties":{"masterLevel":{"type":"number","format":"float"},"streams":{"type":"array","items":{"$ref":"#/components/schemas/AudioMixStream"}}}}]},"AudioMixStream":{"type":"object","properties":{"name":{"type":"string"},"audioClipId":{"type":"string"},"offsetInSamples":{"type":"integer","format":"int64"},"audioSlateSamplePosition":{"type":"integer","format":"int32"},"streamMute":{"type":"boolean","description":"Indicates muted tracks"},"ms":{"type":"array","items":{"type":"integer","format":"int32"}},"tracks":{"type":"array","items":{"$ref":"#/components/schemas/AudioMixStreamTrack"}}},"description":"DTO object representing a stream within an AudioMix"},"AudioMixStreamTrack":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"integer","format":"int32"},"function":{"type":"integer","format":"int32"},"mute":{"type":"boolean"},"routing":{"type":"string","enum":["Left","Right","Both"]},"level":{"type":"number","format":"float"}},"description":"DTO class representing an audio track within an AudioMixStream"},"BaseAsset":{"type":"object","properties":{"id":{"type":"string"},"createdBy":{"type":"string","description":"Login handle of the user who originally added this asset to the ShotHub project"},"createdDate":{"type":"string","description":"Date and time at which the asset was added to the ShotHub project","format":"date-time"},"lastModifiedBy":{"type":"string","description":"Login handle of the user who last modified the asset"},"lastModifiedDate":{"type":"string","description":"Date and time at which the asset was last modified","format":"date-time"},"folderId":{"type":"string","description":"ID of the folder which contains the asset"},"folderName":{"type":"string","description":"Name of the folder which contains the asset"},"parts":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/AudioInfo"},{"$ref":"#/components/schemas/FileInfo"},{"$ref":"#/components/schemas/GradeInfo"}]},"description":"Optional information (e.g. file info, audio info) - see endpoint description for details"},"caption":{"type":"string"},"comment":{"type":"string","description":"Comment"},"registrationDate":{"type":"string","description":"Date and time at which the asset was first added to the Silverstack or Livegrade project","format":"date-time"},"custom1":{"type":"string","description":"Custom field 1 (customizable per project in Silverstack or Livegrade desktop applications)"},"custom2":{"type":"string","description":"Custom field 2 (customizable per project in Silverstack or Livegrade desktop applications)\n"},"custom3":{"type":"string","description":"Custom field 3 (customizable per project in Silverstack or Livegrade desktop applications)"},"custom4":{"type":"string","description":"Custom field 4 (customizable per project in Silverstack or Livegrade desktop applications)"},"custom5":{"type":"string","description":"Custom field 5 (customizable per project in Silverstack or Livegrade desktop applications)"},"custom6":{"type":"string","description":"Custom field 6 (customizable per project in Silverstack or Livegrade desktop applications)"},"location":{"type":"string","description":"Location of the shot","example":"Restaurant"},"episode":{"type":"string","description":"Episode identifier","example":"8"},"rating":{"type":"integer","description":"Rating, on a scale of 1 to 5 stars. A value of 0 indicates that no rating has been assigned yet.","format":"int32","example":4,"enum":[0,1,2,3,4,5]},"scene":{"type":"string","description":"Scene identifier","example":"5"},"shot":{"type":"string","description":"Name or number of the shot","example":"4"},"take":{"type":"string","description":"Take identifier","example":"4"},"thumbnailUrl":{"type":"string","description":"Thumbnail URL. This URL is presigned and allows access to the file without additional authentication for a\nlimited time.\n"},"label":{"type":"integer","description":"Label (customizable per project in Silverstack or Livegrade desktop applications)","format":"int32"},"projectId":{"type":"string","description":"ID of the ShotHub project","example":"60fec963d8030d09cfa6fe36"},"assetType":{"type":"string","description":"Asset type. May be used to identify the correct class for deserialization when consuming the API in a strictly\ntyped language.\n","enum":["VideoClip","AudioClip","Shot","Document"]}},"description":"Base DTO class for assets. Responses will never use this raw type but rather one of its child classes.\n","discriminator":{"propertyName":"assetType"}},"CuePoint":{"type":"object","properties":{"framePosition":{"type":"integer","description":"Frame number of cue point marker","format":"int32"},"channelIndex":{"type":"integer","format":"int32"},"duration":{"type":"integer","description":"Duration in frames of cue point","format":"int32"},"type":{"type":"string","enum":["Mark","Content","Flicker","Exposure","Sharpness","Compression","Pixel","CorruptFrame","Slate"]},"name":{"type":"string","description":"Name of cue point"}}},"Document":{"type":"object","description":"DTO class representing a Document (Sidecar or Residual)","allOf":[{"$ref":"#/components/schemas/BaseAsset"},{"type":"object","properties":{"id":{"type":"string","description":"Asset ID","example":"60b62c38aa6471069adc0e7d"},"sourceCreationDate":{"type":"string","description":"Date and time at which the asset was created (e.g. the day a video clip was shot)","format":"date-time"},"productionShootingDate":{"type":"string","description":"Date only of the shooting day associated with the clips","format":"date-time"},"importPluginIdentifier":{"type":"string","description":"Identifier for the plugin used to import this asset into Silverstack or Livegrade","example":"com.pomfort.importPlugin.ffmpeg.generic"},"name":{"type":"string","description":"Asset name"},"type":{"type":"string","description":"File type","example":"wav"},"flag":{"type":"boolean","description":"Indicates if the clip has been ‘flagged' (‘circled')","example":true},"cinematographer":{"type":"string","description":"Name of the Cinematographer"},"producer":{"type":"string","description":"Name of the Producer","example":"Johnny Lindstén"},"cameraAssistant":{"type":"string","description":"Name of the Camera Assistant","example":"Luis Rollins"},"secondAssistantCamera":{"type":"string","description":"Name of the Second Camera Assistant","example":"Mónica Mendez"},"scriptSupervisor":{"type":"string","description":"Name of the Script Supervisor","example":"Wanja Hurtig"},"production":{"type":"string","description":"Production name"},"soundMixer":{"type":"string","description":"Name of the Sound Mixer","example":"Oliver Brown"},"director":{"type":"string","description":"Name of the Director","example":"Heideliese Weck"},"copyrightInformation":{"type":"string","description":"Copyright Information","example":"Pomfort"},"digitalImageTechnician":{"type":"string","description":"Name of the Digital Image Technician","example":"Xavier Vinson"},"dataWrangler":{"type":"string","description":"Name of the Data Wrangler","example":"Nova Bengtsson Hejde"},"shotDescriptors":{"type":"string"},"tags":{"type":"string","description":"Comma-separated list of tags","example":"Music,Munich"},"scan":{"type":"string","description":"Scan type of clip","example":"Progressive"},"xxHash64":{"type":"string","description":"**Deprecated** - this is a xxHash64 hash which is encoded in Little Endian, violating the xxHash64\nstandard, due to a bug in early Silverstack versions. This field exists only for backward compatibility and\nwe strongly recommend you ignore it, and use the field \"xxHash64\", which contains a standard-compliant\nhash, wherever possible.\n","example":"53E0BBC3E1D02C83"},"xxHash64BE":{"type":"string","description":"**Deprecated** - standard-compliant xxHash64 (non-cryptographic 64bit hash) of the asset\n","example":"832CD0E1C3BBE053"},"xxHash128":{"type":"string","description":"XXH128 (non-cryptographic 128bit hash) of the asset. Silverstack 8.4 and above only"},"xxHash3":{"type":"string","description":"XXH3 (non-cryptographic 64bit hash) of the asset. Silverstack 8.4 and above only"},"sha1":{"type":"string","description":"SHA-1 hash of the asset","example":"3b6419d1006d0a3950a6be896ccef4708a0d2801"},"md5":{"type":"string","description":"MD5 hash of the asset","example":"852544c5fb36c6b038881a43e54969cf"},"c4":{"type":"string","description":"Cinema Content Creation Cloud (c4) hash"},"volumes":{"type":"string","description":"Comma-separated list of the volumes the asset is stored on"},"fileSize":{"type":"integer","description":"File size, in Bytes","format":"int64","example":37450240},"revisionNumber":{"type":"integer","format":"int64"},"specialFileType":{"type":"string","enum":["Normal","SymbolicLink","EmptyFolder"]},"xxHash":{"type":"string","description":"xxHash (non-cryptographic 32bit hash) of the asset","example":"61309CE8"}}}]},"FileInfo":{"type":"object","description":"Container class for the optional \"fileInfo\" part embedded in an Asset\n","allOf":[{"$ref":"#/components/schemas/AssetPart"},{"type":"object","properties":{"fileResources":{"type":"array","items":{"$ref":"#/components/schemas/FileResource"}}}}]},"FileResource":{"type":"object","properties":{"fileCreationDate":{"type":"string","description":"Date and time at which the file was originally created","format":"date-time"},"registrationDate":{"type":"string","description":"Date and time at which the file was registered in Silverstack or Livegrade","format":"date-time"},"resourceType":{"type":"integer","format":"int32"},"fileType":{"type":"string"},"fileSize":{"type":"integer","description":"File size in Bytes","format":"int64","example":28347948},"relativeScanPath":{"type":"string"},"relativePath":{"type":"string"},"volume":{"$ref":"#/components/schemas/Volume"},"volumeId":{"type":"string"},"createdBy":{"type":"string","description":"Login of the ShotHub user who first registered this file in ShotHub"},"createdDate":{"type":"string","description":"Date and time at which the file was first registered in ShotHub","format":"date-time"}},"description":"Represents a file"},"GradeInfo":{"type":"object","allOf":[{"$ref":"#/components/schemas/AssetPart"},{"type":"object","properties":{"grade":{"$ref":"#/components/schemas/Grade"},"gradeSource":{"type":"string","description":"Look source","enum":["Undefined","File","Preset","CustomLUT","CustomLook","None","LiveGrade","Matched"]}}}]},"LastUsageInfoDTO":{"type":"object","properties":{"user":{"type":"string"},"timeStamp":{"type":"string","format":"date-time"}}},"RawSettingsApiDTO":{"type":"object","properties":{"applySharpness":{"type":"boolean"},"detail":{"type":"number","format":"double"},"exposureAdjust":{"type":"number","description":"Exposure Adjust, Brightness or Linear Gain","format":"double"},"flashingPixelAdjust":{"type":"number","format":"double"},"gainB":{"type":"number","format":"double"},"gainG":{"type":"number","format":"double"},"gainR":{"type":"number","format":"double"},"highPassSharpen":{"type":"number","format":"double"},"highPassSharpenOn":{"type":"boolean"},"isoSensitivity":{"type":"integer","description":"Exposure Index / ISO","format":"int32"},"noiseReduction":{"type":"number","format":"double"},"noiseReductionOn":{"type":"boolean"},"sharpness":{"type":"number","description":"Sharpness","format":"double"},"tint":{"type":"number","description":"Tint","format":"double"},"unsharpMaskAmount":{"type":"number","format":"double"},"unsharpMaskEnable":{"type":"boolean"},"unsharpMaskRadius":{"type":"number","format":"double"},"unsharpMaskThresh":{"type":"number","format":"double"},"whiteBalance":{"type":"number","description":"Color temperature","format":"double"}}},"RawSettingsInfoApiDTO":{"type":"object","properties":{"original":{"$ref":"#/components/schemas/RawSettingsApiDTO"},"userDefined":{"$ref":"#/components/schemas/RawSettingsApiDTO"},"apply":{"type":"boolean"}}},"Shot":{"type":"object","description":"DTO class representing a Livegrade Shot","allOf":[{"$ref":"#/components/schemas/BaseAsset"},{"type":"object","properties":{"aperture":{"type":"string"},"asa":{"type":"integer","format":"int32"},"camera":{"type":"string","description":"Camera identifier","example":"A"},"cameraImageHeight":{"type":"integer","description":"Camera image height, in pixels","format":"int32","example":3096},"cameraImageWidth":{"type":"integer","description":"Camera image width, in pixels","format":"int32","example":4448},"cameraModel":{"type":"string"},"cameraRoll":{"type":"number","format":"float"},"cameraSoftwareVersion":{"type":"string","description":"Camera software version"},"cameraTilt":{"type":"number","format":"float"},"clipIdentifier":{"type":"string"},"name":{"type":"string"},"clipName":{"type":"string"},"clipNumber":{"type":"string"},"crewUnit":{"type":"string","description":"Crew Unit which worked on this shot","example":"A"},"dayNight":{"type":"string","description":"Indicates if clip is day or night footage. Editable by the user, no specific format can be guaranteed.","example":"Day"},"indoorOutdoor":{"type":"string","description":"Indicates if clip is indoor or outdoor footage. Editable by the user, no specific format can be guaranteed.","example":"Indoors"},"distanceToSubject":{"type":"string","description":"Distance to subject or object"},"filter":{"type":"string","description":"Name or description of filter used"},"flagged":{"type":"boolean"},"focalLength":{"type":"number","description":"Focal length","format":"float","example":57},"focusDistance":{"type":"number","description":"Focus distance","format":"float"},"fps":{"type":"number","description":"Frames per second","format":"float","example":24},"durationInSecs":{"type":"number","description":"Clip duration in seconds","format":"float","example":47},"frameCount":{"type":"integer","description":"Clip duration, in frames","format":"int32","example":584},"greenTint":{"type":"number","description":"Tint value","format":"float","example":1.2},"height":{"type":"integer","description":"Camera image height, in pixels","format":"int32","example":3096},"width":{"type":"integer","description":"Camera image width, in pixels","format":"int32","example":4448},"lensModel":{"type":"string","description":"Lens name"},"locked":{"type":"boolean"},"ndFilter":{"type":"number","description":"Neutral density filter","format":"float"},"projectFps":{"type":"number","description":"Frames per second","format":"float","example":24},"reelName":{"type":"string","description":"Reel name","example":"A003R2VJ"},"sensorFps":{"type":"number","description":"Sensor frames per second","format":"float","example":24},"shutterAngle":{"type":"number","description":"Shutter angle in degrees","format":"float"},"tcIn":{"type":"string","description":"In point marked by user"},"tcOut":{"type":"string","description":"Out point marked by user"},"whiteBalance":{"type":"integer","description":"Whitepoint, in Kelvin","format":"int32","example":3200},"lookName":{"type":"string","description":"Name of the look associated with this clip","example":"Natural"},"season":{"type":"string","description":"Season identifier","example":"S1"},"shootingDay":{"type":"string","description":"Crew Unit which shot or recorded this clip","example":"Second Unit"}}}]},"VideoClip":{"type":"object","description":"DTO class representing a Video Clip.","allOf":[{"$ref":"#/components/schemas/BaseAsset"},{"type":"object","properties":{"id":{"type":"string","description":"Asset ID","example":"60b62c38aa6471069adc0e7d"},"sourceCreationDate":{"type":"string","description":"Date and time at which the asset was created (e.g. the day a video clip was shot)","format":"date-time"},"productionShootingDate":{"type":"string","description":"Date only of the shooting day associated with the clips","format":"date-time"},"importPluginIdentifier":{"type":"string","description":"Identifier for the plugin used to import this asset into Silverstack or Livegrade","example":"com.pomfort.importPlugin.ffmpeg.generic"},"name":{"type":"string","description":"Asset name"},"type":{"type":"string","description":"File type","example":"wav"},"flag":{"type":"boolean","description":"Indicates if the clip has been ‘flagged' (‘circled')","example":true},"cinematographer":{"type":"string","description":"Name of the Cinematographer"},"producer":{"type":"string","description":"Name of the Producer","example":"Johnny Lindstén"},"cameraAssistant":{"type":"string","description":"Name of the Camera Assistant","example":"Luis Rollins"},"secondAssistantCamera":{"type":"string","description":"Name of the Second Camera Assistant","example":"Mónica Mendez"},"scriptSupervisor":{"type":"string","description":"Name of the Script Supervisor","example":"Wanja Hurtig"},"production":{"type":"string","description":"Production name"},"soundMixer":{"type":"string","description":"Name of the Sound Mixer","example":"Oliver Brown"},"director":{"type":"string","description":"Name of the Director","example":"Heideliese Weck"},"copyrightInformation":{"type":"string","description":"Copyright Information","example":"Pomfort"},"digitalImageTechnician":{"type":"string","description":"Name of the Digital Image Technician","example":"Xavier Vinson"},"dataWrangler":{"type":"string","description":"Name of the Data Wrangler","example":"Nova Bengtsson Hejde"},"shotDescriptors":{"type":"string"},"tags":{"type":"string","description":"Comma-separated list of tags","example":"Music,Munich"},"scan":{"type":"string","description":"Scan type of clip","example":"Progressive"},"xxHash64":{"type":"string","description":"**Deprecated** - this is a xxHash64 hash which is encoded in Little Endian, violating the xxHash64\nstandard, due to a bug in early Silverstack versions. This field exists only for backward compatibility and\nwe strongly recommend you ignore it, and use the field \"xxHash64\", which contains a standard-compliant\nhash, wherever possible.\n","example":"53E0BBC3E1D02C83"},"xxHash64BE":{"type":"string","description":"**Deprecated** - standard-compliant xxHash64 (non-cryptographic 64bit hash) of the asset\n","example":"832CD0E1C3BBE053"},"xxHash128":{"type":"string","description":"XXH128 (non-cryptographic 128bit hash) of the asset. Silverstack 8.4 and above only"},"xxHash3":{"type":"string","description":"XXH3 (non-cryptographic 64bit hash) of the asset. Silverstack 8.4 and above only"},"sha1":{"type":"string","description":"SHA-1 hash of the asset","example":"3b6419d1006d0a3950a6be896ccef4708a0d2801"},"md5":{"type":"string","description":"MD5 hash of the asset","example":"852544c5fb36c6b038881a43e54969cf"},"c4":{"type":"string","description":"Cinema Content Creation Cloud (c4) hash"},"volumes":{"type":"string","description":"Comma-separated list of the volumes the asset is stored on"},"fileSize":{"type":"integer","description":"File size, in Bytes","format":"int64","example":37450240},"revisionNumber":{"type":"integer","format":"int64"},"codec":{"type":"string","description":"The codec of this video or audio clip","example":"Apple ProRes 4444"},"shootingDate":{"type":"string","description":"Date and time of shooting or recording","format":"date-time"},"gpsPosition":{"type":"string","description":"GPS position of shooting or recording. As this field is editable in Silverstack, it is possible that it\ncontains malformed information.\n"},"serialNumber":{"type":"string","description":"Serial number of the camera or audio recorder used"},"manufacturer":{"type":"string","description":"Manufacturer of the camera or audio recorder used"},"model":{"type":"string","description":"Model of the camera or audio recorder used"},"firmwareVersion":{"type":"string","description":"Firmware version of the camera or audio recorder used"},"deviceId":{"type":"string","description":"Device ID of the camera or audio recorder used"},"reelName":{"type":"string","description":"Reel name","example":"A003R2VJ"},"fps":{"type":"number","description":"Frames per second","format":"float","example":24},"durationInSecs":{"type":"number","description":"Clip duration in seconds","format":"float","example":47},"tcStart":{"type":"string","description":"Timecode at start of clip","example":"01:51:16.00"},"tcEnd":{"type":"string","description":"Timecode at end of clip","example":"01:52:03:00"},"tcDropFlag":{"type":"boolean","description":"Indicates a drop-frame timecode"},"tcFps":{"type":"number","format":"double"},"audioTracks":{"type":"string","description":"Summary of audio tracks"},"audioTrackNames":{"type":"string","description":"Comma-separated list of audio track names"},"season":{"type":"string","description":"Season identifier","example":"S1"},"dayNight":{"type":"string","description":"Indicates if clip is day or night footage. Editable by the user, no specific format can be guaranteed.","example":"Day"},"indoorOutdoor":{"type":"string","description":"Indicates if clip is indoor or outdoor footage. Editable by the user, no specific format can be guaranteed.","example":"Indoors"},"shootingDay":{"type":"string","description":"Shooting day","example":"17"},"crewUnit":{"type":"string","description":"Crew Unit which shot or recorded this clip","example":"Second Unit"},"actors":{"type":"string","description":"Comma-separated list of actors included in this clip","example":"Ricarda Schöll, 金城正宇黄"},"shotId":{"type":"string","description":"The ShotID is a short code/identifier given to each clip in the Silverstack desktop application to reference clip metadata across multiple work places.","example":"M3S-GE3-DNG"},"shutter":{"type":"number","description":"Shutter speed in seconds (exposure time)","format":"float","example":0.02},"shutterLongString":{"type":"string"},"shutterDegreeString":{"type":"string","description":"Shutter angle in degrees"},"shutterString":{"type":"string"},"camera":{"type":"string","description":"Camera identifier","example":"A"},"audioSampleRate":{"type":"string"},"audioSampleRateString":{"type":"string","description":"Audio sample rate","example":"48000 Hz"},"cameraOrientation":{"type":"string","description":"Camera Orientation. As this field is editable in Silverstack, it is possible that it\ncontains malformed information.\n"},"sensorFps":{"type":"number","description":"Sensor frames per second","format":"float","example":24},"duration":{"type":"number","description":"Clip duration, in frames","format":"float","example":584},"rawCropOriginX":{"type":"integer","format":"int32"},"rawCropOriginY":{"type":"integer","format":"int32"},"pixelWidth":{"type":"integer","description":"Camera image width, in pixels","format":"int32","example":4448},"pixelHeight":{"type":"integer","description":"Camera image height, in pixels","format":"int32","example":3096},"keyFrameInterval":{"type":"integer","description":"Keyframe interval","format":"int32"},"lens":{"type":"string","description":"Lens name"},"lensSerialNumber":{"type":"string","description":"Lens serial number"},"focalLength":{"type":"number","description":"Focal length, in millimeters","format":"float","example":57},"focusDistance":{"type":"number","description":"Focus distance","format":"double"},"numberOfAudioChannels":{"type":"integer","description":"Number of audio channels","format":"int32"},"rawPixelWidth":{"type":"integer","format":"int32"},"rawPixelHeight":{"type":"integer","format":"int32"},"lookName":{"type":"string","description":"Name of the look associated with this clip","example":"Natural"},"filter":{"type":"string","description":"Name or description of filter used"},"tint":{"type":"number","description":"Tint value","format":"double","example":1.2},"whitepointKelvin":{"type":"integer","description":"Whitepoint, in Kelvin","format":"int32","example":3200},"colorSpace":{"type":"string","description":"Recording color space","example":"LOG-C"},"audioCodec":{"type":"string","description":"Audio Codec","example":"Linear PCM"},"distanceToObject":{"type":"string","description":"Distance to object. This is a free text field which may or may not contain unit information.","example":"17m"},"getfStop":{"type":"string","description":"f-Stop","example":"5.6"},"gettStop":{"type":"string","description":"t-Stop","example":"5 7/10"},"crop":{"type":"string","description":"Indicates that clip is cropped"},"inpoint":{"type":"string","description":"In point marked by user"},"outPointInclusive":{"type":"string","description":"Out point marked by user"},"flip":{"type":"integer","description":"Indicates that clip is flipped horizontally, vertically or both","format":"int32"},"anamorphic":{"type":"integer","description":"Indicates that clip is desqueezed as legacy enum value","format":"int32"},"anamorphicFactor":{"type":"number","description":"Indicates that clip is desqueezed in float","format":"double"},"audioTcOffset":{"type":"string","description":"Offset between audio and video timecode"},"extAudioTCStart":{"type":"string","description":"Timecode of external audio clip at first video frame"},"extAudioTCEnd":{"type":"string","description":"Timecode of external audio clip at last video frame (exclusive)"},"ndFilter":{"type":"number","description":"Neutral density filter","format":"float"},"nativeIso":{"type":"number","description":"Native ISO from camera","format":"float"},"thumbnailIndex":{"type":"integer","format":"int32"},"cameraTilt":{"type":"number","format":"double"},"cameraRoll":{"type":"number","format":"double"},"rotation":{"type":"integer","description":"Indicates that clip is rotated left or right (90 degrees)","format":"int32"},"cuePoints":{"type":"array","items":{"$ref":"#/components/schemas/CuePoint"}},"hasDynamicMetadata":{"type":"boolean","description":"Indicates if dynamic metadata is available for this video clip. If it is, you can retrieve the contents as a\nCSV file through the \"/assets/{clipId}/dynamic-metadata\" endpoint.\n"},"activeGradeName":{"type":"string"},"activeGradeMode":{"type":"integer","description":"Identifies the active grade mode, according to the following table:\n\n0 - unknown,
\n1 - CDL and LUT,
\n2 - CDL Advanced,
\n10 - Alexa Looks,
\n20 - Freestyle,
\n21 - ACES Freestyle,
\n30 - ACES CDL,
\n31 - ACES CDL Advanced,
\n40 - Varicam Compatible,
\n50 - Arri CAP Compatible,
\n60 - Amira Compatible,
\n70 - Colorfront Film,
\n80 - FilmLight BLG
\n","format":"int32","example":2},"activeGradeIdtName":{"type":"string","description":"ACES Input Transform"},"activeGradeIdtId":{"type":"string","description":"ACES Input Transform ID"},"activeGradeGamutCompressionState":{"type":"string","description":"Reference Gamut Compression"},"activeGradeCombinedLmtNodesString":{"type":"string","description":"LMT Node"},"activeGradeOdtName":{"type":"string","description":"ACES Output Transform"},"activeGradeOdtId":{"type":"string","description":"ACES Output Transform ID"},"activeGradeAcesModeString":{"type":"string"},"rawSettings":{"$ref":"#/components/schemas/RawSettingsInfoApiDTO"},"assetType":{"type":"string","description":"Asset type ('VideoClip')","enum":["VideoClip","AudioClip","Shot","Document"]},"xxHash":{"type":"string","description":"xxHash (non-cryptographic 32bit hash) of the asset","example":"61309CE8"},"eiIso":{"type":"integer","description":"Exposure Index, ISO or ASA value from the clip metadata","format":"int32","example":200}}}]},"Volume":{"type":"object","properties":{"id":{"type":"string"},"diskIdentifier":{"type":"string"},"fileCreationDate":{"type":"string","format":"date-time"},"label":{"type":"string"},"registrationDate":{"type":"string","format":"date-time"},"comment":{"type":"string"},"projectId":{"type":"string"},"revisionNumber":{"type":"integer","format":"int64"},"createdBy":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUsageInfo":{"$ref":"#/components/schemas/LastUsageInfoDTO"}},"description":"DTO class representing a volume (storage medium)"}}}}