{"components":{"schemas":{"ACLUpdateSchema":{"properties":{"group_ids":{"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"},"mode":{"enum":["APPEND","OVERWRITE"],"type":"string"},"permissions":{"items":{"enum":["read","delete","change-acl","write"],"type":"string"},"type":"array"},"user_ids":{"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},"required":["mode","permissions"],"type":"object"},"AddToCollectionActionParameters":{"properties":{"collection_id":{"format":"uuid","type":"string"},"index_immediately":{"type":"boolean"}},"required":["collection_id"],"type":"object"},"AddToCollectionActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/AddToCollectionActionParameters"},"type":{"default":"ADD_TO_COLLECTION","enum":["ADD_TO_COLLECTION"]}},"required":["parameters","type"],"type":"object"},"AnalyzeActionParameters":{"properties":{"force":{"default":false,"type":"boolean"},"force_type":{"default":"OVERWRITE","enum":["OVERWRITE","APPEND"],"nullable":true,"type":"string"}},"type":"object"},"AnalyzeActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/AnalyzeActionParameters"},"type":{"default":"ANALYZE","enum":["ANALYZE"]}},"required":["parameters","type"],"type":"object"},"ArchiveActionParameters":{"properties":{"allow_duplicate_transfers":{"default":false,"type":"boolean"},"allow_host_transfer":{"default":true,"type":"boolean"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"nullable":true,"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["destination_storage_id"],"type":"object"},"ArchiveActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/ArchiveActionParameters"},"type":{"default":"ARCHIVE","enum":["ARCHIVE"]}},"required":["parameters","type"],"type":"object"},"AssetArchivedTriggerParameters":{"properties":{"storage_id":{"format":"uuid","type":"string"}},"type":"object"},"AssetArchivedTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/AssetArchivedTriggerParameters"},"type":{"default":"ARCHIVE","enum":["ARCHIVE"]}},"required":["parameters","type"],"type":"object"},"AssetOnlineTriggerParameters":{"properties":{"only_first_version":{"enum":[true],"type":"boolean"},"wait_for_transcode":{"type":"boolean"}},"required":["only_first_version","wait_for_transcode"],"type":"object"},"AssetOnlineTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/AssetOnlineTriggerParameters"},"type":{"default":"ASSET_ONLINE","enum":["ASSET_ONLINE"]}},"required":["parameters","type"],"type":"object"},"AssetRestoredTriggerParameters":{"properties":{"storage_id":{"format":"uuid","type":"string"}},"type":"object"},"AssetRestoredTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/AssetRestoredTriggerParameters"},"type":{"default":"RESTORE","enum":["RESTORE"]}},"required":["parameters","type"],"type":"object"},"AssetSharedTriggerParameters":{"properties":{"allow_download":{"nullable":true,"type":"boolean"}},"type":"object"},"AssetSharedTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/AssetSharedTriggerParameters"},"type":{"default":"ASSET_SHARE","enum":["ASSET_SHARE"]}},"required":["parameters","type"],"type":"object"},"AssetTransferredToStorageParameters":{"properties":{"format":{"nullable":true,"type":"string"},"storage_id":{"format":"uuid","type":"string"}},"required":["storage_id"],"type":"object"},"AssetTransferredToStorageTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/AssetTransferredToStorageParameters"},"type":{"default":"TRANSFER_TO_STORAGE","enum":["TRANSFER_TO_STORAGE"]}},"required":["parameters","type"],"type":"object"},"AutomationHistorySchema":{"properties":{"automation_id":{"format":"uuid","type":"string"},"date_executed":{"format":"date-time","readOnly":true,"type":"string"},"error_message":{"type":"string"},"job_id":{"format":"uuid","type":"string"},"object_id":{"format":"uuid","type":"string"},"object_type":{"type":"string"},"status":{"enum":["SUCCEED","FAILED"],"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["automation_id","object_id","object_type","status","system_domain_id","version_id"],"type":"object"},"AutomationInternalSchema":{"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/AnalyzeActionSchema"},{"$ref":"#/components/schemas/ExtractFacesAction"},{"$ref":"#/components/schemas/CreatePublicationJobAction"},{"$ref":"#/components/schemas/ArchiveActionSchema"},{"$ref":"#/components/schemas/RestoreAction"},{"$ref":"#/components/schemas/ExportAction"},{"$ref":"#/components/schemas/UpdateACLAction"},{"$ref":"#/components/schemas/MetadataUpdateAction"},{"$ref":"#/components/schemas/TranscodeAction"},{"$ref":"#/components/schemas/TransferAction"},{"$ref":"#/components/schemas/RequestOriginalAction"},{"$ref":"#/components/schemas/AddToCollectionActionSchema"},{"$ref":"#/components/schemas/TranscribeAction"},{"$ref":"#/components/schemas/CreateShareAction"},{"$ref":"#/components/schemas/DeleteAction"},{"$ref":"#/components/schemas/DeleteFileSetAction"},{"$ref":"#/components/schemas/RestrictAssetAction"},{"$ref":"#/components/schemas/RemoveAssetRestrictionAction"},{"$ref":"#/components/schemas/RequestReviewAction"},{"$ref":"#/components/schemas/TriggerCustomAction"}]},"type":"array"},"conditions":{"items":{"$ref":"#/components/schemas/Condition"},"type":"array"},"created_by":{"format":"uuid","readOnly":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"modified_by":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"triggers":{"items":{"$ref":"#/components/schemas/Trigger"},"type":"array"}},"required":["actions","name","triggers"],"type":"object"},"AutomationRunEstimateSchema":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"facets":{"additionalProperties":{"$ref":"#/components/schemas/FacetSchema"},"type":"object"},"total":{"readOnly":true,"type":"integer"}},"type":"object"},"AutomationSchema":{"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/AnalyzeActionSchema"},{"$ref":"#/components/schemas/ExtractFacesAction"},{"$ref":"#/components/schemas/CreatePublicationJobAction"},{"$ref":"#/components/schemas/ArchiveActionSchema"},{"$ref":"#/components/schemas/RestoreAction"},{"$ref":"#/components/schemas/ExportAction"},{"$ref":"#/components/schemas/UpdateACLAction"},{"$ref":"#/components/schemas/MetadataUpdateAction"},{"$ref":"#/components/schemas/TranscodeAction"},{"$ref":"#/components/schemas/TransferAction"},{"$ref":"#/components/schemas/RequestOriginalAction"},{"$ref":"#/components/schemas/AddToCollectionActionSchema"},{"$ref":"#/components/schemas/TranscribeAction"},{"$ref":"#/components/schemas/CreateShareAction"},{"$ref":"#/components/schemas/DeleteAction"},{"$ref":"#/components/schemas/DeleteFileSetAction"},{"$ref":"#/components/schemas/RestrictAssetAction"},{"$ref":"#/components/schemas/RemoveAssetRestrictionAction"},{"$ref":"#/components/schemas/RequestReviewAction"},{"$ref":"#/components/schemas/TriggerCustomAction"}]},"maxItems":1,"minItems":1,"type":"array"},"conditions":{"items":{"$ref":"#/components/schemas/Condition"},"type":"array"},"created_by":{"format":"uuid","readOnly":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"modified_by":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"triggers":{"items":{"oneOf":[{"$ref":"#/components/schemas/MetadataUpdateTrigger"},{"$ref":"#/components/schemas/AssetSharedTriggerSchema"},{"$ref":"#/components/schemas/SubtitleAddedTrigger"},{"$ref":"#/components/schemas/ReviewStatusChangedTrigger"},{"$ref":"#/components/schemas/AssetOnlineTriggerSchema"},{"$ref":"#/components/schemas/VersionOnlineTrigger"},{"$ref":"#/components/schemas/AssetTransferredToStorageTriggerSchema"},{"$ref":"#/components/schemas/AssetArchivedTriggerSchema"},{"$ref":"#/components/schemas/AssetRestoredTriggerSchema"},{"$ref":"#/components/schemas/CreatedAtTransitionTrigger"},{"$ref":"#/components/schemas/ModifiedAtTransitionTrigger"},{"$ref":"#/components/schemas/ObjectAddedToCollectionTrigger"},{"$ref":"#/components/schemas/ObjectRemovedFromCollectionTrigger"}]},"maxItems":10,"minItems":1,"type":"array"}},"required":["actions","name","triggers"],"type":"object"},"AutomationStatsObjectSchema":{"properties":{"name":{"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"type":{"enum":["GAUGE"],"type":"string"},"value":{"type":"integer"}},"required":["name","system_domain_id","type","value"],"type":"object"},"AutomationStatsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/AutomationStatsObjectSchema"},"readOnly":true,"type":"array"}},"type":"object"},"AutomationsInternalSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/AutomationInternalSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"AutomationsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/AutomationSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"BucketSchema":{"properties":{"doc_count":{"readOnly":true,"type":"integer"},"key":{"readOnly":true,"type":"string"}},"type":"object"},"Condition":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/Condition"},"type":"array"},"filters":{"items":{"$ref":"#/components/schemas/Condition"},"readOnly":true,"type":"array"},"operator":{"type":"string"},"path":{"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/Term"},"type":"array"}},"required":["operator"],"type":"object"},"ConditionSchema":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/ConditionSchema"},"type":"array"},"filters":{"items":{"$ref":"#/components/schemas/ConditionSchema"},"readOnly":true,"type":"array"},"operator":{"type":"string"},"path":{"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/Term"},"type":"array"}},"required":["operator"],"type":"object"},"CreatePublicationJobAction":{"properties":{"parameters":{"$ref":"#/components/schemas/CreatePublicationJobParameters"},"type":{"default":"CREATE_PUBLICATION_JOB","enum":["CREATE_PUBLICATION_JOB"]}},"required":["parameters","type"],"type":"object"},"CreatePublicationJobActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/CreatePublicationJobParameters"},"type":{"default":"CREATE_PUBLICATION_JOB","enum":["CREATE_PUBLICATION_JOB"]}},"required":["parameters","type"],"type":"object"},"CreatePublicationJobParameters":{"properties":{"template":{"$ref":"#/components/schemas/CreatePublicationTemplate"},"user_id":{"format":"uuid","type":"string"}},"required":["template","user_id"],"type":"object"},"CreatePublicationTemplate":{"properties":{"data":{"additionalProperties":{},"type":"object"},"id":{"type":"string"}},"required":["id"],"type":"object"},"CreateShareAction":{"properties":{"parameters":{"$ref":"#/components/schemas/CreateShareActionParameters"},"type":{"default":"CREATE_SHARE","enum":["CREATE_SHARE"]}},"required":["parameters","type"],"type":"object"},"CreateShareActionParameters":{"properties":{"allow_approving_comments":{"type":"boolean"},"allow_comments":{"type":"boolean"},"allow_custom_actions":{"type":"boolean"},"allow_download":{"type":"boolean"},"allow_download_proxy":{"type":"boolean"},"allow_setting_approve_status":{"type":"boolean"},"allow_upload":{"type":"boolean"},"allow_user_search_for_mentions":{"type":"boolean"},"allow_view_transcriptions":{"type":"boolean"},"allow_view_versions":{"type":"boolean"},"emails":{"items":{"format":"email","type":"string"},"type":"array"},"expires_in_days":{"default":null,"format":"int32","minimum":1,"nullable":true,"type":"integer"},"has_password":{"readOnly":true},"message":{"type":"string"},"metadata_views":{"items":{"type":"string"},"nullable":true,"type":"array"},"password":{"default":null,"nullable":true,"type":"string","writeOnly":true},"show_watermark":{"type":"boolean"},"title":{"type":"string"},"upload_storage_id":{"format":"uuid","nullable":true,"type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["allow_approving_comments","allow_comments","allow_download","allow_setting_approve_status","emails","user_id"],"type":"object"},"CreateShareActionParametersSchema":{"properties":{"allow_approving_comments":{"type":"boolean"},"allow_comments":{"type":"boolean"},"allow_custom_actions":{"type":"boolean"},"allow_download":{"type":"boolean"},"allow_download_proxy":{"type":"boolean"},"allow_setting_approve_status":{"type":"boolean"},"allow_upload":{"type":"boolean"},"allow_user_search_for_mentions":{"type":"boolean"},"allow_view_transcriptions":{"type":"boolean"},"allow_view_versions":{"type":"boolean"},"emails":{"items":{"format":"email","type":"string"},"type":"array"},"expires_in_days":{"default":null,"format":"int32","minimum":1,"nullable":true,"type":"integer"},"has_password":{"readOnly":true},"message":{"type":"string"},"metadata_views":{"items":{"type":"string"},"nullable":true,"type":"array"},"password":{"default":null,"nullable":true,"type":"string","writeOnly":true},"show_watermark":{"type":"boolean"},"title":{"type":"string"},"upload_storage_id":{"format":"uuid","nullable":true,"type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["allow_approving_comments","allow_comments","allow_download","allow_setting_approve_status","emails","user_id"],"type":"object"},"CreateShareActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/CreateShareActionParametersSchema"},"type":{"default":"CREATE_SHARE","enum":["CREATE_SHARE"]}},"required":["parameters","type"],"type":"object"},"CreatedAtTransitionTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/CreatedAtTransitionTriggerParameters"},"type":{"default":"CREATED_AT_TRANSITION","enum":["CREATED_AT_TRANSITION"]}},"required":["parameters","type"],"type":"object"},"CreatedAtTransitionTriggerParameters":{"properties":{"days_since_created":{"description":"Indicates a number of days passed since an objects was created.","format":"int32","minimum":1,"type":"integer"}},"required":["days_since_created"],"type":"object"},"CreatedAtTransitionTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/CreatedAtTransitionTriggerParameters"},"type":{"default":"CREATED_AT_TRANSITION","enum":["CREATED_AT_TRANSITION"]}},"required":["parameters","type"],"type":"object"},"DeleteAction":{"properties":{"parameters":{"type":"object"},"type":{"default":"DELETE_ASSET","enum":["DELETE_ASSET"]}},"required":["type"],"type":"object"},"DeleteActionSchema":{"properties":{"parameters":{"type":"object"},"type":{"default":"DELETE_ASSET","enum":["DELETE_ASSET"]}},"required":["type"],"type":"object"},"DeleteFileSetAction":{"properties":{"parameters":{"$ref":"#/components/schemas/DeleteFileSetActionParameters"},"type":{"default":"DELETE_FILE_SET","enum":["DELETE_FILE_SET"]}},"required":["parameters","type"],"type":"object"},"DeleteFileSetActionParameters":{"properties":{"format":{"type":"string"},"storage_id":{"format":"uuid","type":"string"}},"required":["format","storage_id"],"type":"object"},"DeleteFileSetActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/DeleteFileSetActionParameters"},"type":{"default":"DELETE_FILE_SET","enum":["DELETE_FILE_SET"]}},"required":["parameters","type"],"type":"object"},"ExportAction":{"properties":{"parameters":{"$ref":"#/components/schemas/ExportActionParameters"},"type":{"default":"EXPORT","enum":["EXPORT"]}},"required":["parameters","type"],"type":"object"},"ExportActionParameters":{"properties":{"export_location_id":{"format":"uuid","type":"string"},"export_metadata":{"nullable":true,"type":"boolean"},"export_to_asset_folder":{"nullable":true,"type":"boolean"},"file_name":{"nullable":true,"type":"string"},"format_id":{"format":"uuid","nullable":true,"type":"string"},"metadata_format":{"enum":["CSV","JSON","XML"],"nullable":true,"type":"string"},"metadata_view":{"format":"uuid","nullable":true,"type":"string"},"overwrite":{"nullable":true,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"},"transcode_profile_ids":{"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},"required":["export_location_id"],"type":"object"},"ExportActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/ExportActionParameters"},"type":{"default":"EXPORT","enum":["EXPORT"]}},"required":["parameters","type"],"type":"object"},"ExtractFacesAction":{"properties":{"parameters":{"$ref":"#/components/schemas/ExtractFacesParameters"},"type":{"default":"EXTRACT_FACES","enum":["EXTRACT_FACES"]}},"required":["parameters","type"],"type":"object"},"ExtractFacesActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/ExtractFacesParameters"},"type":{"default":"EXTRACT_FACES","enum":["EXTRACT_FACES"]}},"required":["parameters","type"],"type":"object"},"ExtractFacesParameters":{"properties":{"face_image_analysis_profile_id":{"format":"uuid","nullable":true,"type":"string"},"face_video_analysis_profile_id":{"format":"uuid","nullable":true,"type":"string"},"force":{"default":false,"type":"boolean"}},"type":"object"},"FacetSchema":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/BucketSchema"},"type":"array"},"doc_count_error_upper_bound":{"readOnly":true,"type":"integer"},"sum_other_doc_count":{"readOnly":true,"type":"integer"}},"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"MetadataFieldValueSchema":{"properties":{"field_values":{"items":{"type":"object"},"type":"array"}},"type":"object"},"MetadataFieldValueUpdateSchema":{"properties":{"field_values":{"items":{"type":"object"},"type":"array"},"mode":{"default":"overwrite","enum":["append","delete","overwrite"],"type":"string"}},"type":"object"},"MetadataUpdateAction":{"properties":{"parameters":{"$ref":"#/components/schemas/MetadataUpdateActionParameters"},"type":{"default":"METADATA_UPDATE","enum":["METADATA_UPDATE"]}},"required":["parameters","type"],"type":"object"},"MetadataUpdateActionParameters":{"properties":{"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueUpdateSchema"},"type":"object"},"metadata_view_id":{"format":"uuid","type":"string"}},"required":["metadata_values","metadata_view_id"],"type":"object"},"MetadataUpdateActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/MetadataUpdateActionParameters"},"type":{"default":"METADATA_UPDATE","enum":["METADATA_UPDATE"]}},"required":["parameters","type"],"type":"object"},"MetadataUpdateTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/MetadataUpdateTriggerParameters"},"type":{"default":"METADATA_UPDATE","enum":["METADATA_UPDATE"]}},"required":["parameters","type"],"type":"object"},"MetadataUpdateTriggerParameters":{"properties":{"event_type":{"enum":["ASSETS","COLLECTIONS"],"type":"string"},"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueSchema"},"type":"object"}},"required":["event_type","metadata_values"],"type":"object"},"MetadataUpdateTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/MetadataUpdateTriggerParameters"},"type":{"default":"METADATA_UPDATE","enum":["METADATA_UPDATE"]}},"required":["parameters","type"],"type":"object"},"ModifiedAtTransitionTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/ModifiedAtTransitionTriggerParameters"},"type":{"default":"MODIFIED_AT_TRANSITION","enum":["MODIFIED_AT_TRANSITION"]}},"required":["parameters","type"],"type":"object"},"ModifiedAtTransitionTriggerParameters":{"properties":{"days_since_modified":{"description":"Indicates a number of days passed since an objects was modified.","format":"int32","minimum":1,"type":"integer"}},"required":["days_since_modified"],"type":"object"},"ModifiedAtTransitionTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/ModifiedAtTransitionTriggerParameters"},"type":{"default":"MODIFIED_AT_TRANSITION","enum":["MODIFIED_AT_TRANSITION"]}},"required":["parameters","type"],"type":"object"},"ObjectAddedToCollectionTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/_ObjectCollectionTriggerParameters"},"type":{"default":"OBJECT_ADDED_TO_COLLECTION","enum":["OBJECT_ADDED_TO_COLLECTION"]}},"required":["parameters","type"],"type":"object"},"ObjectAddedToCollectionTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/_ObjectCollectionTriggerParameters"},"type":{"default":"OBJECT_ADDED_TO_COLLECTION","enum":["OBJECT_ADDED_TO_COLLECTION"]}},"required":["parameters","type"],"type":"object"},"ObjectRemovedFromCollectionTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/_ObjectCollectionTriggerParameters"},"type":{"default":"OBJECT_REMOVED_FROM_COLLECTION","enum":["OBJECT_REMOVED_FROM_COLLECTION"]}},"required":["parameters","type"],"type":"object"},"ObjectRemovedFromCollectionTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/_ObjectCollectionTriggerParameters"},"type":{"default":"OBJECT_REMOVED_FROM_COLLECTION","enum":["OBJECT_REMOVED_FROM_COLLECTION"]}},"required":["parameters","type"],"type":"object"},"RangeFilter":{"properties":{"max":{"type":"string"},"min":{"type":"string"},"timezone":{"description":"Format: +02:00. Results returned in UTC by default","type":"string"}},"type":"object"},"RangeFilterSchema":{"properties":{"max":{"type":"string"},"min":{"type":"string"},"timezone":{"description":"Format: +02:00. Results returned in UTC by default","type":"string"}},"type":"object"},"RemoveAssetRestrictionAction":{"properties":{"parameters":{"$ref":"#/components/schemas/RemoveAssetRestrictionActionParameters"},"type":{"default":"REMOVE_ASSET_RESTRICTION","enum":["REMOVE_ASSET_RESTRICTION"]}},"required":["parameters","type"],"type":"object"},"RemoveAssetRestrictionActionParameters":{"properties":{"restrict_metadata_field":{"type":"string"},"warning_metadata_field":{"type":"string"}},"required":["restrict_metadata_field"],"type":"object"},"RemoveAssetRestrictionActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/RemoveAssetRestrictionActionParameters"},"type":{"default":"REMOVE_ASSET_RESTRICTION","enum":["REMOVE_ASSET_RESTRICTION"]}},"required":["parameters","type"],"type":"object"},"RequestOriginalAction":{"properties":{"parameters":{"$ref":"#/components/schemas/TransferActionParameters"},"type":{"default":"REQUEST_ORIGINAL","enum":["REQUEST_ORIGINAL"]}},"required":["parameters","type"],"type":"object"},"RequestOriginalActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/TransferActionParameters"},"type":{"default":"REQUEST_ORIGINAL","enum":["REQUEST_ORIGINAL"]}},"required":["parameters","type"],"type":"object"},"RequestReviewAction":{"properties":{"parameters":{"$ref":"#/components/schemas/RequestReviewActionParameters"},"type":{"default":"REQUEST_REVIEW","enum":["REQUEST_REVIEW"]}},"required":["parameters","type"],"type":"object"},"RequestReviewActionParameters":{"properties":{"externals":{"items":{"type":"string"},"type":"array"},"groups":{"items":{"format":"uuid","type":"string"},"type":"array"},"min_number":{"default":1,"format":"int32","minimum":1,"type":"integer"},"share":{"$ref":"#/components/schemas/CreateShareActionParameters"},"status":{"enum":["N/A","REQUESTED","APPROVED","NOT_APPROVED","MIXED"],"type":"string"},"users":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["share"],"type":"object"},"RequestReviewActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/RequestReviewActionParameters"},"type":{"default":"REQUEST_REVIEW","enum":["REQUEST_REVIEW"]}},"required":["parameters","type"],"type":"object"},"RestoreAction":{"properties":{"parameters":{"$ref":"#/components/schemas/RestoreActionParameters"},"type":{"default":"RESTORE","enum":["RESTORE"]}},"required":["parameters","type"],"type":"object"},"RestoreActionParameters":{"properties":{"allow_duplicate_transfers":{"default":false,"type":"boolean"},"allow_host_transfer":{"default":true,"type":"boolean"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"nullable":true,"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["destination_storage_id"],"type":"object"},"RestoreActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/RestoreActionParameters"},"type":{"default":"RESTORE","enum":["RESTORE"]}},"required":["parameters","type"],"type":"object"},"RestrictAssetAction":{"properties":{"parameters":{"$ref":"#/components/schemas/RestrictAssetActionParameters"},"type":{"default":"RESTRICT_ASSET","enum":["RESTRICT_ASSET"]}},"required":["parameters","type"],"type":"object"},"RestrictAssetActionParameters":{"properties":{"restrict_metadata_field":{"type":"string"},"warning":{"type":"string"},"warning_metadata_field":{"type":"string"}},"required":["restrict_metadata_field"],"type":"object"},"RestrictAssetActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/RestrictAssetActionParameters"},"type":{"default":"RESTRICT_ASSET","enum":["RESTRICT_ASSET"]}},"required":["parameters","type"],"type":"object"},"ReviewStatusChangedTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/ReviewStatusChangedTriggerParameters"},"type":{"default":"REVIEW_STATUS_CHANGED","enum":["REVIEW_STATUS_CHANGED"]}},"required":["parameters","type"],"type":"object"},"ReviewStatusChangedTriggerParameters":{"properties":{"statuses":{"items":{"enum":["N/A","REQUESTED","APPROVED","NOT_APPROVED","MIXED"],"type":"string"},"type":"array"}},"type":"object"},"ReviewStatusChangedTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/ReviewStatusChangedTriggerParameters"},"type":{"default":"REVIEW_STATUS_CHANGED","enum":["REVIEW_STATUS_CHANGED"]}},"required":["parameters","type"],"type":"object"},"SubtitleAddedTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/SubtitleAddedTriggerParameters"},"type":{"default":"SUBTITLE_ADDED","enum":["SUBTITLE_ADDED"]}},"required":["parameters","type"],"type":"object"},"SubtitleAddedTriggerParameters":{"properties":{"closed_captions":{"nullable":true,"type":"boolean"},"language":{"nullable":true,"type":"string"}},"type":"object"},"SubtitleAddedTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/SubtitleAddedTriggerParameters"},"type":{"default":"SUBTITLE_ADDED","enum":["SUBTITLE_ADDED"]}},"required":["parameters","type"],"type":"object"},"Term":{"properties":{"exists":{"type":"boolean"},"external":{"type":"object"},"missing":{"type":"boolean"},"name":{"type":"string"},"range":{"$ref":"#/components/schemas/RangeFilter"},"value":{},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"TermSchema":{"properties":{"exists":{"type":"boolean"},"external":{"type":"object"},"missing":{"type":"boolean"},"name":{"type":"string"},"range":{"$ref":"#/components/schemas/RangeFilterSchema"},"value":{},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"TranscodeAction":{"properties":{"parameters":{"$ref":"#/components/schemas/TranscodeActionParameters"},"type":{"default":"TRANSCODE","enum":["TRANSCODE"]}},"required":["parameters","type"],"type":"object"},"TranscodeActionParameters":{"properties":{"format_name":{"default":"ORIGINAL","type":"string"},"prefer_any_cloud":{"type":"boolean"},"preferred_storage_id":{"format":"uuid","type":"string"},"preferred_storage_method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"}},"type":"object"},"TranscodeActionParametersSchema":{"properties":{"format_name":{"default":"ORIGINAL","type":"string"},"prefer_any_cloud":{"type":"boolean"},"preferred_storage_id":{"format":"uuid","type":"string"},"preferred_storage_method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"}},"type":"object"},"TranscodeActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/TranscodeActionParametersSchema"},"type":{"default":"TRANSCODE","enum":["TRANSCODE"]}},"required":["parameters","type"],"type":"object"},"TranscribeAction":{"properties":{"parameters":{"$ref":"#/components/schemas/TranscribeActionParameters"},"type":{"default":"TRANSCRIBE","enum":["TRANSCRIBE"]}},"required":["parameters","type"],"type":"object"},"TranscribeActionParameters":{"properties":{"engine":{"nullable":true,"type":"string"},"force":{"default":false,"type":"boolean"},"language":{"nullable":true,"type":"string"},"speakers":{"format":"int32","maximum":100,"minimum":1,"nullable":true,"type":"integer"},"summary":{"nullable":true,"type":"boolean"},"topics_extraction":{"default":true,"type":"boolean"},"translate_languages":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"TranscribeActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/TranscribeActionParameters"},"type":{"default":"TRANSCRIBE","enum":["TRANSCRIBE"]}},"required":["parameters","type"],"type":"object"},"TransferAction":{"properties":{"parameters":{"$ref":"#/components/schemas/TransferActionParameters"},"type":{"default":"TRANSFER","enum":["TRANSFER"]}},"required":["parameters","type"],"type":"object"},"TransferActionParameters":{"properties":{"allow_host_transfer":{"default":true,"type":"boolean"},"destination_directory_path":{"nullable":true,"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"format_name":{"type":"string"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["destination_storage_id","format_name"],"type":"object"},"TransferActionParametersSchema":{"properties":{"allow_host_transfer":{"default":true,"type":"boolean"},"destination_directory_path":{"nullable":true,"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"format_name":{"type":"string"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["destination_storage_id","format_name"],"type":"object"},"TransferActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/TransferActionParametersSchema"},"type":{"default":"TRANSFER","enum":["TRANSFER"]}},"required":["parameters","type"],"type":"object"},"Trigger":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"event_type":{"enum":["ASSETS","COLLECTIONS"],"type":"string"},"execute_at":{"format":"date-time","type":"string"},"filters":{"items":{"$ref":"#/components/schemas/Condition"},"type":"array"},"object_id":{"format":"uuid","nullable":true,"type":"string"},"operations":{"items":{"enum":["CREATE","UPDATE","DELETE","SHARE","DELAYED_TRIGGER"],"type":"string"},"minItems":1,"type":"array"},"realm":{"enum":["ENTITY","METADATA","FORMATS","FILES","SHARES","JOBS"],"type":"string"},"type":{"enum":["METADATA_UPDATE","ASSET_SHARE","TRANSFER_TO_STORAGE","MODIFIED_AT_TRANSITION","CREATED_AT_TRANSITION","ARCHIVE","RESTORE","ASSET_ONLINE"],"type":"string"}},"required":["event_type","type"],"type":"object"},"TriggerCustomAction":{"properties":{"parameters":{"$ref":"#/components/schemas/TriggerCustomActionParameters"},"type":{"default":"CUSTOM_ACTION","enum":["CUSTOM_ACTION"]}},"required":["parameters","type"],"type":"object"},"TriggerCustomActionParameters":{"properties":{"action_id":{"format":"uuid","type":"string"},"context":{"enum":["ASSET","ASSET_SUBCLIP","BULK"],"type":"string"},"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueSchema"},"type":"object"}},"required":["action_id","context"],"type":"object"},"TriggerCustomActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/TriggerCustomActionParameters"},"type":{"default":"CUSTOM_ACTION","enum":["CUSTOM_ACTION"]}},"required":["parameters","type"],"type":"object"},"TriggerSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"event_type":{"enum":["ASSETS","COLLECTIONS"],"type":"string"},"execute_at":{"format":"date-time","type":"string"},"filters":{"items":{"$ref":"#/components/schemas/ConditionSchema"},"type":"array"},"object_id":{"format":"uuid","nullable":true,"type":"string"},"operations":{"items":{"enum":["CREATE","UPDATE","DELETE","SHARE","DELAYED_TRIGGER"],"type":"string"},"minItems":1,"type":"array"},"realm":{"enum":["ENTITY","METADATA","FORMATS","FILES","SHARES","JOBS"],"type":"string"},"type":{"enum":["METADATA_UPDATE","ASSET_SHARE","TRANSFER_TO_STORAGE","MODIFIED_AT_TRANSITION","CREATED_AT_TRANSITION","ARCHIVE","RESTORE","ASSET_ONLINE"],"type":"string"}},"required":["event_type","type"],"type":"object"},"TriggersSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/TriggerSchema"},"readOnly":true,"type":"array"}},"type":"object"},"UpdateACLAction":{"properties":{"parameters":{"$ref":"#/components/schemas/UpdateACLActionParameters"},"type":{"default":"UPDATE_ACL","enum":["UPDATE_ACL"]}},"required":["parameters","type"],"type":"object"},"UpdateACLActionParameters":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/ACLUpdateSchema"},"type":"array"}},"required":["objects"],"type":"object"},"UpdateACLActionSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/UpdateACLActionParameters"},"type":{"default":"UPDATE_ACL","enum":["UPDATE_ACL"]}},"required":["parameters","type"],"type":"object"},"VersionOnlineTrigger":{"properties":{"parameters":{"$ref":"#/components/schemas/VersionOnlineTriggerParameters"},"type":{"default":"VERSION_ONLINE","enum":["VERSION_ONLINE"]}},"required":["parameters","type"],"type":"object"},"VersionOnlineTriggerParameters":{"properties":{"only_first_version":{"enum":[false],"type":"boolean"},"wait_for_transcode":{"type":"boolean"}},"required":["only_first_version","wait_for_transcode"],"type":"object"},"VersionOnlineTriggerSchema":{"properties":{"parameters":{"$ref":"#/components/schemas/VersionOnlineTriggerParameters"},"type":{"default":"VERSION_ONLINE","enum":["VERSION_ONLINE"]}},"required":["parameters","type"],"type":"object"},"_ActionSchemaBase":{"properties":{"parameters":{"type":"object"}},"type":"object"},"_ObjectCollectionTriggerParameters":{"properties":{"collection_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"include_subcollections":{"default":false,"type":"boolean"},"object_type":{"type":"string"}},"required":["collection_ids","object_type"],"type":"object"},"_ObjectCollectionTriggerParametersSchema":{"properties":{"collection_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"include_subcollections":{"default":false,"type":"boolean"},"object_type":{"type":"string"}},"required":["collection_ids","object_type"],"type":"object"},"_TriggerSchemaBase":{"properties":{"parameters":{"type":"object"}},"type":"object"}}},"info":{"title":"Iconik Automations","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/automations/":{"get":{"description":"\nRequired roles:\n - can_read_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationsSchema"}}},"description":"Returns a list of automation"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List of automations","tags":["automations"]},"post":{"description":"\nRequired roles:\n - can_write_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSchema"}}},"description":"Returns a created automation"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new automation","tags":["automations"]}},"/v1/automations/{automation_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular automation by id","tags":["automations"]},"get":{"description":"\nRequired roles:\n - can_read_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSchema"}}},"description":"Returns an automation"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular automation by id","tags":["automations"]},"patch":{"description":"\nRequired roles:\n - can_write_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSchema"}}},"description":"Returns an updated automation"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update automation","tags":["automations"]},"put":{"description":"\nRequired roles:\n - can_write_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSchema"}}},"description":"Returns an updated automation"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update automation","tags":["automations"]}},"/v1/automations/{automation_id}/history/":{"post":{"description":"\nRequired roles:\n - can_write_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"ttl","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationHistorySchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationHistorySchema"}}},"description":"Returns a created history entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new history entity","tags":["history"]}},"/v1/automations/{automation_id}/history/{object_type}/{object_id}/{version_id}/":{"delete":{"description":"\nRequired roles:\n - can_read_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Returns a history entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"History entity not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete history event","tags":["history"]},"get":{"description":"\nRequired roles:\n - can_read_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationHistorySchema"}}},"description":"Returns a history entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular history entity by id","tags":["history"]}},"/v1/automations/{automation_id}/runs/":{"post":{"description":"\nRequired roles:\n - can_run_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"202":{"description":"Starts the automation run in a background"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Run an automation for existing objects","tags":["automations"]}},"/v1/automations/{automation_id}/runs/estimate/":{"get":{"description":"\nRequired roles:\n - can_run_automations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"automation_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunEstimateSchema"}}},"description":"Returns estimated number objects that might be affected by an automation run"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get estimated number objects that might be affected by an automation run","tags":["automations"]}}},"servers":[{"url":"/API/automations/"}]}