{"openapi":"3.1.0","info":{"title":"Ayon server","description":"Open VFX and Animation pipeline server","version":"1.14.4"},"paths":{"/api/accessGroups/_schema":{"get":{"tags":["Access"],"summary":"Get Access Group Schema","operationId":"get_access_group_schema","parameters":[{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project Name"},"name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accessGroups/{project_name}":{"get":{"tags":["Access"],"summary":"Get Access Groups","description":"Get a list of access group for a given project","operationId":"get_access_groups","parameters":[{"required":true,"schema":{"type":"string","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AccessGroupObject"},"type":"array","title":"Response Get Access Groups Api Accessgroups  Project Name  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accessGroups/{access_group_name}/{project_name}":{"get":{"tags":["Access"],"summary":"Get Access Group","description":"Get an access group definition","operationId":"get_access_group","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Access group name"},"name":"access_group_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Access"],"summary":"Save Access Group","description":"Create or update an access group.\n\nUse `_` as a project name to save a global access group.","operationId":"save_access_group","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Access group name"},"name":"access_group_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Permissions"}],"title":"Data","description":"Set of permissions"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Access"],"summary":"Delete Access Group","description":"Delete an access group","operationId":"delete_access_group","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Access group name"},"name":"access_group_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/access":{"post":{"tags":["Access"],"summary":"Set Projects Access","description":"Set access for multiple projects\n\nThe payload structure is:\n```\n{\n    userName: {\n        projectName: [accessGroupName, ...],\n    }\n}\n```\n\nTo revoke access, set `projectName` to `[]`\nProjects not present in the payload will not be affected","operationId":"set_projects_access","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"type":"object","title":"Payload"},"example":{"alice":{"MyProject01":["editor"],"MyProject02":["artist"]},"bob":{"MyProject01":["artist","reviewer"],"MyProject02":[]}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/share":{"get":{"tags":["Access"],"summary":"Get Share Options","operationId":"get_share_options","parameters":[{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project Name"},"name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareOptions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/actions/list":{"post":{"tags":["Actions"],"summary":"List Available Actions For Context","description":"Get available actions for a context.\n\nThis endpoint is used to get a list of actions that can be performed\non a given context. The context is defined by the project name, entity type,\nand entity ids. The resulting list is then displayed to the user,\nwho can choose to run one of the actions.\n\nSimple actions are actions that do not require any additional\ncomputation, so the list may be returned relatively quickly.\n\nDynamic actions are actions that require additional computation\nto determine if they are available, so they cannot be listed as quickly as\nsimple actions.\n\nSimple actions may be pinned to the entity sidebar.","operationId":"list_available_actions_for_context","parameters":[{"required":false,"schema":{"type":"string","enum":["simple","dynamic","all"],"title":"Action List Mode","default":"simple"},"name":"mode","in":"query"},{"required":false,"schema":{"type":"string","title":"Settings Variant"},"name":"variant","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionContext"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableActionsListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/actions/manage":{"get":{"tags":["Actions"],"summary":"List All Actions","description":"Get a list of all available actions.\n\nThis endpoint is used to get a list of all available actions,\nregardless the context they are available in.\nIn order to get this list, addon has to implement \"get_all_actions\" method.\n\nThis endpoint is used for managing actions (e.g. enable/disable/statistics...)","operationId":"list_all_actions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BaseActionManifest"},"type":"array","title":"Response List All Actions Api Actions Manage Get"}}}}}}},"/api/actions/config":{"post":{"tags":["Actions"],"summary":"Configure Action","operationId":"configure_action","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addonName","in":"query"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addonVersion","in":"query"},{"required":false,"schema":{"type":"string","title":"Action Variant","default":"production"},"name":"variant","in":"query"},{"required":true,"schema":{"type":"string","title":"Action Identifier"},"name":"identifier","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionConfig"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Configure Action Api Actions Config Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/actions/execute":{"post":{"tags":["Actions"],"summary":"Execute Action","description":"Run an action.\n\nThis endpoint is used to run an action on a context.\nThis is called from the frontend when the user selects an action to run.","operationId":"execute_action","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addonName","in":"query"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addonVersion","in":"query"},{"required":false,"schema":{"type":"string","title":"Action Variant","default":"production"},"name":"variant","in":"query"},{"required":true,"schema":{"type":"string","title":"Action Identifier"},"name":"identifier","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender"},"name":"x-sender","in":"header"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender type","default":"api"},"name":"x-sender-type","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionContext"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/actions/take/{token}":{"get":{"tags":["Actions"],"summary":"Take Action","description":"called by launcher\n\nThis is called by the launcher when it is started via\n`ayon-launcher://action?server_url=...&token=...` URI\n\nLauncher connects to the server using the server url and uses the\ntoken to get the action event (token is the event.hash)\n\nThe server then gets the event payload and updates the event status to in_progress\nand returns the event payload to the launcher.\n\nLauncher is then responsible for executing the action based on the payload\nand updating the event status to finished or failed","operationId":"take_action","parameters":[{"required":true,"schema":{"type":"string","pattern":"[a-f0-9]{64}","title":"Action Token"},"name":"token","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TakeResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/actions/abort/{token}":{"post":{"tags":["Actions"],"summary":"Abort Action","description":"called by launcher\n\nThis is called by the launcher to abort an action.","operationId":"abort_action","parameters":[{"required":true,"schema":{"type":"string","pattern":"[a-f0-9]{64}","title":"Action Token"},"name":"token","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbortRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/{entity_type}/{entity_id}/activities":{"post":{"tags":["Activity feed"],"summary":"Post Project Activity","description":"Create an activity.\n\nComment on an entity for example.\nOr subscribe for updates (later)","operationId":"post_project_activity","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"description":"Project level entity type is used in the endpoint path to specify the type of entity to operate on. It is usually one of 'folders', 'products', 'versions', 'representations', 'tasks', 'workfiles'. (trailing 's' is optional).","required":true,"schema":{"type":"string","title":"Project level entity type","description":"Project level entity type is used in the endpoint path to specify the type of entity to operate on. It is usually one of 'folders', 'products', 'versions', 'representations', 'tasks', 'workfiles'. (trailing 's' is optional)."},"name":"entity_type","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectActivityPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateActivityResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/activities/{activity_id}":{"delete":{"tags":["Activity feed"],"summary":"Delete Project Activity","description":"Delete an activity.\n\nOnly the author or an administrator of the activity can delete it.","operationId":"delete_project_activity","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Activity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"activity_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Activity feed"],"summary":"Patch Project Activity","description":"Edit an activity.\n\nAdministrators can edit any activity.\nUsers with the access to the project can edit their own activities,\nand tick/untick checkboxes in the comment","operationId":"patch_project_activity","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Activity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"activity_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/activityCategories":{"get":{"tags":["Activity feed"],"summary":"Get Activity Categories","operationId":"get_activity_categories","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityCategoriesResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/activities/{activity_id}/reactions":{"post":{"tags":["Activity feed"],"summary":"Create Reaction To Activity","operationId":"create_reaction_to_activity","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Activity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"activity_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReactionModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/activities/{activity_id}/reactions/{reaction}":{"delete":{"tags":["Activity feed"],"summary":"Delete Reaction To Activity","operationId":"delete_reaction_to_activity","parameters":[{"description":"The reaction to be deleted","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Reaction","description":"The reaction to be deleted"},"example":"like","name":"reaction","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Activity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"activity_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/suggest":{"post":{"tags":["Activity feed"],"summary":"Suggest Entity Mention","description":"Suggests entity mentions based on the given entity type.\n\nThis is triggered when the user begins commenting on a task,\nfolder, or version. It populates the suggestions dropdown\nwith relevant entities that the user can mention.","operationId":"suggest_entity_mention","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/{entity_type}/{entity_id}/watchers":{"get":{"tags":["Activity feed"],"summary":"Get Entity Watchers","description":"Get watchers of an entity.","operationId":"get_entity_watchers","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"description":"Project level entity type is used in the endpoint path to specify the type of entity to operate on. It is usually one of 'folders', 'products', 'versions', 'representations', 'tasks', 'workfiles'. (trailing 's' is optional).","required":true,"schema":{"type":"string","title":"Project level entity type","description":"Project level entity type is used in the endpoint path to specify the type of entity to operate on. It is usually one of 'folders', 'products', 'versions', 'representations', 'tasks', 'workfiles'. (trailing 's' is optional)."},"name":"entity_type","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatchersModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Activity feed"],"summary":"Set Entity Watchers","operationId":"set_entity_watchers","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"description":"Project level entity type is used in the endpoint path to specify the type of entity to operate on. It is usually one of 'folders', 'products', 'versions', 'representations', 'tasks', 'workfiles'. (trailing 's' is optional).","required":true,"schema":{"type":"string","title":"Project level entity type","description":"Project level entity type is used in the endpoint path to specify the type of entity to operate on. It is usually one of 'folders', 'products', 'versions', 'representations', 'tasks', 'workfiles'. (trailing 's' is optional)."},"name":"entity_type","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatchersModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons":{"get":{"tags":["Addons"],"summary":"List Addons","description":"List all available addons.","operationId":"list_addons","parameters":[{"required":false,"schema":{"type":"boolean","title":"Show details","default":false},"name":"details","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addons__list_addons__AddonList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Addons"],"summary":"Configure Addons","operationId":"configure_addons","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddonConfigRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/api/addons/{addon_name}":{"delete":{"tags":["Addons"],"summary":"Delete Addon","description":"Delete an addon","operationId":"delete_addon","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Purge all data related to the addon","default":false},"name":"purge","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{addon_version}":{"delete":{"tags":["Addons"],"summary":"Delete Addon Version","description":"Delete an addon version","operationId":"delete_addon_version","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Purge all data related to the addon","default":false},"name":"purge","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/install":{"get":{"tags":["Addons"],"summary":"Get Installed Addons List","description":"Get a list of installed addons","operationId":"get_installed_addons_list","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddonInstallListResponseModel"}}}}}},"post":{"tags":["Addons"],"summary":"Upload Addon Zip File","description":"Upload an addon zip file and install it","operationId":"upload_addon_zip_file","parameters":[{"required":false,"schema":{"type":"string","title":"URL to the addon zip file"},"name":"url","in":"query"},{"required":false,"schema":{"type":"string","title":"Addon name"},"name":"addonName","in":"query"},{"required":false,"schema":{"type":"string","title":"Addon version"},"name":"addonVersion","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallAddonResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{version}/schema/{project_name}":{"get":{"tags":["Addons"],"summary":"Get Addon Project Settings Schema","description":"Return the JSON schema of the addon settings.","operationId":"get_addon_project_settings_schema","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Addon Project Settings Schema Api Addons  Addon Name   Version  Schema  Project Name  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{version}/settings/{project_name}":{"get":{"tags":["Addons"],"summary":"Get Addon Project Settings","operationId":"get_addon_project_settings","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"required":false,"schema":{"type":"string","title":"As"},"name":"as","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Addon Project Settings Api Addons  Addon Name   Version  Settings  Project Name  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Addons"],"summary":"Set Addon Project Settings","description":"Set the project overrides of the given addon.","operationId":"set_addon_project_settings","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{version}/overrides/{project_name}":{"get":{"tags":["Addons"],"summary":"Get Addon Project Overrides","operationId":"get_addon_project_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"required":false,"schema":{"type":"string","title":"As"},"name":"as","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Addons"],"summary":"Modify Project Overrides","operationId":"modify_project_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyOverridesRequestModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Addons"],"summary":"Delete Addon Project Overrides","operationId":"delete_addon_project_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{addon_version}/rawOverrides/{project_name}":{"get":{"tags":["Addons"],"summary":"Get Raw Addon Project Overrides","operationId":"get_raw_addon_project_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Raw Addon Project Overrides Api Addons  Addon Name   Addon Version  Rawoverrides  Project Name  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Addons"],"summary":"Set Raw Addon Project Overrides","description":"Set raw studio overrides for an addon.\n\nWarning: this endpoint is not intended for general use and should only be used by\nadministrators. It bypasses the normal validation and processing that occurs when\nmodifying studio overrides through the normal API.\n\nIt won't trigger any events or validation checks, and may result in unexpected\nbehaviour if used incorrectly.","operationId":"set_raw_addon_project_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{version}/siteSettings/schema":{"get":{"tags":["Addons"],"summary":"Get Addon Site Settings Schema","description":"Return the JSON schema of the addon site settings.","operationId":"get_addon_site_settings_schema","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Addon Site Settings Schema Api Addons  Addon Name   Version  Sitesettings Schema Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{version}/siteSettings":{"get":{"tags":["Addons"],"summary":"Get Addon Site Settings","description":"Return the JSON schema of the addon site settings.","operationId":"get_addon_site_settings","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Addon Site Settings Api Addons  Addon Name   Version  Sitesettings Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Addons"],"summary":"Set Addon Site Settings","operationId":"set_addon_site_settings","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"path"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{addon_version}/schema":{"get":{"tags":["Addons"],"summary":"Get Addon Settings Schema","description":"Return the JSON schema of the addon settings.","operationId":"get_addon_settings_schema","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Addon Settings Schema Api Addons  Addon Name   Addon Version  Schema Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{addon_version}/settings":{"get":{"tags":["Addons"],"summary":"Get Addon Studio Settings","description":"Return the settings (including studio overrides) of the given addon.","operationId":"get_addon_studio_settings","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"required":false,"schema":{"type":"string","title":"As"},"name":"as","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Addon Studio Settings Api Addons  Addon Name   Addon Version  Settings Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Addons"],"summary":"Set Addon Studio Settings","description":"Set the studio overrides for the given addon.","operationId":"set_addon_studio_settings","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{addon_version}/overrides":{"get":{"tags":["Addons"],"summary":"Get Addon Studio Overrides","operationId":"get_addon_studio_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"},{"required":false,"schema":{"type":"string","title":"As"},"name":"as","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Addons"],"summary":"Modify Studio Overrides","operationId":"modify_studio_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyOverridesRequestModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Addons"],"summary":"Delete Addon Studio Overrides","operationId":"delete_addon_studio_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/addons/{addon_name}/{addon_version}/rawOverrides":{"get":{"tags":["Addons"],"summary":"Get Raw Addon Studio Overrides","operationId":"get_raw_addon_studio_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Raw Addon Studio Overrides Api Addons  Addon Name   Addon Version  Rawoverrides Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Addons"],"summary":"Set Raw Addon Studio Overrides","description":"Set raw studio overrides for an addon.\n\nWarning: this endpoint is not intended for general use and should only be used by\nadministrators. It bypasses the normal validation and processing that occurs when\nmodifying studio overrides through the normal API.\n\nIt won't trigger any events or validation checks, and may result in unexpected\nbehaviour if used incorrectly.","operationId":"set_raw_addon_studio_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"},{"required":false,"schema":{"type":"string","title":"Variant","default":"production"},"name":"variant","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/anatomy/schema":{"get":{"tags":["Anatomy"],"summary":"Get Anatomy Schema","description":"Returns the anatomy JSON schema.\n\nThe schema is used to display the anatomy preset editor form.","operationId":"get_anatomy_schema","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Anatomy Schema Api Anatomy Schema Get"}}}}}}},"/api/anatomy/presets":{"get":{"tags":["Anatomy"],"summary":"Get Anatomy Presets","description":"Return a list of stored anatomy presets.","operationId":"get_anatomy_presets","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnatomyPresetListModel"}}}}}}},"/api/anatomy/presets/{preset_name}":{"get":{"tags":["Anatomy"],"summary":"Get Anatomy Preset","description":"Returns the anatomy preset with the given name.\n\n- Use `__builtin__` character as a preset name to return the builtin preset.\n- Use `__primary__` character as a preset name to return the primary preset.\n- `_` is an alias for built in preset (deprecated, kept for backward compatibility).","operationId":"get_anatomy_preset","parameters":[{"required":true,"schema":{"type":"string","title":"Preset Name"},"name":"preset_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anatomy"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Anatomy"],"summary":"Update Anatomy Preset","description":"Create/update an anatomy preset with the given name.","operationId":"update_anatomy_preset","parameters":[{"required":true,"schema":{"type":"string","title":"Preset Name"},"name":"preset_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anatomy"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Anatomy"],"summary":"Delete Anatomy Preset","description":"Delete the anatomy preset with the given name.","operationId":"delete_anatomy_preset","parameters":[{"required":true,"schema":{"type":"string","title":"Preset Name"},"name":"preset_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/anatomy/presets/{preset_name}/primary":{"post":{"tags":["Anatomy"],"summary":"Set Primary Preset","description":"Set the given preset as the primary preset.","operationId":"set_primary_preset","parameters":[{"required":true,"schema":{"type":"string","title":"Preset Name"},"name":"preset_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Anatomy"],"summary":"Unset Primary Preset","description":"Unset the primary preset.","operationId":"unset_primary_preset","parameters":[{"required":true,"schema":{"type":"string","title":"Preset Name"},"name":"preset_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/anatomy/presets/{preset_name}/rename":{"post":{"tags":["Anatomy"],"summary":"Rename Anatomy Preset","description":"Set the given preset as the primary preset.","operationId":"rename_anatomy_preset","parameters":[{"required":true,"schema":{"type":"string","title":"Preset Name"},"name":"preset_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenamePresetModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/attributes":{"get":{"tags":["Attributes"],"summary":"Get Attribute List","description":"Return a list of attributes and their configuration.","operationId":"get_attribute_list","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAttributeListModel"}}}}}},"put":{"tags":["Attributes"],"summary":"Set Attribute List","description":"Set the attribute configuration for all (or ao of) attributes","operationId":"set_attribute_list","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetAttributeListModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/attributes/{attribute_name}":{"get":{"tags":["Attributes"],"summary":"Get Attribute Config","description":"Return the configuration for a single attribute.","operationId":"get_attribute_config","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9]{2,64}$","title":"Attribute name"},"name":"attribute_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Attributes"],"summary":"Set Attribute Config","description":"Update attribute configuration","operationId":"set_attribute_config","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9]{2,64}$","title":"Attribute name"},"name":"attribute_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributePutModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Attributes"],"summary":"Delete Attribute","operationId":"delete_attribute","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9]{2,64}$","title":"Attribute name"},"name":"attribute_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Attributes"],"summary":"Patch Attribute Config","description":"Partially update attribute configuration","operationId":"patch_attribute_config","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9]{2,64}$","title":"Attribute name"},"name":"attribute_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributePatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/auth/login":{"post":{"tags":["Authentication"],"summary":"Login","description":"Login using name/password credentials.\n\nReturns access token and user information. The token is used for\nauthentication in other endpoints. It is valid for 24 hours,\nbut it is extended automatically when the user is active.\n\nToken may be revoked by calling the logout endpoint or using\nsession manager.\n\nReturns 401 response if the credentials are invalid.","operationId":"login","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/auth/logout":{"post":{"tags":["Authentication"],"summary":"Logout","description":"Log out the current user.","operationId":"logout","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoutResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/auth/tokenauth":{"get":{"tags":["Authentication"],"summary":"Token Auth Callback","description":"Callback for token authentication.\n\nThis endpoint is used to handle the callback from the token\nauthentication flow. It is not intended to be called directly.","operationId":"token_auth_callback","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponseModel"}}}}}}},"/api/auth/sessions":{"get":{"tags":["Authentication"],"summary":"List Active Sessions","operationId":"list_active_sessions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SessionModel"},"type":"array","title":"Response List Active Sessions Api Auth Sessions Get"}}}}}},"post":{"tags":["Authentication"],"summary":"Create Session","description":"Create user session\n\n- services can use this endpoint to create a session for a user\n- users can use this endpoint to create additional sessions for themselves\n  (e.g. to authenticate Ayon Launcher)","operationId":"create_session","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSessionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/auth/pools":{"get":{"tags":["Authentication"],"summary":"Get User Pools","description":"Get list of user pools","operationId":"get_user_pools","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserPoolModel"},"type":"array","title":"Response Get User Pools Api Auth Pools Get"}}}}}}},"/api/bundles":{"get":{"tags":["Bundles"],"summary":"List Bundles","operationId":"list_bundles","parameters":[{"description":"Include archived bundles","required":false,"schema":{"type":"boolean","title":"Archived","description":"Include archived bundles","default":false},"name":"archived","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBundleModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Bundles"],"summary":"Create New Bundle","operationId":"create_new_bundle","parameters":[{"description":"Force creation of bundle","required":false,"schema":{"type":"boolean","title":"Force","description":"Force creation of bundle","default":false},"name":"force","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/bundles/check":{"post":{"tags":["Bundles"],"summary":"Check Bundle Compatibility","operationId":"check_bundle_compatibility","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBundleResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/bundles/{bundle_name}":{"post":{"tags":["Bundles"],"summary":"Bundle Actions","description":"Perform actions on bundles.","operationId":"bundle_actions","parameters":[{"required":true,"schema":{"type":"string","title":"Bundle Name"},"name":"bundle_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleActionModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Bundles"],"summary":"Delete Existing Bundle","operationId":"delete_existing_bundle","parameters":[{"required":true,"schema":{"type":"string","title":"Bundle Name"},"name":"bundle_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Bundles"],"summary":"Update Bundle","operationId":"update_bundle","parameters":[{"required":true,"schema":{"type":"string","title":"Bundle Name"},"name":"bundle_name","in":"path"},{"description":"Build dependency packages for selected platforms","required":false,"schema":{"items":{"type":"string","enum":["windows","linux","darwin"]},"type":"array","title":"Request build","description":"Build dependency packages for selected platforms"},"name":"build","in":"query"},{"description":"Force creation of bundle","required":false,"schema":{"type":"boolean","title":"Force","description":"Force creation of bundle","default":false},"name":"force","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundlePatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/migrateSettingsByBundle":{"post":{"tags":["Bundles"],"summary":"Migrate Settings By Bundle","description":"Migrate settings of the addons based on the bundles.\n\nWhen called, it collects a list of addons that are present in\nboth source and target bundles and migrates the settings of the\naddons from the source to the target bundle.\n\nTarget bundle should be a production or staging bundle (or a dev bundle),\nbut source bundle can be any bundle.","operationId":"migrate_settings_by_bundle","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrateBundleSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/config/schema":{"get":{"tags":["Configuration"],"summary":"Get Server Config Schema","operationId":"get_server_config_schema","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Server Config Schema Api Config Schema Get"}}}}}}},"/api/config":{"get":{"tags":["Configuration"],"summary":"Get Server Config","description":"Get the server configuration.","operationId":"get_server_config","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerConfigModel"}}}}}},"post":{"tags":["Configuration"],"summary":"Set Server Config","description":"Set the server configuration","operationId":"set_server_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerConfigModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/config/overrides":{"get":{"tags":["Configuration"],"summary":"Get Server Config Overrides","operationId":"get_server_config_overrides","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Server Config Overrides Api Config Overrides Get"}}}}}}},"/api/config/value/{key}":{"get":{"tags":["Configuration"],"summary":"Get Config Value","operationId":"get_config_value","parameters":[{"description":"The key of the configuration value to retrieve","required":true,"schema":{"type":"string","title":"Key","description":"The key of the configuration value to retrieve"},"name":"key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Config Value Api Config Value  Key  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/config/files/{file_type}":{"get":{"tags":["Configuration"],"summary":"Get Server Config File","description":"Get a file from the server configuration.","operationId":"get_server_config_file","parameters":[{"required":true,"schema":{"type":"string","enum":["login_background","studio_logo"],"title":"File Type"},"name":"file_type","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Configuration"],"summary":"Upload Server Config File","description":"Upload a file to the server configuration.","operationId":"upload_server_config_file","parameters":[{"description":"The type of file to upload.","required":true,"schema":{"type":"string","enum":["login_background","studio_logo"],"title":"File Type","description":"The type of file to upload."},"example":"login_background","name":"file_type","in":"path"},{"description":"The name of the file.","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9._-]+$","title":"X-File-Name","description":"The name of the file."},"example":"background.jpg","name":"x-file-name","in":"header"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9._-]+/[a-zA-Z0-9._-]+$","title":"Content-Type"},"example":"image/jpeg","name":"content-type","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/desktop/dependencyPackages":{"get":{"tags":["Desktop"],"summary":"List Dependency Packages","description":"Return a list of dependency packages","operationId":"list_dependency_packages","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyPackageList"}}}}}},"post":{"tags":["Desktop"],"summary":"Create Dependency Package","operationId":"create_dependency_package","parameters":[{"description":"URL to the addon zip file","required":false,"schema":{"type":"string","title":"Url","description":"URL to the addon zip file"},"name":"url","in":"query"},{"description":"Deprecated. Use the force.","required":false,"deprecated":true,"schema":{"type":"boolean","title":"Overwrite","description":"Deprecated. Use the force.","default":false},"name":"overwrite","in":"query"},{"description":"Force install the package if it already exists","required":false,"schema":{"type":"boolean","title":"Force","description":"Force install the package if it already exists","default":false},"name":"force","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyPackage"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/desktop/dependencyPackages/{filename}":{"get":{"tags":["Desktop"],"summary":"Download Dependency Package","description":"Download dependency package.\n\nUse this endpoint to download dependency package stored on the server.","operationId":"download_dependency_package","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Desktop"],"summary":"Upload Dependency Package","description":"Upload a dependency package to the server.","operationId":"upload_dependency_package","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Desktop"],"summary":"Delete Dependency Package","description":"Delete a dependency package from the server.\nIf there is an uploaded package, it will be deleted as well.","operationId":"delete_dependency_package","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Desktop"],"summary":"Update Dependency Package","description":"Update dependency package sources","operationId":"update_dependency_package","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcesPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/desktop/installers":{"get":{"tags":["Desktop"],"summary":"List Installers","operationId":"list_installers","parameters":[{"description":"Version of the package","required":false,"schema":{"type":"string","title":"Version","description":"Version of the package"},"name":"version","in":"query"},{"description":"Platform of the package","required":false,"schema":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform","description":"Platform of the package"},"name":"platform","in":"query"},{"required":false,"schema":{"type":"string","enum":["production","staging"],"title":"Variant"},"name":"variant","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallerListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Desktop"],"summary":"Create Installer","operationId":"create_installer","parameters":[{"description":"URL to the addon zip file","required":false,"schema":{"type":"string","title":"Url","description":"URL to the addon zip file"},"name":"url","in":"query"},{"description":"Deprecated. Use the force","required":false,"deprecated":true,"schema":{"type":"boolean","title":"Overwrite","description":"Deprecated. Use the force","default":false},"name":"overwrite","in":"query"},{"description":"Overwrite existing installer","required":false,"schema":{"type":"boolean","title":"Force","description":"Overwrite existing installer","default":false},"name":"force","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Installer"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/desktop/installers/{filename}":{"get":{"tags":["Desktop"],"summary":"Download Installer File","operationId":"download_installer_file","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Desktop"],"summary":"Upload Installer File","operationId":"upload_installer_file","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Desktop"],"summary":"Delete Installer File","operationId":"delete_installer_file","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Desktop"],"summary":"Patch Installer","description":"Update sources for an installer","operationId":"patch_installer","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcesPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists/{entity_list_id}/attributes":{"get":{"tags":["Entity lists"],"summary":"Get Entity List Attributes Definition","description":"Return a list of custom attributes for the entity list.","operationId":"get_entity_list_attributes_definition","parameters":[{"required":true,"schema":{"type":"string","title":"Entity List Id"},"name":"entity_list_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EntityListAttributeDefinition"},"type":"array","title":"Response Get Entity List Attributes Definition Api Projects  Project Name  Lists  Entity List Id  Attributes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Entity lists"],"summary":"Set Entity List Attributes Definition","description":"Set the custom attributes for the entity list.","operationId":"set_entity_list_attributes_definition","parameters":[{"required":true,"schema":{"type":"string","title":"Entity List Id"},"name":"entity_list_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EntityListAttributeDefinition"},"type":"array","title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists/{entity_list_id}/entities":{"get":{"tags":["Entity lists"],"summary":"Get List Entities","description":"Get the entities of a list.","operationId":"get_list_entities","parameters":[{"required":true,"schema":{"type":"string","title":"Entity List Id"},"name":"entity_list_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListEnities"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/entityListFolders":{"get":{"tags":["Entity lists"],"summary":"Get Entity List Folders","operationId":"get_entity_list_folders","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListFoldersResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Entity lists"],"summary":"Create Entity List Folder","operationId":"create_entity_list_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListFolderPostModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/entityListFolders/{folder_id}":{"delete":{"tags":["Entity lists"],"summary":"Delete Entity List Folder","operationId":"delete_entity_list_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Entity lists"],"summary":"Update Entity List Folder","operationId":"update_entity_list_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListFolderPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/entityListFolders/order":{"post":{"tags":["Entity lists"],"summary":"Set Entity List Folders Order","operationId":"set_entity_list_folders_order","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListFolderOrderModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists/{entity_list_id}/items":{"post":{"tags":["Entity lists"],"summary":"Create Entity List Item","operationId":"create_entity_list_item","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListItemPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists/{entity_list_id}/items/{entity_list_item_id}":{"delete":{"tags":["Entity lists"],"summary":"Delete Entity List Item","operationId":"delete_entity_list_item","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_id","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list item ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_item_id","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender"},"name":"x-sender","in":"header"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender type","default":"api"},"name":"x-sender-type","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Entity lists"],"summary":"Update Entity List Item","operationId":"update_entity_list_item","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_id","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list item ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_item_id","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender"},"name":"x-sender","in":"header"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender type","default":"api"},"name":"x-sender-type","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListItemPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists/{list_id}/items":{"patch":{"tags":["Entity lists"],"summary":"Update Entity List Items","operationId":"update_entity_list_items","parameters":[{"required":true,"schema":{"type":"string","title":"List Id"},"name":"list_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender"},"name":"x-sender","in":"header"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender type","default":"api"},"name":"x-sender-type","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListMultiPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists":{"post":{"tags":["Entity lists"],"summary":"Create Entity List","description":"Create a new entity list.\n\nWhen passing list item, position field will be ignored and instead,\nthe position will be determined by the order of the items in the list.","operationId":"create_entity_list","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListSummary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists/{entity_list_id}":{"get":{"tags":["Entity lists"],"summary":"Get Entity List","description":"Get entity list\n\nThis is for testing only. Since lists could be huge,\nit is not recommended to get them using this endpoint,\n\nUse GraphQL API to get the list items instead.","operationId":"get_entity_list","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_id","in":"path"},{"description":"When true, only return metadata","required":false,"schema":{"type":"boolean","title":"Metadata Only","description":"When true, only return metadata","default":false},"name":"metadata_only","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Entity lists"],"summary":"Delete Entity List","description":"Delete entity list from the database","operationId":"delete_entity_list","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Entity lists"],"summary":"Update Entity List","description":"Update entity list metadata","operationId":"update_entity_list","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/lists/{entity_list_id}/materialize":{"post":{"tags":["Entity lists"],"summary":"Materialize Entity List","description":"Materialize an entity list.","operationId":"materialize_entity_list","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity list ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_list_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListSummary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/enum/{enum_name}":{"get":{"tags":["Enums"],"summary":"Get Enum","description":"Get enum values by name.\n\nThis endpoint retrieves the possible values of a specified enum.\nIt accepts query parameters that can influence the resolution of the enum values,\nsuch as filtering based on user permissions or other contextual data.\n\nThese query parameters can vary depending on the enum being requested,\nbut when requested from a project context, `project_name` should be provided.","operationId":"get_enum","parameters":[{"description":"Name of the enum","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z_][a-zA-Z0-9_]*(?:\\.[a-zA-Z_][a-zA-Z0-9_]*)?$","title":"Enum Name","description":"Name of the enum"},"name":"enum_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EnumItem"},"type":"array","title":"Response Get Enum Api Enum  Enum Name  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/enroll":{"post":{"tags":["Events"],"summary":"Enroll","description":"Enroll for a new job.\n\nEnroll for a new job by providing a source topic and target topic.\nUsed by workers to get a new job to process. If there is no job\navailable, request returns 204 (no content).\n\nReturns 503 (service unavailable) if the database pool is almost full.\nProcessing jobs should never block user requests.\n\nNon-error response is returned because having nothing to do is not an error\nand we don't want to spam the logs.","operationId":"enroll","parameters":[{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender"},"name":"x-sender","in":"header"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Sender type","default":"api"},"name":"x-sender-type","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/events":{"post":{"tags":["Events"],"summary":"Post Event","operationId":"post_event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DispatchEventRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DispatchEventResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/events/{event_id}":{"get":{"tags":["Events"],"summary":"Get Event","description":"Get event by ID.\n\nReturn event data with given ID. If event is not found, 404 is returned.","operationId":"get_event","parameters":[{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Event ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"event_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Events"],"summary":"Delete Event","description":"Delete event by ID.","operationId":"delete_event","parameters":[{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Event ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"event_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Events"],"summary":"Update Existing Event","description":"Update existing event.","operationId":"update_existing_event","parameters":[{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Event ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"event_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEventRequestModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/eventops":{"post":{"tags":["Events"],"summary":"Event Operations","operationId":"event_operations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventOperationModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/files":{"post":{"tags":["Files"],"summary":"Upload Project File","description":"Handle uploading a file to a project.\n\nUsed for comment attachments, etc.\nFiles are stored in the `uploads` directory (defined in ayon config).\nEach file is associated with its author, project and optionally an activity.\n\nThe request accepts additional headers for the file metadata:\n- `Content-Type`: The MIME type of the file (required)\n- `X-File-Id`: The ID of the file (optional, will be generated if not provided)\n- `X-File-Name`: The name of the file including the extension (required)\n- `X-Activity-Id`: The ID of the activity the file is associated with (optional)","operationId":"upload_project_file","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"X-File-ID","in":"header"},{"required":false,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Activity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"X-Activity-ID","in":"header"},{"required":true,"schema":{"type":"string","title":"File name"},"name":"x-file-name","in":"header"},{"required":true,"schema":{"type":"string","title":"Content type"},"name":"content-type","in":"header"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFileResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/files/{file_id}":{"get":{"tags":["Files"],"summary":"Get Project File","description":"Get a project file (comment attachment etc.)\n\nThe `preview` query parameter can be used to get\na preview of the file (if available).","operationId":"get_project_file","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Files"],"summary":"Delete Project File","operationId":"delete_project_file","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"head":{"tags":["Files"],"summary":"Get Project File Head","operationId":"get_project_file_head","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/files/{file_id}/info":{"get":{"tags":["Files"],"summary":"Get Project File Info","description":"Get a project file (comment attachment etc.)\n\nThe `preview` query parameter can be used to get\na preview of the file (if available).","operationId":"get_project_file_info","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/files/{file_id}/payload":{"get":{"tags":["Files"],"summary":"Get Project File Payload","operationId":"get_project_file_payload","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/files/{file_id}/thumbnail":{"get":{"tags":["Files"],"summary":"Get Project File Thumbnail","description":"Get a project file (comment attachment etc.)\n\nThe `preview` query parameter can be used to get\na preview of the file (if available).","operationId":"get_project_file_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/files/{file_id}/still":{"get":{"tags":["Files"],"summary":"Get Project File Still","description":"Get a still frame from a video file.\n\nThe `t` query parameter can be used to specify the time in seconds.","operationId":"get_project_file_still","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"File ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"file_id","in":"path"},{"required":false,"schema":{"type":"number","title":"T","default":0.0},"name":"t","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/folders/{folder_id}":{"get":{"tags":["Folders"],"summary":"Get Folder","description":"Retrieve a folder by its ID.","operationId":"get_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Folders"],"summary":"Delete Folder","description":"Delete a folder.\n\nReturns 409 error in there's a published product in the folder or any of\nits subfolders. Otherwise, deletes the folder and all its subfolders.","operationId":"delete_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"},{"description":"Allow recursive deletion","required":false,"schema":{"type":"boolean","title":"Force","description":"Allow recursive deletion","default":false},"name":"force","in":"query"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Folders"],"summary":"Update Folder","description":"Patch (partially update) a folder.\n\nOnce there is a version published, the folder's name and hierarchy\ncannot be changed.","operationId":"update_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/folders":{"get":{"tags":["Folders"],"summary":"Get Folder List","description":"Return all folders in the project. Fast.\n\nThis is a similar endpoint to /hierarchy, but the result\nis a flat list. additionally, this endpoint should be faster\nsince it uses a cache. The cache is updated every time a\nfolder is created, updated, or deleted.\n\nThe endpoint handles ACL and optionally also returns folder attributes.","operationId":"get_folder_list","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"description":"Include folder attributes","required":false,"schema":{"type":"boolean","title":"Attrib","description":"Include folder attributes","default":false},"name":"attrib","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Folders"],"summary":"Create Folder","description":"Create a new folder.","operationId":"create_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/folders/search":{"post":{"tags":["Folders"],"summary":"Search Folders","operationId":"search_folders","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderSearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/hierarchy":{"get":{"tags":["Folders"],"summary":"Get Folder Hierarchy","description":"Return a folder hierarchy of a project.","operationId":"get_folder_hierarchy","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"description":"Full-text search query used to limit the result","required":false,"schema":{"type":"string","title":"Search query","description":"Full-text search query used to limit the result","default":""},"example":"forest","name":"search","in":"query"},{"description":"Comma separated list of folder_types to show","required":false,"schema":{"type":"string","title":"Type filter","description":"Comma separated list of folder_types to show","default":""},"example":"AssetBuild,Shot,Sequence","name":"types","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HierarchyResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/inbox":{"post":{"tags":["Inbox"],"summary":"Manage Inbox Item","description":"Manage inbox items","operationId":"manage_inbox_item","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageInboxItemRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/links/types":{"get":{"tags":["Links"],"summary":"List Link Types","description":"List all link types","operationId":"list_link_types","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkTypeListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/links/types/{link_type}":{"put":{"tags":["Links"],"summary":"Save Link Type","description":"Save a link type","operationId":"save_link_type","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Link Type"},"name":"link_type","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinkTypeRequestModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Links"],"summary":"Delete Link Type","description":"Delete link type","operationId":"delete_link_type","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Link Type"},"name":"link_type","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/links":{"post":{"tags":["Links"],"summary":"Create Entity Link","description":"Create a new entity link.","operationId":"create_entity_link","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinkRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/links/{link_id}":{"delete":{"tags":["Links"],"summary":"Delete Entity Link","description":"Delete a link.\n\nNormal users can only delete links they created.\nManagers can delete any link.","operationId":"delete_entity_link","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Link ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"link_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/market/addons":{"get":{"tags":["Market"],"summary":"Market Addon List","operationId":"market_addon_list","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/market__models__AddonList"}}}}}}},"/api/market/addons/{addon_name}":{"get":{"tags":["Market"],"summary":"Market Addon Detail","operationId":"market_addon_detail","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddonDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/market/addons/{addon_name}/{addon_version}":{"get":{"tags":["Market"],"summary":"Market Addon Version Detail","operationId":"market_addon_version_detail","parameters":[{"required":true,"schema":{"type":"string","title":"Addon Name"},"name":"addon_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Addon Version"},"name":"addon_version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddonVersionDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/market/licenses":{"get":{"tags":["Market"],"summary":"Get Licenses","description":"Get list of licenses.\n\nThis is a cloud-only endpoint.","operationId":"get_licenses","parameters":[{"required":false,"schema":{"type":"boolean","title":"Refresh","default":false},"name":"refresh","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/market/releases":{"get":{"tags":["Market"],"summary":"Get Releases","description":"Get the releases","operationId":"get_releases","parameters":[{"required":false,"schema":{"type":"boolean","title":"All","default":false},"name":"all","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/market/releases/{release_name}":{"get":{"tags":["Market"],"summary":"Get Release Info","description":"Get the release info","operationId":"get_release_info","parameters":[{"required":true,"schema":{"type":"string","title":"Release Name"},"name":"release_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseInfoModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/onboarding/initialize":{"post":{"tags":["Onboarding"],"summary":"Create First Admin","description":"Create the first user and log in.\n\nWhen Ayon is started for the first time, there is no admin user.\nin that case `/api/system/info` contains `{\"noAdmin_user\": true}`.\n\nThe frontend will display a form to create the first admin user.\nusing this endpoint. It will also log in the user and return the same\nresponse as `/api/auth/login`, so the frontend can continue in\nlogged-in mode.","operationId":"create_first_admin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitializeRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/onboarding/abort":{"post":{"tags":["Onboarding"],"summary":"Abort Onboarding","description":"Abort the onboarding process (disable nag screen)","operationId":"abort_onboarding","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/onboarding/restart":{"post":{"tags":["Onboarding"],"summary":"Restart Onboarding","description":"Restart the onboarding process","operationId":"restart_onboarding","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/projects/{project_name}/operations/activities":{"post":{"tags":["Operations"],"summary":"Activities Operations","description":"Perform multiple operations on activities.\n\n- **operations**: List of operations to perform.\n- **can_fail**: If `True`, continue with other operations if one fails.","operationId":"activities_operations","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityOperationsRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityOperationsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/operations":{"post":{"tags":["Operations"],"summary":"Operations","description":"Process multiple operations (create / update / delete) in a single request.\n\nAll operations are processed in the order they are provided in the request.\nIf can_fail is set to False, the processing stops on the first error and\nall previous operations are rolled back. If can_fail is set to True, the\nprocessing continues and all operations are committed.\n\nThe response contains the list of operations with their success status.\nIn case of failure, the error message is provided for each operation.\n\nThis endpoint normally does not return error response, unless there is\na problem with the request itself or an unhandled exception.\nDo not rely on a status code to determine if the operation was successful.\n\nAlways check the `success` field of the response.","operationId":"operations","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationsRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/operations/background":{"post":{"tags":["Operations"],"summary":"Background Operations","description":"The same as `POST /projects/{project_name}/operations` but runs in the background.\nThe response is returned immediately and contains a task ID that can be used to\nquery the status of the task.","operationId":"background_operations","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationsRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundOperationsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/operations/background/{task_id}":{"get":{"tags":["Operations"],"summary":"Get Background Operations Status","description":"Get the status of a background operations task.","operationId":"get_background_operations_status","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundOperationsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/products/{product_id}":{"get":{"tags":["Products"],"summary":"Get Product","description":"Retrieve a product by its ID.","operationId":"get_product","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Product ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"product_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Products"],"summary":"Delete Product","description":"Delete a product.\n\nThis will also delete all the product's versions and representations.","operationId":"delete_product","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Product ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"product_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Products"],"summary":"Update Product","description":"Patch (partially update) a product.","operationId":"update_product","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Product ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"product_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/products":{"post":{"tags":["Products"],"summary":"Create Product","description":"Create a new product.","operationId":"create_product","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/dashboard/entities":{"get":{"tags":["Project dashboard"],"summary":"Get Project Entity Counts","description":"Retrieve entity counts for a given project.","operationId":"get_project_entity_counts","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityCounts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/dashboard/health":{"get":{"tags":["Project dashboard"],"summary":"Get Project Health","operationId":"get_project_health","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/dashboard/activity":{"get":{"tags":["Project dashboard"],"summary":"Get Project Activity","operationId":"get_project_activity","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"description":"Number of days to retrieve activity for","required":false,"schema":{"type":"integer","title":"Days","description":"Number of days to retrieve activity for","default":50},"name":"days","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/dashboard/users":{"get":{"tags":["Project dashboard"],"summary":"Get Project Teams","operationId":"get_project_teams","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectTeamsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projectFolders":{"get":{"tags":["Project folders"],"summary":"Get Project Folders","operationId":"get_project_folders","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFoldersResponseModel"}}}}}},"post":{"tags":["Project folders"],"summary":"Create Project Folder","operationId":"create_project_folder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFolderPostModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projectFolders/{folder_id}":{"delete":{"tags":["Project folders"],"summary":"Delete Project Folder","operationId":"delete_project_folder","parameters":[{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Project folders"],"summary":"Update Project Folder","operationId":"update_project_folder","parameters":[{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFolderPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projectFolders/order":{"post":{"tags":["Project folders"],"summary":"Set Project Folders Order","operationId":"set_project_folders_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFolderOrderModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projectFolders/assign":{"post":{"tags":["Project folders"],"summary":"Assign Projects To Folder","description":"Assign one or more projects to a project folder.\n\nTo remove projects from folders, set `folder_id` to `null`.\nOnly users with manager privileges can perform this action.","operationId":"assign_projects_to_folder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignProjectRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/anatomy":{"get":{"tags":["Projects"],"summary":"Get Project Anatomy","description":"Retrieve a project anatomy.","operationId":"get_project_anatomy","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anatomy"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Projects"],"summary":"Set Project Anatomy","description":"Set a project anatomy.","operationId":"set_project_anatomy","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anatomy"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/bundles":{"post":{"tags":["Projects"],"summary":"Set Project Bundles","description":"Set project bundle\n\nDeprecated: Use the freeze_project_bundle function instead.","operationId":"set_project_bundles","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectBundleModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/api/projects/{project_name}/bundle":{"get":{"tags":["Projects"],"summary":"Get Project Bundle Info","description":"Get project bundle information","operationId":"get_project_bundle_info","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","enum":["production","staging"],"title":"Bundle Variant","default":"production"},"name":"variant","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectBundle"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Projects"],"summary":"Set Project Bundle","description":"Set project bundle","operationId":"set_project_bundle","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","enum":["production","staging"],"title":"Bundle Variant","default":"production"},"name":"variant","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectBundle"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Projects"],"summary":"Unset Project Bundle","description":"Unset project bundle","operationId":"unset_project_bundle","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","enum":["production","staging"],"title":"Bundle Variant","default":"production"},"name":"variant","in":"query"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects":{"get":{"tags":["Projects"],"summary":"List Projects","description":"Return a list of available projects.","operationId":"list_projects","parameters":[{"description":"Page number, starting from 1","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page","description":"Page number, starting from 1","default":1},"name":"page","in":"query"},{"description":"If not provided, the result will not be limited","required":false,"schema":{"type":"integer","title":"Records per page","description":"If not provided, the result will not be limited"},"name":"length","in":"query"},{"description":"If not provided, return projects regardless the flag","required":false,"schema":{"type":"boolean","title":"Show library projects","description":"If not provided, return projects regardless the flag"},"name":"library","in":"query"},{"description":"If not provided, return projects regardless the flag","required":false,"schema":{"type":"boolean","title":"Show active projects","description":"If not provided, return projects regardless the flag"},"name":"active","in":"query"},{"description":"Attribute to order the list by","required":false,"schema":{"type":"string","enum":["name","createdAt","updatedAt"],"title":"Order by","description":"Attribute to order the list by"},"name":"order","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Sort in descending order","default":false},"name":"desc","in":"query"},{"description":"Limit the result to project with the matching name,\n        or its part. % character may be used as a wildcard","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Filter by name","description":"Limit the result to project with the matching name,\n        or its part. % character may be used as a wildcard"},"example":"forest","name":"name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Projects"],"summary":"Deploy Project","description":"Create a new project using the provided anatomy object.\n\nMain purpose is to take an anatomy object and transform its contents\nto the project entity (along with additional data such as the project name).","operationId":"deploy_project","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeployProjectRequestModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/guests":{"get":{"tags":["Projects"],"summary":"List Guest Users","description":"Retrieve a project statistics by its name.","operationId":"list_guest_users","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuestUsersListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Projects"],"summary":"Add Guest User","operationId":"add_guest_user","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGuestUserModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/guests/{email}":{"delete":{"tags":["Projects"],"summary":"Remove Guest User","operationId":"remove_guest_user","parameters":[{"required":true,"schema":{"type":"string","title":"Email"},"name":"email","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/productTypes":{"get":{"tags":["Projects"],"summary":"Get Product Types","description":"Retrieve a project statistics by its name.","operationId":"get_product_types","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductTypesList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}":{"get":{"tags":["Projects"],"summary":"Get Project","description":"Retrieve a project by its name.","operationId":"get_project","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Projects"],"summary":"Create Project","description":"Create a new project.\n\nSince project has no ID, and a unique name is used as its\nidentifier, use PUT request with the name provided in the URL\nto create a new project.\n\nThis is different from the rest of the entities, which use POST\nrequests to create new entities with a unique ID.\n\nImportant: this endpoint only creates a project entity. It does\nnot handle creating its anatomy and assigning users to the project,\nso it should be used only in special cases, when you need a granular\ncontrol over a project creation process. Use `Deploy project`\n([POST] /api/projects) for general usage.","operationId":"create_project","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Projects"],"summary":"Delete Project","description":"Delete a given project including all its entities.","operationId":"delete_project","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Projects"],"summary":"Update Project","description":"Patch a project.\n\nUse a PATCH request to partially update a project.\nFor example change the name or a particular key in 'data'.","operationId":"update_project","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/stats":{"get":{"tags":["Projects"],"summary":"Get Project Stats","description":"Retrieve a project statistics by its name.","operationId":"get_project_stats","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/roots":{"get":{"tags":["Projects"],"summary":"Get Project Roots Overrides","description":"Return overrides for project roots.\n\nThis endpoint is used to get overrides for project roots.\nThe result is an a dictionary with site_id as a key and\na dictionary with root names as keys and root paths as values.","operationId":"get_project_roots_overrides","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"type":"object","title":"Response Get Project Roots Overrides Api Projects  Project Name  Roots Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/roots/{site_id}":{"put":{"tags":["Projects"],"summary":"Set Project Roots Overrides","description":"Set overrides for project roots.","operationId":"set_project_roots_overrides","parameters":[{"required":true,"schema":{"type":"string","title":"Site Id"},"name":"site_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/siteRoots":{"get":{"tags":["Projects"],"summary":"Get Project Site Roots","description":"Return roots for a project on a specific site.\n\nThist takes in account roots declared in the project anatomy\nas well as site overrides. The result is combined and returned\nas a dictionary with root names as keys and root paths as values.\n\nAs the site also defines the platform, the result is specific to\nthe platform of the site.","operationId":"get_project_site_roots","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform"},"name":"platform","in":"query"},{"description":"Site ID may be specified either as a query parameter (`site_id` or `site`) or in a header.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified either as a query parameter (`site_id` or `site`) or in a header."},"name":"x-ayon-site-id","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Response Get Project Site Roots Api Projects  Project Name  Siteroots Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/tags":{"get":{"tags":["Projects"],"summary":"Get Project Tags","description":"List tags used in the project.","operationId":"get_project_tags","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectTagsModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/users":{"get":{"tags":["Projects"],"summary":"Get Project Users","description":"Return a list of users on the project\n\nThis only returns a list of users that have explicitly\nset an access group for the project. It does not include managers\nand admins as they have access to all projects.\n\nThe result is a dictionary where the key is the user's name\nand the value is a list of access groups the user has for the project.\n\nUser invoking this endpoint must have the \"project.access\" read\npermission for the project.","operationId":"get_project_users","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Response Get Project Users Api Projects  Project Name  Users Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/users/{user_name}":{"patch":{"tags":["Projects"],"summary":"Update Project User","description":"Update a user's access groups for a project\n\nThis endpoint is used to update a user's access groups for a project.\nThe invoking user must have the \"project.access\" permission for the project.\n\nThe access groups are a list of strings. The user's access groups\nfor the project will be set to this list.\n\nThe result is a dictionary where the key is the user's name\nand the value is a list of access groups the user has for the project.","operationId":"update_project_user","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Access Groups"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Response Update Project User Api Projects  Project Name  Users  User Name  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/query":{"post":{"tags":["Events"],"summary":"Query","operationId":"query","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Response Query Api Query Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/repreContextFilter":{"post":{"tags":["Representations"],"summary":"Representation Context Filter","description":"Return representation IDs matching the given criteria.","operationId":"representation_context_filter","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/representations/{representation_id}":{"get":{"tags":["Representations"],"summary":"Get Representation","description":"Retrieve a representation by its ID.","operationId":"get_representation","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"representation_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentationModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Representations"],"summary":"Delete Representation","description":"Delete a representation.","operationId":"delete_representation","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"representation_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Representations"],"summary":"Update Representation","description":"Patch (partially update) a representation.","operationId":"update_representation","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"representation_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentationPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/representations":{"post":{"tags":["Representations"],"summary":"Create Representation","description":"Create a new representation.","operationId":"create_representation","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentationPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/resolve":{"post":{"tags":["URIs"],"summary":"Resolve Uris","description":"Resolve a list of ayon:// URIs to entities.\n\nEach URI starts with `ayon://{project_name}/{path}` which\ndetermines the requested folder.\n\nSchemes `ayon://` and `ayon+entity://` are equivalent (ayon is a shorter alias).\n\nAdditional query arguments [`product`, `version`, `representation`]\nor [`task`, `workfile`] are allowed.\nNote that arguments from product/version/representations cannot be mixed with\ntask/workfile arguments.\n\n### Implicit wildcards\n\nThe response contains a list of resolved URIs with the requested entities.\nOne URI can match multiple entities - for example when\n**product** and **representation** are requested,\nthe response will contain all matching **representations**\nfrom all **versions** of the product.\n\n### Explicit wildcards\n\nIt is possible to use a `*` wildcard for querying multiple\nentities at the deepest level of the data structure:\n\n`ayon://my_project/assets/characters?product=setdress?version=*`\nwill return all versions of the given product.\n\n### Representation paths\n\nWhen a representation is requested, the response will contain the\nresolved file path, and if the request contains `X-ayon-site-id`\nheader and `resolve_roots` is set to `true`, in the request,\nthe server will resolve the file path to the actual absolute path.","operationId":"resolve_uris","parameters":[{"description":"Return only file paths","required":false,"schema":{"type":"boolean","title":"Pathonly","description":"Return only file paths","default":false},"name":"pathOnly","in":"query"},{"description":"Site ID may be specified either as a query parameter (`site_id` or `site`) or in a header.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified either as a query parameter (`site_id` or `site`) or in a header."},"name":"x-ayon-site-id","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResolvedURIModel"},"type":"array","title":"Response Resolve Uris Api Resolve Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/products/{product_id}/reviewables":{"get":{"tags":["Reviewables"],"summary":"Get Reviewables For Product","description":"Returns a list of reviewables for a given product.","operationId":"get_reviewables_for_product","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Product ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"product_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VersionReviewablesModel"},"type":"array","title":"Response Get Reviewables For Product Api Projects  Project Name  Products  Product Id  Reviewables Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/versions/{version_id}/reviewables":{"get":{"tags":["Reviewables"],"summary":"Get Reviewables For Version","description":"Returns a list of reviewables for a given version.","operationId":"get_reviewables_for_version","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionReviewablesModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Reviewables"],"summary":"Upload Reviewable","description":"Uploads a reviewable for a given version.","operationId":"upload_reviewable","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"},{"description":"Label","required":false,"schema":{"type":"string","title":"Label","description":"Label"},"name":"label","in":"query"},{"required":true,"schema":{"type":"string","title":"File name"},"name":"x-file-name","in":"header"},{"required":true,"schema":{"type":"string","title":"Content type"},"name":"content-type","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewableModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Reviewables"],"summary":"Sort Version Reviewables","description":"Change the order of reviewables of a given version.\n\nIn the payload, provide a list of activity ids (reviewables)\nin the order you want them to appear in the UI.","operationId":"sort_version_reviewables","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SortReviewablesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/tasks/{task_id}/reviewables":{"get":{"tags":["Reviewables"],"summary":"Get Reviewables For Task","operationId":"get_reviewables_for_task","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Task ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"task_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VersionReviewablesModel"},"type":"array","title":"Response Get Reviewables For Task Api Projects  Project Name  Tasks  Task Id  Reviewables Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/folders/{folder_id}/reviewables":{"get":{"tags":["Reviewables"],"summary":"Get Reviewables For Folder","operationId":"get_reviewables_for_folder","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VersionReviewablesModel"},"type":"array","title":"Response Get Reviewables For Folder Api Projects  Project Name  Folders  Folder Id  Reviewables Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/versions/{version_id}/reviewables/{activity_id}":{"patch":{"tags":["Reviewables"],"summary":"Update Reviewable","description":"Update an existing reviewable,\n\nCurrently it is only possible to update the label of a reviewable.","operationId":"update_reviewable","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Activity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"activity_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReviewablesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/services":{"get":{"tags":["Services"],"summary":"List Services","operationId":"list_services","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceListModel"}}}}}}},"/api/services/{name}":{"put":{"tags":["Services"],"summary":"Spawn Service","operationId":"spawn_service","parameters":[{"required":true,"schema":{"type":"string","title":"Name"},"name":"name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpawnServiceRequestModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Services"],"summary":"Delete Service","operationId":"delete_service","parameters":[{"required":true,"schema":{"type":"string","title":"Name"},"name":"name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/services/{service_name}":{"patch":{"tags":["Services"],"summary":"Patch Service","operationId":"patch_service","parameters":[{"required":true,"schema":{"type":"string","title":"Service Name"},"name":"service_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchServiceRequestModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/hosts":{"get":{"tags":["Services"],"summary":"List Hosts","description":"Return a list of all hosts.\n\nA host is an instance of Ayon Service Host (ASH) that is capable of\nrunning addon services. A host record in the database is created\nautomatically when the host sends a heartbeat to the API.","operationId":"list_hosts","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostListResponseModel"}}}}}}},"/api/hosts/heartbeat":{"post":{"tags":["Services"],"summary":"Host Heartbeat","description":"Send a heartbeat from a host.\n\nThis endpoint is called by ASH to send a heartbeat to the API. The\nheartbeat contains information about the host, its health and the\nstate of its services","operationId":"host_heartbeat","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeartbeatRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeartbeatResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/settings/addons":{"get":{"tags":["Addons"],"summary":"Get All Addons Settings","description":"Return all addon settings for the project.","operationId":"get_all_addons_settings","parameters":[{"required":false,"schema":{"type":"string","enum":["production","staging"],"title":"Settings variant","default":"production"},"name":"variant","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Project"},"name":"project","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Site"},"name":"site","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddonSettingsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/api/settings/addons/siteSettings":{"get":{"tags":["Addons"],"summary":"Get All Site Settings","description":"Return site settings for all enabled addons.\n\nThose are 'global' site settings (from addon.site_settings_model)\nwith no project overrides. When site is not specified, it will\nreturn the default settings provided by the model.","operationId":"get_all_site_settings","parameters":[{"required":false,"schema":{"type":"string","enum":["production","staging"],"title":"Settings variant","default":"production"},"name":"variant","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Site"},"name":"site","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddonSettingsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/api/settings":{"get":{"tags":["Addons"],"summary":"Get All Settings","description":"Return all addon settings\n\n## Studio settings\n\nWhen project name is not specified, studio settings are returned\n\n## Project settings\n\nWhen project_name is specified, endpoint returns project settings\nand if the project has a bundle override, it will return settings\nof the addons specified in the override.\n\nIt is also possible to specify project_bundle_name to set the project\nbundle explicitly (for renderfarms)","operationId":"get_all_settings","parameters":[{"description":"Use explicit bundle name to get the addon list. Current production (or staging) will be used if not set","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Bundle name","description":"Use explicit bundle name to get the addon list. Current production (or staging) will be used if not set"},"name":"bundle_name","in":"query"},{"description":"Return project settings for the given project name. Studio settings will be returned if not set","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name","description":"Return project settings for the given project name. Studio settings will be returned if not set"},"name":"project_name","in":"query"},{"description":"Use explicit project bundle instead of the default one to resolve the project addons.","required":false,"schema":{"type":"string","title":"Project bundle name","description":"Use explicit project bundle instead of the default one to resolve the project addons."},"name":"project_bundle_name","in":"query"},{"description":"Variant of the settings to return. This field is also used to determine which bundle to useif bundle_name or project_bundle_name is not set","required":false,"schema":{"type":"string","title":"Variant","description":"Variant of the settings to return. This field is also used to determine which bundle to useif bundle_name or project_bundle_name is not set","default":"production"},"name":"variant","in":"query"},{"description":"Summary mode. When selected, do not return actual settings instead only return the basic information about the addons in the specified bundles","required":false,"schema":{"type":"boolean","title":"Summary","description":"Summary mode. When selected, do not return actual settings instead only return the basic information about the addons in the specified bundles","default":false},"name":"summary","in":"query"},{"description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported.","required":false,"schema":{"type":"string","title":"Site ID","description":"Site ID may be specified a query parameter. Both `site_id` and its's alias `site` are supported."},"name":"site_id","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":30},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllSettingsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/frontendModules":{"get":{"tags":["System"],"summary":"List Frontend Modules","operationId":"list_frontend_modules","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FrontendModuleListItem"},"type":"array","title":"Response List Frontend Modules Api Frontendmodules Get"}}}}}}},"/api/system/sites":{"get":{"tags":["System"],"summary":"Get Sites","description":"Get list of sites","operationId":"get_sites","parameters":[{"required":false,"schema":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform"},"name":"platform","in":"query"},{"required":false,"schema":{"type":"string","title":"Hostname"},"name":"hostname","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SiteInfo"},"type":"array","title":"Response Get Sites Api System Sites Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/system/sites/{site_id}":{"delete":{"tags":["System"],"summary":"Delete Site","description":"Unregister a site by its ID","operationId":"delete_site","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","title":"Site identifier"},"name":"site_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/info":{"get":{"tags":["System"],"summary":"Get Site Info","description":"Return site information.\n\nThis is the initial endpoint that is called when the user opens the page.\nIt returns information about the site, the current user and the configuration.\n\nIf the user is not logged in, only the login page message (motd) and the\nAPI version are returned.","operationId":"get_site_info","parameters":[{"description":"Include frontend-related information","required":false,"schema":{"type":"boolean","title":"Full","description":"Include frontend-related information","default":false},"name":"full","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/metrics":{"get":{"tags":["System"],"summary":"Get Production Metrics","description":"Get production related metrics","operationId":"get_production_metrics","parameters":[{"description":"Collect system metrics","required":false,"schema":{"type":"boolean","title":"System","description":"Collect system metrics","default":false},"name":"system","in":"query"},{"description":"Collect saturated (more granular) metrics","required":false,"schema":{"type":"boolean","title":"Saturated","description":"Collect saturated (more granular) metrics","default":false},"name":"saturated","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metrics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/metrics/system":{"get":{"tags":["System"],"summary":"Get System Metrics","description":"Get system metrics in Prometheus format","operationId":"get_system_metrics","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/secrets":{"get":{"tags":["System"],"summary":"Get List Of Secrets","description":"Return a list of stored secrets\n\nList all available secret names for managers,\nbut only the values for the admin.","operationId":"get_list_of_secrets","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Secret"},"type":"array","title":"Response Get List Of Secrets Api Secrets Get"}}}}}}},"/api/secrets/{secret_name}":{"get":{"tags":["System"],"summary":"Get Secret","description":"Return a secret value","operationId":"get_secret","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Secret name"},"name":"secret_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["System"],"summary":"Save Secret","description":"Create or update a secret value","operationId":"save_secret","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Secret name"},"name":"secret_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["System"],"summary":"Delete Secret","description":"Delete a secret","operationId":"delete_secret","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Secret name"},"name":"secret_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/system/restart":{"post":{"tags":["System"],"summary":"Request Server Restart","operationId":"request_server_restart","responses":{"200":{"description":"Successful Response"}}}},"/api/system/restartRequired":{"get":{"tags":["System"],"summary":"Get Restart Required","description":"Get the server restart required flag.\n\nThis will return whether the server requires a restart, and the reason for it.","operationId":"get_restart_required","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestartRequiredModel"}}}}}},"post":{"tags":["System"],"summary":"Set Restart Required","description":"Set the server restart required flag.\n\nThis will notify the administrators that the server needs to be restarted.\nWhen the server is ready to restart, the administrator can use\nrestart_server (using /api/system/restart) to trigger server.restart_requested\nevent, which (captured by messaging) will trigger restart_server function\nand restart the server.\n\nHuman-readable reason for the restart can be provided in the `reason` field.","operationId":"set_restart_required","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestartRequiredModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Task","description":"Retrieve a task by its ID.","operationId":"get_task","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Task ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"task_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Tasks"],"summary":"Delete Task","description":"Delete a task.","operationId":"delete_task","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Task ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"task_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Tasks"],"summary":"Update Task","description":"Patch (partially update) a task.","operationId":"update_task","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Task ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"task_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/tasks":{"post":{"tags":["Tasks"],"summary":"Create Task","description":"Create a new task.\n\nUse a POST request to create a new task (with a new id).","operationId":"create_task","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/tasks/{task_id}/assign":{"post":{"tags":["Tasks"],"summary":"Assign Users To Task","description":"Change the list of users assigned to a task.","operationId":"assign_users_to_task","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Task ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"task_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignUsersRequestModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/tasksFolders":{"post":{"tags":["Tasks"],"summary":"Query Tasks Folders","operationId":"query_tasks_folders","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksFoldersQuery"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksFoldersResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/api/projects/{project_name}/teams":{"get":{"tags":["Teams"],"summary":"Get Teams","description":"Get all teams in a project.","operationId":"get_teams","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Show Members","default":false},"name":"show_members","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TeamListItemModel"},"type":"array","title":"Response Get Teams Api Projects  Project Name  Teams Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Teams"],"summary":"Update Teams","description":"Update teams.","operationId":"update_teams","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TeamModel"},"type":"array","title":"Payload"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/teams/{team_name}":{"put":{"tags":["Teams"],"summary":"Save Team","description":"Save a team.","operationId":"save_team","parameters":[{"required":true,"schema":{"type":"string","title":"Team Name"},"name":"team_name","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamPutModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Teams"],"summary":"Delete Team","description":"Delete a team.","operationId":"delete_team","parameters":[{"required":true,"schema":{"type":"string","title":"Team Name"},"name":"team_name","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/teams/{team_name}/members/{member_name}":{"put":{"tags":["Teams"],"summary":"Save Team Member","description":"Save a team member.","operationId":"save_team_member","parameters":[{"required":true,"schema":{"type":"string","title":"Team Name"},"name":"team_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Member Name"},"name":"member_name","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMemberModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Teams"],"summary":"Delete Team Member","description":"Delete a team member.","operationId":"delete_team_member","parameters":[{"required":true,"schema":{"type":"string","title":"Team Name"},"name":"team_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Member Name"},"name":"member_name","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/thumbnails":{"post":{"tags":["Thumbnails"],"summary":"Create Thumbnail","description":"Create a thumbnail.\n\nThis endpoint is used to create a thumbnail not associated with any entity.\nReturns the ID of the created thumbnail. which can be used to assign it to\nan entity.","operationId":"create_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":false,"schema":{"type":"string","title":"Content-Type"},"name":"content-type","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThumbnailResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/thumbnails/{thumbnail_id}":{"get":{"tags":["Thumbnails"],"summary":"Get Thumbnail","description":"Get a thumbnail by its ID.\n\nThis endpoint is used to retrieve a thumbnail by its ID.\nSince this is can be an security issue, this endpoint is only available\nto users with the `manager` role or higher.","operationId":"get_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Thumbnail ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"thumbnail_id","in":"path"},{"required":false,"schema":{"type":"string","enum":["empty","none"],"title":"Placeholder","default":"empty"},"name":"placeholder","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Original","default":false},"name":"original","in":"query"}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Thumbnails"],"summary":"Update Thumbnail","description":"Create or update a thumbnail with a specific ID.\n\nThis endpoint is used to create or update a thumbnail by its ID.\nSince this is can be an security issue, this endpoint is only available\nto users with the `manager` role or higher.","operationId":"update_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Thumbnail ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"thumbnail_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Content-Type"},"name":"content-type","in":"header"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/folders/{folder_id}/thumbnail":{"get":{"tags":["Thumbnails"],"summary":"Get Folder Thumbnail","operationId":"get_folder_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"},{"required":false,"schema":{"type":"string","enum":["empty","none"],"title":"Placeholder","default":"empty"},"name":"placeholder","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Original","default":false},"name":"original","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Thumbnails"],"summary":"Create Folder Thumbnail","description":"Create a new thumbnail for a folder.\n\nReturns a thumbnail ID, which is also saved into the entity\ndatabase record.","operationId":"create_folder_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"folder_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Content-Type"},"name":"content-type","in":"header"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThumbnailResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/versions/{version_id}/thumbnail":{"get":{"tags":["Thumbnails"],"summary":"Get Version Thumbnail","operationId":"get_version_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"},{"required":false,"schema":{"type":"string","enum":["empty","none"],"title":"Placeholder","default":"empty"},"name":"placeholder","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Original","default":false},"name":"original","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Thumbnails"],"summary":"Create Version Thumbnail","operationId":"create_version_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Content-Type"},"name":"content-type","in":"header"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThumbnailResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/workfiles/{workfile_id}/thumbnail":{"get":{"tags":["Thumbnails"],"summary":"Get Workfile Thumbnail","operationId":"get_workfile_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Workfile ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"workfile_id","in":"path"},{"required":false,"schema":{"type":"string","enum":["empty","none"],"title":"Placeholder","default":"empty"},"name":"placeholder","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Original","default":false},"name":"original","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Thumbnails"],"summary":"Create Workfile Thumbnail","operationId":"create_workfile_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Workfile ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"workfile_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Content-Type"},"name":"content-type","in":"header"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThumbnailResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/tasks/{task_id}/thumbnail":{"get":{"tags":["Thumbnails"],"summary":"Get Task Thumbnail","operationId":"get_task_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Task ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"task_id","in":"path"},{"required":false,"schema":{"type":"string","enum":["empty","none"],"title":"Placeholder","default":"empty"},"name":"placeholder","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Original","default":false},"name":"original","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Thumbnails"],"summary":"Create Task Thumbnail","operationId":"create_task_thumbnail","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Task ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"task_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Content-Type"},"name":"content-type","in":"header"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThumbnailResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/uris":{"post":{"tags":["URIs"],"summary":"Get Project Entity Uris","description":"Return a list of Ayon URIs for the given entity IDs.","operationId":"get_project_entity_uris","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUrisRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUrisResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/apikeys":{"get":{"tags":["Users"],"summary":"Get User Api Keys","operationId":"get_user_api_keys","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiKeyModel"},"type":"array","title":"Response Get User Api Keys Api Users  User Name  Apikeys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users"],"summary":"Create User Api Key","operationId":"create_user_api_key","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPostModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/apikeys/{entity_id}":{"delete":{"tags":["Users"],"summary":"Delete User Api Key","operationId":"delete_user_api_key","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Users"],"summary":"Update User Api Key","operationId":"update_user_api_key","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"entity_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/avatar":{"get":{"tags":["Users"],"summary":"Get Avatar","description":"Retrieve the avatar for a given user.","operationId":"get_avatar","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Users"],"summary":"Upload Avatar","description":"Uploads a new avatar for the specified user.","operationId":"upload_avatar","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users"],"summary":"Delete Avatar","operationId":"delete_avatar","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/passwordResetRequest":{"post":{"tags":["Users"],"summary":"Password Reset Request","operationId":"password_reset_request","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordResetRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/passwordReset":{"post":{"tags":["Users"],"summary":"Password Reset","operationId":"password_reset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordResetModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/me/permissions":{"get":{"tags":["Users"],"summary":"Get My Permissions","description":"Return the permissions of the current user.\n\nThe result contains the user's studio permissions\n(taken from the default access groups) and the permissions for each project\nthe user has access to.","operationId":"get_my_permissions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPermissionsModel"}}}}}}},"/api/users/me/permissions/{project_name}":{"get":{"tags":["Users"],"summary":"Get My Project Permissions","description":"Return the project permissions of the current user and the given project","operationId":"get_my_project_permissions","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/permissions":{"get":{"tags":["Users"],"summary":"Get User Studio Permissions","description":"Return the studio permissions of the specified user.","operationId":"get_user_studio_permissions","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/permissions/{project_name}":{"get":{"tags":["Users"],"summary":"Get User Project Permissions","description":"Return the project permissions of the specified user and projects","operationId":"get_user_project_permissions","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/me":{"get":{"tags":["Users"],"summary":"Get Current User","description":"Return the current user information (based on the Authorization header).\nThis is used for a profile page as well as as an initial check to ensure\nthe user is still logged in.","operationId":"get_current_user","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserModel"}}}}}}},"/api/users/{user_name}":{"get":{"tags":["Users"],"summary":"Get User","description":"Return the current user information (based on the Authorization header).\nThis is used for a profile page as well as as an initial check to ensure\nthe user is still logged in.","operationId":"get_user","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UserModel"},{"additionalProperties":{"type":"string"},"type":"object"}],"title":"Response Get User Api Users  User Name  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Users"],"summary":"Create User","description":"Create a new user.","operationId":"create_user","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewUserModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users"],"summary":"Delete User","operationId":"delete_user","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Users"],"summary":"Patch User","operationId":"patch_user","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPatchModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/password":{"patch":{"tags":["Users"],"summary":"Change Password","operationId":"change_password","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/checkPassword":{"post":{"tags":["Users"],"summary":"Check Password","operationId":"check_password","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPasswordRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/rename":{"patch":{"tags":["Users"],"summary":"Change User Name","description":"Changes the user name of a user.\n\nThis is a manager-only operation. Target user name must not exist.\nThis is a dangerous operation and should be used with caution.","operationId":"change_user_name","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeUserNameRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/sessions":{"get":{"tags":["Users"],"summary":"Get User Sessions","operationId":"get_user_sessions","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSessionsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/sessions/{session_id}":{"delete":{"tags":["Users"],"summary":"Delete User Session","operationId":"delete_user_session","parameters":[{"required":true,"schema":{"type":"string","title":"Session Id"},"name":"session_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/accessGroups":{"patch":{"tags":["Users"],"summary":"Assign Access Groups","operationId":"assign_access_groups","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignAccessGroupsRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{user_name}/frontendPreferences":{"patch":{"tags":["Users"],"summary":"Set Frontend Preferences","operationId":"set_frontend_preferences","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Patch Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/versions/{version_id}":{"get":{"tags":["Versions"],"summary":"Get Version","description":"Retrieve a version by its ID.","operationId":"get_version","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Versions"],"summary":"Delete Version","description":"Delete a version.\n\nThis will also delete all representations of the version.","operationId":"delete_version","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Versions"],"summary":"Update Version","description":"Patch (partially update) a version.","operationId":"update_version","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Version ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"version_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionPatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/versions":{"post":{"tags":["Versions"],"summary":"Create Version","description":"Create a new version.\n\nUse a POST request to create a new version (with a new id).","operationId":"create_version","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionPostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/views/{view_type}":{"get":{"tags":["Views"],"summary":"List Views","description":"Get the list of views available to the user.","operationId":"list_views","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Views"],"summary":"Create View","description":"Create a new view for current user.","operationId":"create_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/OverviewViewPostModel"},{"$ref":"#/components/schemas/TaskProgressViewPostModel"},{"$ref":"#/components/schemas/ListsViewPostModel"},{"$ref":"#/components/schemas/ReviewsViewPostModel"},{"$ref":"#/components/schemas/VersionsViewPostModel"},{"$ref":"#/components/schemas/GenericViewPostModel"}],"title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/views/{view_type}/working":{"get":{"tags":["Views"],"summary":"Get Working View","description":"Get the working view of the given type","operationId":"get_working_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/OverviewViewModel"},{"$ref":"#/components/schemas/TaskProgressViewModel"},{"$ref":"#/components/schemas/ListsViewModel"},{"$ref":"#/components/schemas/ReviewsViewModel"},{"$ref":"#/components/schemas/VersionsViewModel"},{"$ref":"#/components/schemas/GenericViewModel"}],"title":"Response Get Working View Api Views  View Type  Working Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/views/{view_type}/base":{"get":{"tags":["Views"],"summary":"Get Base View","description":"Return the base view for the given type.","operationId":"get_base_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/OverviewViewModel"},{"$ref":"#/components/schemas/TaskProgressViewModel"},{"$ref":"#/components/schemas/ListsViewModel"},{"$ref":"#/components/schemas/ReviewsViewModel"},{"$ref":"#/components/schemas/VersionsViewModel"},{"$ref":"#/components/schemas/GenericViewModel"}],"title":"Response Get Base View Api Views  View Type  Base Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/views/{view_type}/default":{"get":{"tags":["Views"],"summary":"Get Default View","description":"Return the view set by the user as default for the given type.\n\nIf no default view is set, it will return the working view of the user.\nIf no working view is set, raise 404","operationId":"get_default_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/OverviewViewModel"},{"$ref":"#/components/schemas/TaskProgressViewModel"},{"$ref":"#/components/schemas/ListsViewModel"},{"$ref":"#/components/schemas/ReviewsViewModel"},{"$ref":"#/components/schemas/VersionsViewModel"},{"$ref":"#/components/schemas/GenericViewModel"}],"title":"Response Get Default View Api Views  View Type  Default Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Views"],"summary":"Set Default View","description":"Set the default view for the user and view type.","operationId":"set_default_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultViewRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/views/{view_type}/{view_id}":{"get":{"tags":["Views"],"summary":"Get View","description":"Get a specific view by its ID.","operationId":"get_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$","title":"View ID"},"example":"54c07b94321511f1831f8e70e23123f9","name":"view_id","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/OverviewViewModel"},{"$ref":"#/components/schemas/TaskProgressViewModel"},{"$ref":"#/components/schemas/ListsViewModel"},{"$ref":"#/components/schemas/ReviewsViewModel"},{"$ref":"#/components/schemas/VersionsViewModel"},{"$ref":"#/components/schemas/GenericViewModel"}],"title":"Response Get View Api Views  View Type   View Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Views"],"summary":"Delete View","description":"Delete a view by its ID.","operationId":"delete_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$","title":"View ID"},"example":"54c07b94321511f1831f8e70e23123f9","name":"view_id","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Views"],"summary":"Update View","description":"Update a view in the database.","operationId":"update_view","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"View type"},"example":"overview","name":"view_type","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$","title":"View ID"},"example":"54c07b94321511f1831f8e70e23123f9","name":"view_id","in":"path"},{"required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"example":"my_project","name":"project_name","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/OverviewViewPatchModel"},{"$ref":"#/components/schemas/TaskProgressViewPatchModel"},{"$ref":"#/components/schemas/ListsViewPatchModel"},{"$ref":"#/components/schemas/ReviewsViewPatchModel"},{"$ref":"#/components/schemas/VersionsViewPatchModel"},{"$ref":"#/components/schemas/GenericViewPatchModel"}],"title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/workfiles/{workfile_id}":{"get":{"tags":["Workfiles"],"summary":"Get Workfile","description":"Retrieve a version by its ID.","operationId":"get_workfile","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Workfile ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"workfile_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkfileModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Workfiles"],"summary":"Delete Workfile","description":"Delete a workfile.","operationId":"delete_workfile","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Workfile ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"workfile_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Workfiles"],"summary":"Update Workfile","description":"Patch (partially update) a workfile.","operationId":"update_workfile","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"},{"required":true,"schema":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Workfile ID"},"example":"af10c8f0e9b111e9b8f90242ac130003","name":"workfile_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkfilePatchModel"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{project_name}/workfiles":{"post":{"tags":["Workfiles"],"summary":"Create Workfile","description":"Create a new workfile.\n\nUse a POST request to create a new workfile","operationId":"create_workfile","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project name"},"name":"project_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkfilePostModel"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/connect":{"get":{"tags":["Ynput Cloud"],"summary":"Get Ynput Cloud Info","description":"Check whether the Ynput Cloud key is set and return the Ynput Cloud info","operationId":"get_ynput_cloud_info","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YnputCloudInfoModel"}}}}}},"post":{"tags":["Ynput Cloud"],"summary":"Set Ynput Cloud Key","description":"Store the Ynput cloud key in the database and return the user info","operationId":"set_ynput_cloud_key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YnputConnectRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YnputCloudInfoModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Ynput Cloud"],"summary":"Delete Ynput Cloud Key","description":"Remove the Ynput cloud key from the database","operationId":"delete_ynput_cloud_key","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/connect/authorize":{"get":{"tags":["Ynput Cloud"],"summary":"Connect To Ynput Cloud","description":"Redirect to Ynput cloud authorization page","operationId":"connect_to_ynput_cloud","parameters":[{"required":true,"schema":{"type":"string","title":"Origin Url"},"name":"origin_url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/connect/feedback":{"get":{"tags":["Ynput Cloud"],"summary":"Get Feedback Verification","description":"Verify feedback availability for the user and return verification data.","operationId":"get_feedback_verification","parameters":[{"required":false,"schema":{"type":"boolean","title":"Force","default":false},"name":"force","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserVerificationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AbortRequestModel":{"properties":{"message":{"type":"string","title":"Message","default":"Action aborted","deprecated":false}},"type":"object","title":"AbortRequestModel","description":"Base API model."},"AccessGroupObject":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the access group","deprecated":false,"example":"artist"},"isProjectLevel":{"type":"boolean","title":"Isprojectlevel","description":"Whether the access group is project level","deprecated":false,"example":false}},"type":"object","required":["name","isProjectLevel"],"title":"AccessGroupObject","description":"Base API model."},"AccessGroupsOnProject":{"properties":{"project":{"type":"string","title":"Project","description":"Project name","deprecated":false},"accessGroups":{"items":{"type":"string"},"type":"array","title":"Accessgroups","description":"List of access groups on the project","deprecated":false}},"type":"object","required":["project","accessGroups"],"title":"AccessGroupsOnProject","description":"Base API model."},"ActionConfig":{"properties":{"projectName":{"type":"string","title":"Project Name","description":"The name of the project. If not provided, use global actions, the rest of the fields are ignored.","deprecated":false,"example":"my_project"},"entityType":{"type":"string","enum":["project","list","folder","task","product","version","representation","workfile"],"title":"Entity Type","description":"The type of the entity. Either a project level entity, 'list' or 'project' for project-wide actions. or None for global actions.","deprecated":false,"example":"folder"},"entitySubtypes":{"items":{"type":"string"},"type":"array","title":"Entity Subtypes","description":"List of subtypes present in the entity list","deprecated":false,"example":["asset"]},"entityIds":{"items":{"type":"string"},"type":"array","title":"Entity IDs","description":"The IDs of the entities","deprecated":false,"example":["1a3bfe33-1b1b-4b1b-8b1b-1b1b1b1b1b1b"]},"formData":{"type":"object","title":"Form Data","description":"The data from the form","deprecated":false,"example":{"key":"value"}},"value":{"type":"object","title":"Action Config","description":"The configuration of the action within the given context","deprecated":false,"example":{"key":"value"}}},"type":"object","title":"ActionConfig","description":"frontend sends this to backend.\nbackend asks addons for actions based on this model."},"ActionContext":{"properties":{"projectName":{"type":"string","title":"Project Name","description":"The name of the project. If not provided, use global actions, the rest of the fields are ignored.","deprecated":false,"example":"my_project"},"entityType":{"type":"string","enum":["project","list","folder","task","product","version","representation","workfile"],"title":"Entity Type","description":"The type of the entity. Either a project level entity, 'list' or 'project' for project-wide actions. or None for global actions.","deprecated":false,"example":"folder"},"entitySubtypes":{"items":{"type":"string"},"type":"array","title":"Entity Subtypes","description":"List of subtypes present in the entity list","deprecated":false,"example":["asset"]},"entityIds":{"items":{"type":"string"},"type":"array","title":"Entity IDs","description":"The IDs of the entities","deprecated":false,"example":["1a3bfe33-1b1b-4b1b-8b1b-1b1b1b1b1b1b"]},"formData":{"type":"object","title":"Form Data","description":"The data from the form","deprecated":false,"example":{"key":"value"}}},"type":"object","title":"ActionContext","description":"frontend sends this to backend.\nbackend asks addons for actions based on this model."},"ActionsAccessList":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"disabled":false},"actions":{"items":{"type":"string"},"type":"array","title":"Actions","disabled":false,"enum_resolver":{"__wrapped__":{},"cache":{"timeout":5.0,"build_key":{},"_serializer":{"encoding":"utf-8"},"_plugins":[],"_cache":{},"_handlers":{}}}}},"type":"object","title":"ActionsAccessList"},"ActivitiesAccessList":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"disabled":false},"activities":{"items":{"type":"string"},"type":"array","title":" ","disabled":false,"widget":"switchbox","enum_resolver":{}}},"type":"object","title":"ActivitiesAccessList"},"ActivityCategoriesResponseModel":{"properties":{"categories":{"items":{"type":"object"},"type":"array","title":"Categories","deprecated":false,"example":[{"name":"category1"}]}},"type":"object","required":["categories"],"title":"ActivityCategoriesResponseModel","description":"Base API model."},"ActivityOperationModel":{"properties":{"id":{"type":"string","title":"Operation ID","description":"identifier manually or automatically assigned to each operation","deprecated":false},"type":{"type":"string","enum":["create","update","delete"],"title":"Operation type","deprecated":false},"activityId":{"type":"string","title":"Activity ID","description":"ID of the activity. None for create","deprecated":false},"data":{"type":"object","title":"Data","description":"Data to be used for create or update. Ignored for delete.See create/patch activity endpoint for details","deprecated":false}},"type":"object","required":["type"],"title":"ActivityOperationModel","description":"Base API model."},"ActivityOperationResponseModel":{"properties":{"id":{"type":"string","title":"Operation ID","deprecated":false},"type":{"type":"string","enum":["create","update","delete"],"title":"Operation type","deprecated":false},"success":{"type":"boolean","title":"Operation success","deprecated":false},"status":{"type":"integer","title":"HTTP-like status code","deprecated":false},"detail":{"type":"string","title":"Error message","deprecated":false},"activityId":{"type":"string","title":"Entity ID","description":"`None` if type is `create` and the operation fails.","deprecated":false}},"type":"object","required":["id","type","success"],"title":"ActivityOperationResponseModel","description":"Base API model."},"ActivityOperationsRequestModel":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/ActivityOperationModel"},"type":"array","title":"Operations","deprecated":false,"example":[{"id":"1","type":"create","data":{"entityType":"folder","entityId":"12345678901234567890123456789012","activity_type":"comment","body":"This is a comment","timestamp":"2021-01-01T00:00:00Z","files":["12345678901234567890123456789012"],"data":{"key":"value"}}},{"id":"2","type":"update","activityId":"12345678901234567890123456789012","data":{"body":"This is an updated comment","files":["12345678901234567890123456789012"],"append_files":true,"data":{"key":"newvalue"}}},{"id":"3","type":"delete","activityId":"12345678901234567890123456789012"}]},"canFail":{"type":"boolean","title":"Canfail","default":false}},"type":"object","title":"ActivityOperationsRequestModel","description":"Base API model."},"ActivityOperationsResponseModel":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/ActivityOperationResponseModel"},"type":"array","title":"Operations","deprecated":false},"success":{"type":"boolean","title":"Overall success","deprecated":false}},"type":"object","required":["success"],"title":"ActivityOperationsResponseModel","description":"Base API model."},"ActivityPatchModel":{"properties":{"body":{"type":"string","title":"Body","description":"When set, update the activity body","deprecated":false,"example":"This is a comment"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"When set, update the activity tags","deprecated":false,"example":["tag1","tag2"]},"files":{"items":{"type":"string"},"type":"array","title":"Files","description":"When set, update the activity files","deprecated":false,"example":["file1","file2"]},"appendFiles":{"type":"boolean","title":"Appendfiles","description":"When true, append files to the existing ones. replace them otherwise","default":false,"deprecated":false,"example":false},"data":{"type":"object","title":"Data","deprecated":false,"example":{"key":"value"}}},"type":"object","title":"ActivityPatchModel","description":"Base API model."},"ActivityResponseModel":{"properties":{"activity":{"items":{"type":"integer"},"type":"array","title":"Activity","description":"Activity per day normalized to 0-100","deprecated":false,"example":[0,0,0,1,12,34,32,24,25,56,18]}},"type":"object","required":["activity"],"title":"ActivityResponseModel","description":"Base API model."},"AddGuestUserModel":{"properties":{"email":{"type":"string","title":"Email","deprecated":false,"example":"foo.bar@example.com"},"fullName":{"type":"string","title":"Full name","deprecated":false,"example":"Foo Bar"}},"type":"object","required":["email"],"title":"AddGuestUserModel","description":"Base API model."},"AddonConfigRequest":{"properties":{"copyVariant":{"allOf":[{"$ref":"#/components/schemas/VariantCopyRequest"}],"title":"Copyvariant","deprecated":false}},"type":"object","title":"AddonConfigRequest","description":"Base API model."},"AddonDetail":{"properties":{"name":{"type":"string","title":"Addon name","deprecated":false,"example":"maya"},"title":{"type":"string","title":"Addon title","deprecated":false,"example":"Maya"},"description":{"type":"string","title":"Description","description":"Addon description","deprecated":false,"example":"Maya is a 3D computer graphics application"},"orgName":{"type":"string","title":"Organization name","deprecated":false,"example":"ynput-official"},"orgTitle":{"type":"string","title":"Organization title","deprecated":false,"example":"Ynput"},"icon":{"type":"string","title":"Icon URL","deprecated":false,"example":"https://example.com/maya.png"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","deprecated":false},"flags":{"items":{"type":"string"},"type":"array","title":"Flags","deprecated":false},"latestVersion":{"type":"string","title":"Latestversion","description":"Latest version of the addon","deprecated":false,"example":"1.0.0"},"links":{"items":{"$ref":"#/components/schemas/LinkModel"},"type":"array","title":"Links","description":"Links to the addon's homepage and GitHub repository","deprecated":false,"example":[{"type":"github","url":"https://github.com/ynput/ayon-maya"}]},"available":{"type":"boolean","title":"Available","description":"Addon is avaliable for download","default":true,"deprecated":false},"currentProductionVersion":{"type":"string","title":"Current production version","deprecated":false,"example":"1.0.0"},"currentLatestVersion":{"type":"string","title":"Latest installed version","deprecated":false,"example":"1.0.0"},"isOutdated":{"type":"boolean","title":"Is the current version outdated","default":false,"deprecated":false,"example":false},"versions":{"items":{"$ref":"#/components/schemas/AddonVersionListItem"},"type":"array","title":"Versions","description":"A list of versions of this addon","deprecated":false},"warning":{"type":"string","title":"Warning","description":"A warning message to display to the user","deprecated":false}},"type":"object","required":["name","title"],"title":"AddonDetail","description":"Base API model."},"AddonDevelopmentItem":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Enable/disable addon development","default":true,"deprecated":false,"example":false},"path":{"type":"string","title":"Path","description":"Path to addon directory","default":"","deprecated":false,"example":"/path/to/addon"}},"type":"object","title":"AddonDevelopmentItem","description":"Base API model."},"AddonInstallListItemModel":{"properties":{"id":{"type":"string","title":"Addon ID","deprecated":false},"topic":{"type":"string","enum":["addon.install","addon.install_from_url"],"title":"Event topic","deprecated":false},"description":{"type":"string","title":"Addon description","deprecated":false},"addonName":{"type":"string","title":"Addon name","deprecated":false},"addonVersion":{"type":"string","title":"Addon version","deprecated":false},"user":{"type":"string","title":"User who installed the addon","deprecated":false},"status":{"type":"string","title":"Event status","deprecated":false},"createdAt":{"type":"string","format":"date-time","title":"Event creation time","deprecated":false},"updatedAt":{"type":"string","format":"date-time","title":"Event update time","deprecated":false}},"type":"object","required":["id","topic","description","status","createdAt"],"title":"AddonInstallListItemModel","description":"Base API model."},"AddonInstallListResponseModel":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AddonInstallListItemModel"},"type":"array","title":"List of addons","deprecated":false},"restartRequired":{"type":"boolean","title":"Restartrequired","deprecated":false}},"type":"object","required":["items","restartRequired"],"title":"AddonInstallListResponseModel","description":"Base API model."},"AddonMetadata":{"properties":{"name":{"type":"string","title":"Addon Name"},"label":{"type":"string","title":"Addon Label"},"options":{"items":{"$ref":"#/components/schemas/EnumItem"},"type":"array","title":"Addon Options"}},"type":"object","required":["name","label","options"],"title":"AddonMetadata","description":"Base API model."},"AddonSettingsItemModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Addon name","deprecated":false,"example":"my-addon"},"version":{"type":"string","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","title":"Addon version","deprecated":false,"example":"1.0.0"},"title":{"type":"string","title":"Addon title","deprecated":false,"example":"My Addon"},"hasSettings":{"type":"boolean","title":"Has settings","description":"Indicates if the addon has editable settings","default":false,"deprecated":false},"hasProjectSettings":{"type":"boolean","title":"Has project settings","description":"Indicates if the addon has editable project settings","default":false,"deprecated":false},"hasProjectSiteSettings":{"type":"boolean","title":"Has project site settings","description":"Indicates if the addon has editable project site settings","default":false,"deprecated":false},"hasSiteSettings":{"type":"boolean","title":"Has site settings","description":"Indicates if the addon has editable site settings","default":false,"deprecated":false},"hasStudioOverrides":{"type":"boolean","title":"Has studio overrides","deprecated":false},"hasProjectOverrides":{"type":"boolean","title":"Has project overrides","deprecated":false},"hasProjectSiteOverrides":{"type":"boolean","title":"Has project site overrides","deprecated":false},"settings":{"type":"object","title":"Addon settings","description":"Final settings for the addon depending of the studio/project/site branch","deprecated":false},"siteSettings":{"type":"object","title":"Site settings","description":"Site settings for the addon depending of the site branch","deprecated":false},"isBroken":{"type":"boolean","title":"Is broken","description":"Indicates if the addon is not properly initialized","default":false,"deprecated":false},"reason":{"additionalProperties":{"type":"string"},"type":"object","title":"Reason","description":"Reason for addon being broken","deprecated":false},"isProjectBundle":{"type":"boolean","title":"Is project bundle","description":"Indicates if the addon is part of the project bundle","default":false,"deprecated":false}},"type":"object","required":["name","version","title"],"title":"AddonSettingsItemModel","description":"Base API model."},"AddonSettingsResponse":{"properties":{"settings":{"additionalProperties":{"type":"object"},"type":"object","title":"Addon settings","description":"Addon settings for each active addon","deprecated":false,"example":{"my-addon":{"my-setting":"my-value","my-other-setting":"my-other-value"}}},"versions":{"additionalProperties":{"type":"string"},"type":"object","title":"Addon versions","description":"Active versions of the addon for the given variant","deprecated":false,"example":{"my-addon":"1.0.0"}}},"type":"object","required":["settings","versions"],"title":"AddonSettingsResponse","description":"Base API model."},"AddonVersionDetail":{"properties":{"name":{"type":"string","title":"Addon name","deprecated":false,"example":"maya"},"title":{"type":"string","title":"Addon title","deprecated":false,"example":"Maya"},"description":{"type":"string","title":"Description","description":"Addon description","deprecated":false,"example":"Maya is a 3D computer graphics application"},"orgName":{"type":"string","title":"Organization name","deprecated":false,"example":"ynput-official"},"orgTitle":{"type":"string","title":"Organization title","deprecated":false,"example":"Ynput"},"icon":{"type":"string","title":"Icon URL","deprecated":false,"example":"https://example.com/maya.png"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","deprecated":false},"flags":{"items":{"type":"string"},"type":"array","title":"Flags","deprecated":false},"latestVersion":{"type":"string","title":"Latestversion","description":"Latest version of the addon","deprecated":false,"example":"1.0.0"},"links":{"items":{"$ref":"#/components/schemas/LinkModel"},"type":"array","title":"Links","description":"Links to the addon's homepage and GitHub repository","deprecated":false,"example":[{"type":"github","url":"https://github.com/ynput/ayon-maya"}]},"available":{"type":"boolean","title":"Available","description":"Addon is avaliable for download","default":true,"deprecated":false},"currentProductionVersion":{"type":"string","title":"Current production version","deprecated":false,"example":"1.0.0"},"currentLatestVersion":{"type":"string","title":"Latest installed version","deprecated":false,"example":"1.0.0"},"isOutdated":{"type":"boolean","title":"Is the current version outdated","default":false,"deprecated":false,"example":false},"version":{"type":"string","title":"Version","deprecated":false,"example":"1.0.0"},"url":{"type":"string","title":"Url","deprecated":false,"example":"https://example.com/maya-1.0.0.zip"},"altUrl":{"type":"string","title":"Alturl","deprecated":false,"example":"https://example2.com/maya-1.0.0.zip"},"checksum":{"type":"string","title":"Checksum","deprecated":false,"example":"a1b2c3d4e5f6g7h8i9j0"},"ayonVersion":{"type":"string","title":"Ayonversion","description":"The version of Ayon this version is compatible with","deprecated":false,"example":"1.2.0"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"When this version was created","deprecated":false,"example":"2024-01-01T00:00:00Z"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"When this version was last updated","deprecated":false,"example":"2024-01-01T00:00:00Z"},"isInstalled":{"type":"boolean","title":"Isinstalled","description":"Is this version installed?","default":false,"deprecated":false},"isProduction":{"type":"boolean","title":"Isproduction","description":"Is this version in production?","default":false,"deprecated":false},"isCompatible":{"type":"boolean","title":"Iscompatible","description":"Is this version compatible?","default":false,"deprecated":false}},"type":"object","required":["name","title","version"],"title":"AddonVersionDetail","description":"Base API model."},"AddonVersionListItem":{"properties":{"version":{"type":"string","title":"Addon version","deprecated":false,"example":"1.0.0"},"ayonVersion":{"type":"string","title":"Ayon version","description":"Required Ayon server version to run the addon","deprecated":false,"example":"1.2.0"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","deprecated":false,"example":"2024-01-01T00:00:00Z"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","deprecated":false,"example":"2024-01-01T00:00:00Z"},"isCompatible":{"type":"boolean","title":"Iscompatible","description":"Is this version compatible?","deprecated":false},"isInstalled":{"type":"boolean","title":"Isinstalled","description":"Is this version installed?","deprecated":false},"isProduction":{"type":"boolean","title":"Isproduction","description":"Is this version in production?","deprecated":false}},"type":"object","required":["version"],"title":"AddonVersionListItem","description":"Base API model."},"AgentInfo":{"properties":{"platform":{"type":"string","title":"Platform"},"client":{"type":"string","title":"Client"},"device":{"type":"string","title":"Device"}},"type":"object","title":"AgentInfo"},"AllSettingsResponseModel":{"properties":{"projectName":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Project name","description":"If specified, indicates that the settings are for a project","deprecated":false},"bundleName":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Bundle name","deprecated":false},"addons":{"items":{"$ref":"#/components/schemas/AddonSettingsItemModel"},"type":"array","title":"Addons","deprecated":false},"inheritedAddons":{"items":{"type":"string"},"type":"array","title":"Inherited addons","description":"If a project bundle is used, this field contains alist of addons that are inherited from the studio bundle","deprecated":false}},"type":"object","required":["bundleName"],"title":"AllSettingsResponseModel","description":"Base API model."},"Anatomy":{"properties":{"entity_naming":{"allOf":[{"$ref":"#/components/schemas/EntityNaming"}],"title":"Entity Naming","description":"Settings for automatic entity name generation","disabled":false},"roots":{"items":{"$ref":"#/components/schemas/Root"},"type":"array","title":"Roots","description":"Setup root paths for the project","default":[{"name":"work","windows":"C:/projects","linux":"/mnt/share/projects","darwin":"/Volumes/projects"}],"disabled":false},"templates":{"allOf":[{"$ref":"#/components/schemas/Templates"}],"title":"Templates","description":"Path templates configuration","disabled":false},"attributes":{"allOf":[{"$ref":"#/components/schemas/ayon_server__settings__anatomy__ProjectAttribModel"}],"title":"Attributes","description":"Attributes configuration","disabled":false},"folder_types":{"items":{"$ref":"#/components/schemas/FolderType"},"type":"array","title":"Folder types","description":"Folder types configuration","example":[{"name":"Folder","shortName":"","color":"#cccccc","icon":"folder"}],"disabled":false},"task_types":{"items":{"$ref":"#/components/schemas/TaskType"},"type":"array","title":"Task types","description":"Task types configuration","example":[{"name":"Generic","shortName":"gener","color":"#5c6c79","icon":"task_alt"}],"disabled":false},"link_types":{"items":{"$ref":"#/components/schemas/LinkType"},"type":"array","title":"Link types","description":"Link types configuration","example":[{"link_type":"generative","input_type":"version","output_type":"version","color":"#3f67de","style":"solid"}],"disabled":false},"statuses":{"items":{"$ref":"#/components/schemas/Status"},"type":"array","title":"Statuses","description":"Statuses configuration","example":[{"name":"Not ready","shortName":"NRD","state":"not_started","icon":"fiber_new","color":"#3d444f","scope":["folder","product","task"]}],"disabled":false},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags","description":"Tags configuration","example":[{"name":"important","color":"#ff2450"}],"disabled":false},"product_base_types":{"allOf":[{"$ref":"#/components/schemas/ProductBaseTypes"}],"title":"Product Types","disabled":false}},"type":"object","title":"Anatomy"},"AnatomyPresetListItem":{"properties":{"name":{"type":"string","title":"Name of the preset","deprecated":false},"primary":{"type":"boolean","title":"Is this preset primary","deprecated":false},"version":{"type":"string","title":"Version of the anatomy model","deprecated":false}},"type":"object","required":["name","primary","version"],"title":"AnatomyPresetListItem","description":"Base API model."},"AnatomyPresetListModel":{"properties":{"version":{"type":"string","title":"Model version","description":"Anatomy model version currently used in Ayon","deprecated":false},"presets":{"items":{"$ref":"#/components/schemas/AnatomyPresetListItem"},"type":"array","title":"List of anatomy presets","deprecated":false}},"type":"object","required":["version"],"title":"AnatomyPresetListModel","description":"Base API model."},"ApiKeyModel":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"preview":{"type":"string","title":"Preview"},"created":{"type":"number","title":"Created"},"expires":{"type":"number","title":"Expires"}},"type":"object","required":["id","label","preview","created"],"title":"ApiKeyModel","description":"Base API model."},"ApiKeyPatchModel":{"properties":{"label":{"type":"string","title":"Label"},"expires":{"type":"number","title":"Expires"}},"type":"object","title":"ApiKeyPatchModel","description":"Base API model."},"ApiKeyPostModel":{"properties":{"label":{"type":"string","title":"Label"},"key":{"type":"string","title":"Key"},"expires":{"type":"number","title":"Expires"}},"type":"object","required":["label","key"],"title":"ApiKeyPostModel","description":"Base API model."},"AssignAccessGroupsRequestModel":{"properties":{"accessGroups":{"items":{"$ref":"#/components/schemas/AccessGroupsOnProject"},"type":"array","title":"Accessgroups","description":"List of access groups to assign","deprecated":false,"example":[{"project":"project1","accessGroups":["artist","viewer"]},{"project":"project2","accessGroups":["viewer"]}]}},"type":"object","title":"AssignAccessGroupsRequestModel","description":"Base API model."},"AssignProjectRequest":{"properties":{"folderId":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"projectNames":{"items":{"type":"string"},"type":"array","minItems":1,"title":"List of project names to assign to the folder","deprecated":false}},"type":"object","required":["projectNames"],"title":"AssignProjectRequest","description":"Base API model."},"AssignUsersRequestModel":{"properties":{"mode":{"type":"string","enum":["add","remove","set"],"title":"Mode","description":"What to do with the list of users","deprecated":false,"example":"add"},"users":{"items":{"type":"string"},"type":"array","title":"Users","description":"List of user names","deprecated":false,"example":["Eeny","Meeny","Miny","Moe"]}},"type":"object","required":["mode","users"],"title":"AssignUsersRequestModel","description":"Assign users to a task."},"AttributeData":{"properties":{"type":{"type":"string","enum":["string","integer","float","boolean","datetime","list_of_strings","list_of_integers","list_of_any","list_of_submodels","dict"],"title":"Type","description":"Type of attribute value","default":"string","deprecated":false,"example":"string"},"title":{"type":"string","title":"Title","description":"Nice, human readable title of the attribute","deprecated":false,"example":"My attribute"},"description":{"type":"string","title":"Field description","deprecated":false,"example":"Value of my attribute"},"example":{"title":"Field example","description":"Example value of the field.","deprecated":false,"example":"value1"},"default":{"title":"Field default value","description":"Default value for the attribute. Do not set for list types.","deprecated":false},"gt":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Greater than","deprecated":false},"ge":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Greater or equal","deprecated":false},"lt":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Less","deprecated":false},"le":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Less or equal","deprecated":false},"minLength":{"type":"integer","title":"Minimum length","deprecated":false},"maxLength":{"type":"integer","title":"Maximum length","deprecated":false},"minItems":{"type":"integer","title":"Minimum items","description":"Minimum number of items in list type.","deprecated":false},"maxItems":{"type":"integer","title":"Maximum items","description":"Only for list types. Maximum number of items in the list.","deprecated":false},"regex":{"type":"string","title":"Field regex","description":"Only for string types. The value must match this regex.","deprecated":false,"example":"^[a-zA-Z0-9_]+$"},"enum":{"items":{"$ref":"#/components/schemas/EnumItem"},"type":"array","title":"Field enum","description":"List of enum items used for displaying select widgets","deprecated":false,"example":[{"value":"value1","label":"Value 1"},{"value":"value2","label":"Value 2"},{"value":"value3","label":"Value 3"}]},"enumResolver":{"type":"string","title":"Enum resolver","description":"Name of the function that provides enum values dynamically.","deprecated":false,"example":"folder_types"},"enumResolverSettings":{"type":"object","title":"Enum resolver settings","description":"Settings passed to the enum resolver function.","deprecated":false,"example":{"someSetting":"someValue"}},"inherit":{"type":"boolean","title":"Inherit","description":"Inherit the attribute value from the parent entity.","default":true,"deprecated":false}},"type":"object","title":"AttributeData","description":"Base API model."},"AttributeModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9]{2,64}$","title":"Attribute name","deprecated":false,"example":"my_attribute"},"position":{"type":"integer","title":"Positon","description":"Default order","deprecated":false,"example":12},"scope":{"items":{"anyOf":[{"type":"string","enum":["folder","product","version","representation","task","workfile"]},{"type":"string","enum":["project","user"]},{"type":"string","enum":["list"]}]},"type":"array","title":"Scope","description":"List of entity types the attribute is available on","deprecated":false,"example":["folder","task"]},"data":{"$ref":"#/components/schemas/AttributeData"},"builtin":{"type":"boolean","title":"Builtin","description":"Is attribute builtin. Built-in attributes cannot be removed.","default":false,"deprecated":false}},"type":"object","required":["name","position","data"],"title":"AttributeModel","description":"Base API model."},"AttributePatchModel":{"properties":{"position":{"type":"integer","title":"Position","description":"Default order","deprecated":false,"example":12},"scope":{"items":{"anyOf":[{"type":"string","enum":["folder","product","version","representation","task","workfile"]},{"type":"string","enum":["project","user"]},{"type":"string","enum":["list"]}]},"type":"array","title":"Scope","description":"List of entity types the attribute is available on","deprecated":false,"example":["folder","task"]},"data":{"$ref":"#/components/schemas/AttributeData"}},"type":"object","title":"AttributePatchModel","description":"Base API model."},"AttributePutModel":{"properties":{"position":{"type":"integer","title":"Positon","description":"Default order","deprecated":false,"example":12},"scope":{"items":{"anyOf":[{"type":"string","enum":["folder","product","version","representation","task","workfile"]},{"type":"string","enum":["project","user"]},{"type":"string","enum":["list"]}]},"type":"array","title":"Scope","description":"List of entity types the attribute is available on","deprecated":false,"example":["folder","task"]},"data":{"$ref":"#/components/schemas/AttributeData"}},"type":"object","required":["position","data"],"title":"AttributePutModel","description":"Base API model."},"AttributeReadAccessList":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"disabled":false},"attributes":{"items":{"type":"string"},"type":"array","title":"Readable attributes","disabled":false,"enum_resolver":{"__wrapped__":{},"cache":{"timeout":5.0,"build_key":{},"_serializer":{"encoding":"utf-8"},"_plugins":[],"_cache":{},"_handlers":{}}}}},"type":"object","title":"AttributeReadAccessList"},"AttributeWriteAccessList":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"disabled":false},"attributes":{"items":{"type":"string"},"type":"array","title":"Writable attributes","disabled":false,"enum_resolver":{"__wrapped__":{},"cache":{"timeout":5.0,"build_key":{},"_serializer":{"encoding":"utf-8"},"_plugins":[],"_cache":{},"_handlers":{}}}},"fields":{"items":{"type":"string"},"type":"array","title":" ","disabled":false,"widget":"switchbox","enum_resolver":{}}},"type":"object","title":"AttributeWriteAccessList"},"AuthenticationModel":{"properties":{"hide_password_auth":{"type":"boolean","title":"Hide Password Authentication","description":"If enabled, password authentication will be hidden from the login page.","default":false,"disabled":false}},"type":"object","title":"AuthenticationModel"},"AvailableActionsListModel":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/BaseActionManifest"},"type":"array","title":"Available actions","description":"The list of available actions","deprecated":false}},"type":"object","title":"AvailableActionsListModel","description":"Base API model."},"BackgroundOperationsResponseModel":{"properties":{"id":{"type":"string","title":"Id"},"status":{"type":"string","enum":["pending","in_progress","completed"],"title":"Status","default":"pending"},"result":{"$ref":"#/components/schemas/OperationsResponseModel"}},"type":"object","required":["id"],"title":"BackgroundOperationsResponseModel","description":"Base API model."},"BaseActionManifest":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"The identifier of the action","deprecated":false,"example":"application.launch.adsk_3dsmax/2024"},"label":{"type":"string","title":"Label","description":"Human-friendly name of the action","deprecated":false,"example":"3ds Max 2024"},"description":{"type":"string","title":"Description","description":"A short description of the action","deprecated":false,"example":"Launches Autodesk 3ds Max 2024"},"groupLabel":{"type":"string","title":"Group Label","description":"The label of the group the action belongs to","deprecated":false,"example":"3ds Max"},"category":{"type":"string","title":"Category","description":"Action category","default":"General","deprecated":false,"example":"Applications"},"order":{"type":"integer","title":"Order","description":"The order of the action","default":100,"deprecated":false,"example":100},"icon":{"allOf":[{"$ref":"#/components/schemas/IconModel"}],"title":"Icon","description":"An icon for the action","deprecated":false,"example":{"type":"material-symbols","name":"launch"}},"adminOnly":{"type":"boolean","title":"Admin Only","description":"If true, the action is only available to admin users","default":false,"deprecated":false,"example":true},"managerOnly":{"type":"boolean","title":"Manager Only","description":"If true, the action is only available to manager users","default":false,"deprecated":false,"example":false},"configFields":{"items":{"$ref":"#/components/schemas/SimpleFormField"},"type":"array","title":"Config Fields","description":"List of fields to be displayed in the action settings","deprecated":false,"example":[{"type":"text","name":"host","label":"Host"},{"type":"text","name":"port","label":"Port"}]},"featured":{"type":"boolean","title":"Featured action","description":"Sort icon to the top","default":false,"deprecated":false},"addonName":{"type":"string","title":"Addon Name","description":"The name of the addon providing the action","deprecated":false,"example":"applications"},"addonVersion":{"type":"string","title":"Addon Version","description":"The version of the addon providing the action","deprecated":false,"example":"1.2.3"},"variant":{"type":"string","title":"Variant","description":"The settings variant of the addon","deprecated":false,"example":"production"}},"type":"object","required":["identifier","label"],"title":"BaseActionManifest","description":"Base API model."},"BundleActionModel":{"properties":{"action":{"type":"string","enum":["promote"],"title":"Action","deprecated":false,"example":"promote"}},"type":"object","required":["action"],"title":"BundleActionModel","description":"Base API model."},"BundleIssueModel":{"properties":{"severity":{"type":"string","enum":["error","warning"],"title":"Severity","deprecated":false,"example":"error"},"addon":{"type":"string","title":"Addon","deprecated":false,"example":"ftrack"},"message":{"type":"string","title":"Message","deprecated":false,"example":"FTrack addon requires Core >= 1.0.0"},"requiredAddon":{"type":"string","title":"Requiredaddon","deprecated":false,"example":"core"}},"type":"object","required":["severity","message"],"title":"BundleIssueModel","description":"Base API model."},"BundleModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Name","description":"Name of the bundle","deprecated":false,"example":"my_superior_bundle"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","deprecated":false,"example":"2026-04-07T00:04:20.547824"},"addons":{"additionalProperties":{"type":"string"},"type":"object","title":"Addons","deprecated":false,"example":{"ftrack":"1.2.3"}},"installerVersion":{"type":"string","title":"Installerversion","deprecated":false,"example":"1.2.3"},"dependencyPackages":{"additionalProperties":{"type":"string"},"type":"object","title":"Dependency packages","description":"mapping of platform:dependency_package_filename","deprecated":false,"example":{"windows":"a_windows_package123.zip","linux":"a_linux_package123.zip","darwin":"a_mac_package123.zip"}},"addonDevelopment":{"additionalProperties":{"$ref":"#/components/schemas/AddonDevelopmentItem"},"type":"object","title":"Addondevelopment","deprecated":false,"example":{"ftrack":{"enabled":true,"path":"~/devel/ftrack"}}},"isProduction":{"type":"boolean","title":"Isproduction","default":false,"deprecated":false,"example":false},"isStaging":{"type":"boolean","title":"Isstaging","default":false,"deprecated":false,"example":false},"isArchived":{"type":"boolean","title":"Isarchived","default":false,"deprecated":false,"example":false},"isDev":{"type":"boolean","title":"Isdev","default":false,"deprecated":false,"example":false},"isProject":{"type":"boolean","title":"Isproject","default":false,"deprecated":false,"example":false},"activeUser":{"type":"string","title":"Activeuser","deprecated":false,"example":"admin"}},"type":"object","required":["name"],"title":"BundleModel","description":"Model for GET and POST requests"},"BundlePatchModel":{"properties":{"addons":{"additionalProperties":{"type":"string"},"type":"object","title":"Addons","deprecated":false,"example":{"kitsu":"1.2.3"}},"installerVersion":{"type":"string","title":"Installerversion","deprecated":false,"example":"1.2.3"},"dependencyPackages":{"additionalProperties":{"type":"string"},"type":"object","title":"Dependency packages","description":"mapping of platform:dependency_package_filename","deprecated":false,"example":{"windows":"a_windows_package123.zip","linux":"a_linux_package123.zip","darwin":"a_mac_package123.zip"}},"isProduction":{"type":"boolean","title":"Isproduction","deprecated":false,"example":false},"isStaging":{"type":"boolean","title":"Isstaging","deprecated":false,"example":false},"isArchived":{"type":"boolean","title":"Isarchived","deprecated":false,"example":false},"isDev":{"type":"boolean","title":"Isdev","deprecated":false,"example":false},"activeUser":{"type":"string","title":"Activeuser","deprecated":false,"example":"admin"},"addonDevelopment":{"additionalProperties":{"$ref":"#/components/schemas/AddonDevelopmentItem"},"type":"object","title":"Addondevelopment","deprecated":false}},"type":"object","title":"BundlePatchModel","description":"Base API model."},"ChangePasswordRequestModel":{"properties":{"password":{"type":"string","title":"Password","description":"New password","deprecated":false,"example":"5up3r5ecr3t_p455W0rd.123"},"apiKey":{"type":"string","pattern":"^[0-9a-f]{32}$","title":"API Key","description":"API Key to set to a service user","deprecated":false,"example":"1cb4f6a89012a4b6d8a01ee4f67ae0fb"}},"type":"object","title":"ChangePasswordRequestModel","description":"Base API model."},"ChangeUserNameRequestModel":{"properties":{"newName":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"Newname","description":"New user name","deprecated":false,"example":"EvenBetterUser"}},"type":"object","required":["newName"],"title":"ChangeUserNameRequestModel","description":"Base API model."},"ChangelogSettingsModel":{"properties":{"show_changelog_to_users":{"type":"boolean","title":"Show Changelog to Users","description":"If enabled, the changelog will be shown to normal users.","default":true,"disabled":false}},"type":"object","title":"ChangelogSettingsModel"},"CheckBundleResponseModel":{"properties":{"success":{"type":"boolean","title":"Success","default":false},"issues":{"items":{"$ref":"#/components/schemas/BundleIssueModel"},"type":"array","title":"Issues","deprecated":false}},"type":"object","title":"CheckBundleResponseModel","description":"Base API model."},"CheckPasswordRequestModel":{"properties":{"password":{"type":"string","title":"Password","deprecated":false,"example":"5up3r5ecr3t_p455W0rd.123"}},"type":"object","required":["password"],"title":"CheckPasswordRequestModel","description":"Base API model."},"ClientInfo":{"properties":{"ip":{"type":"string","title":"Ip"},"languages":{"items":{"type":"string"},"type":"array","title":"Languages"},"location":{"$ref":"#/components/schemas/LocationInfo"},"agent":{"$ref":"#/components/schemas/AgentInfo"},"site_id":{"type":"string","title":"Site Id"}},"type":"object","required":["ip"],"title":"ClientInfo"},"ColumnItemModel":{"properties":{"name":{"type":"string","title":"Column name"},"visible":{"type":"boolean","title":"Is column visible","default":true},"pinned":{"type":"boolean","title":"Is column pinned","default":false},"width":{"type":"integer","title":"Column width"}},"type":"object","required":["name"],"title":"ColumnItemModel","description":"Base API model."},"ContextFilterModel":{"properties":{"key":{"type":"string","title":"Context key","deprecated":false,"example":"task.name"},"values":{"items":{"type":"string"},"type":"array","title":"Possible values","description":"List of regular expressions which at least one must match","deprecated":false,"example":["^work.*$"]}},"type":"object","required":["key","values"],"title":"ContextFilterModel","description":"Base API model."},"CreateActivityResponseModel":{"properties":{"id":{"type":"string","title":"Id","deprecated":false,"example":"123"}},"type":"object","required":["id"],"title":"CreateActivityResponseModel","description":"Base API model."},"CreateFileResponseModel":{"properties":{"id":{"type":"string","title":"Id","deprecated":false,"example":"123"}},"type":"object","required":["id"],"title":"CreateFileResponseModel","description":"Base API model."},"CreateLinkRequestModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Link ID","description":"ID of the link to create. If not provided, will be generated.","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"input":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Input ID","description":"The ID of the input entity.","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"output":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Output ID","description":"The ID of the output entity.","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"name":{"type":"string","title":"Link Name","description":"The name of the link.","deprecated":false},"linkType":{"type":"string","title":"Link Type","description":"Link type to create.","deprecated":false,"example":"reference|folder|version"},"data":{"type":"object","title":"Link Data","description":"Additional data for the link.","deprecated":false},"link":{"type":"string","title":"Link","description":"Link type to create. This is deprecated. Use linkType instead.","deprecated":false,"example":"reference|folder|version"}},"type":"object","required":["input","output"],"title":"CreateLinkRequestModel","description":"Request model for creating a link."},"CreateLinkTypeRequestModel":{"properties":{"data":{"type":"object","title":"Data","description":"Additional link type data (appearance, description, etc.).","deprecated":false}},"type":"object","title":"CreateLinkTypeRequestModel","description":"Base API model."},"CreateReactionModel":{"properties":{"reaction":{"type":"string","title":"Reaction","description":"The reaction to be created","deprecated":false,"example":"like"}},"type":"object","required":["reaction"],"title":"CreateReactionModel","description":"Base API model."},"CreateSessionRequest":{"properties":{"userName":{"type":"string","title":"Username","description":"User name to create session for","deprecated":false},"message":{"type":"string","title":"Message","description":"Message to log in event stream","deprecated":false}},"type":"object","title":"CreateSessionRequest","description":"Base API model."},"CreateThumbnailResponseModel":{"properties":{"id":{"type":"string","title":"Thumbnail ID","deprecated":false,"example":"a1f2b3c4d5e6f7g8h9i0"}},"type":"object","required":["id"],"title":"CreateThumbnailResponseModel","description":"Base API model."},"CustomTemplate":{"properties":{"name":{"type":"string","title":"Name","disabled":false},"value":{"type":"string","title":"Template value","default":"","disabled":false}},"type":"object","required":["name"],"title":"CustomTemplate"},"CustomizationModel":{"properties":{"login_background":{"type":"string","title":"Login Background","disabled":true},"studio_logo":{"type":"string","title":"Studio Logo","disabled":true},"motd":{"type":"string","title":"Login Page Message","description":"The message that is displayed to users on the login page. Markdown syntax is supported.","default":"","example":"Welcome to Ayon!","disabled":false,"widget":"textarea"},"frontend_flags":{"items":{"type":"string"},"type":"array","title":"Frontend Flags","description":"A list of flags that will be passed to the frontend. These can be used to enable or disable frontend features.","disabled":false,"widget":"switchbox","enum_resolver":{}}},"type":"object","title":"CustomizationModel"},"DefaultProductBaseType":{"properties":{"color":{"type":"string","title":"Default color","default":"#cccccc","disabled":false,"widget":"color"},"icon":{"type":"string","title":"Default icon","default":"deployed_code","disabled":false,"widget":"icon"}},"type":"object","title":"DefaultProductBaseType"},"DefaultProductType":{"properties":{"color":{"type":"string","title":"Color","deprecated":false},"icon":{"type":"string","title":"Icon","deprecated":false}},"type":"object","required":["color","icon"],"title":"DefaultProductType","description":"Base API model."},"DeliveryTemplate":{"properties":{"name":{"type":"string","title":"Name","disabled":false},"directory":{"type":"string","title":"Directory template","disabled":false},"file":{"type":"string","title":"File name template","disabled":false}},"type":"object","required":["name","directory","file"],"title":"DeliveryTemplate"},"DependencyPackage":{"properties":{"filename":{"type":"string","pattern":"^[\\w\\-+._]+$","title":"Filename","description":"Name of the package file","deprecated":false,"example":"ayon_installer_1.2.3_windows.exe"},"platform":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform"},"size":{"type":"integer","title":"Size"},"checksum":{"type":"string","title":"Checksum"},"checksumAlgorithm":{"type":"string","enum":["md5","sha1","sha256"],"title":"Checksumalgorithm"},"sources":{"items":{"$ref":"#/components/schemas/SourceModel"},"type":"array","title":"Sources","description":"List of sources to download the file from. Server source is added automatically by the server if the file is uploaded.","deprecated":false},"installerVersion":{"type":"string","title":"Installer version","description":"Version of the Ayon installer this package is created with","deprecated":false,"example":"1.2.3"},"sourceAddons":{"additionalProperties":{"type":"string"},"type":"object","title":"Source addons","description":"mapping of addon_name:version used to create the package","deprecated":false,"example":{"ftrack":"1.2.3","maya":"2.4"}},"pythonModules":{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}]},"type":"object","title":"Python modules","description":"mapping of module_name:version used to create the package","deprecated":false,"example":{"requests":"2.25.1","pydantic":"1.8.2"}}},"type":"object","required":["filename","platform","installerVersion"],"title":"DependencyPackage","description":"Base API model."},"DependencyPackageList":{"properties":{"packages":{"items":{"$ref":"#/components/schemas/DependencyPackage"},"type":"array","title":"Packages","deprecated":false}},"type":"object","title":"DependencyPackageList","description":"Base API model."},"DependencyPackageManifest":{"properties":{"filename":{"type":"string","pattern":"^[\\w\\-+._]+$","title":"Filename","description":"Name of the package file","deprecated":false,"example":"ayon_installer_1.2.3_windows.exe"},"platform":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform"},"size":{"type":"integer","title":"Size"},"checksum":{"type":"string","title":"Checksum"},"checksumAlgorithm":{"type":"string","enum":["md5","sha1","sha256"],"title":"Checksumalgorithm"},"sources":{"items":{"$ref":"#/components/schemas/SourceModel"},"type":"array","title":"Sources","description":"List of sources to download the file from. Server source is added automatically by the server if the file is uploaded.","deprecated":false},"installerVersion":{"type":"string","title":"Installer version","description":"Version of the Ayon installer this package is created with","deprecated":false,"example":"1.2.3"},"sourceAddons":{"additionalProperties":{"type":"string"},"type":"object","title":"Source addons","description":"mapping of addon_name:version used to create the package","deprecated":false,"example":{"ftrack":"1.2.3","maya":"2.4"}},"pythonModules":{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}]},"type":"object","title":"Python modules","description":"mapping of module_name:version used to create the package","deprecated":false,"example":{"requests":"2.25.1","pydantic":"1.8.2"}}},"type":"object","required":["filename","platform","installerVersion"],"title":"DependencyPackageManifest","description":"Base API model."},"DeployProjectRequestModel":{"properties":{"name":{"type":"string","title":"Name","description":"Project name","deprecated":false},"code":{"type":"string","title":"Code","description":"Project code","deprecated":false},"anatomy":{"allOf":[{"$ref":"#/components/schemas/Anatomy"}],"title":"Anatomy","description":"Project anatomy","deprecated":false},"library":{"type":"boolean","title":"Library","description":"Library project","default":false,"deprecated":false},"assignUsers":{"type":"boolean","title":"Assignusers","description":"Assign default users to the project","default":true,"deprecated":false}},"type":"object","required":["name","code","anatomy"],"title":"DeployProjectRequestModel","description":"Base API model."},"DispatchEventRequestModel":{"properties":{"topic":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_\\.\\*]{2,64}$","title":"Topic","description":"Topic of the event","deprecated":false,"example":"media.import"},"sender":{"type":"string","title":"Sender","description":"Identifier of the process that sent the event.","deprecated":false,"example":"service-processor-01"},"hash":{"type":"string","title":"Hash","description":"Deterministic hash of the event topic and summary/payload","deprecated":false},"project":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Project name","description":"Name of the project if the event belong to one.","deprecated":false,"example":"MyProject"},"dependsOn":{"type":"string","maxLength":32,"minLength":32,"title":"Depends on","description":"ID of the event this event depends on.","deprecated":false,"example":"69dd9b85a522fcedc14203ea95f54f52"},"description":{"type":"string","title":"Description","description":"Short, human-readable description of the event and its state","deprecated":false,"example":"Importing file 3 of 10"},"summary":{"type":"object","title":"Summary","description":"Arbitrary topic-specific data sent to clients in real time","deprecated":false},"payload":{"type":"object","title":"Payload","description":"Full event payload. Only avaiable in REST endpoint.","deprecated":false},"finished":{"type":"boolean","title":"Finished","description":"Is event finished (one shot event)","default":true,"deprecated":false,"example":true},"store":{"type":"boolean","title":"Store","description":"Set to False for fire-and-forget events","default":true,"deprecated":false,"example":true},"reuse":{"type":"boolean","title":"Reuse","description":"Allow reusing events with the same hash","default":false,"deprecated":false,"example":false}},"type":"object","required":["topic"],"title":"DispatchEventRequestModel","description":"Base API model."},"DispatchEventResponseModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"title":"Event ID","description":"ID of the created event.","deprecated":false,"example":"c14203ea95f54f569dd9b85a522fced2"}},"type":"object","required":["id"],"title":"DispatchEventResponseModel","description":"Base API model."},"EndpointsAccessList":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"disabled":false},"endpoints":{"items":{"type":"string"},"type":"array","title":"Endpoints","disabled":false}},"type":"object","title":"EndpointsAccessList"},"EnrollRequestModel":{"properties":{"sourceTopic":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Source topic(s)","deprecated":false,"example":"ftrack.update"},"targetTopic":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_\\.\\*]{2,64}$","title":"Target topic","deprecated":false,"example":"ftrack.sync_to_ayon"},"sender":{"type":"string","title":"Sender","deprecated":false,"example":"workerservice01"},"senderType":{"type":"string","title":"Sender type","deprecated":false,"example":"worker"},"description":{"type":"string","title":"Description","description":"Short, human readable description of the target event","deprecated":false,"example":"Sync Ftrack project to Ayon"},"sequential":{"type":"boolean","title":"Sequential","description":"Ensure events are processed in sequential order","default":false,"deprecated":false,"example":true},"filter":{"allOf":[{"$ref":"#/components/schemas/QueryFilter"}],"title":"Filter","description":"Filter source events","deprecated":false},"maxRetries":{"type":"integer","title":"Max retries","default":3,"deprecated":false,"example":3},"ignoreSenderTypes":{"items":{"type":"string"},"type":"array","title":"Ignore sender types","description":"Ignore source events created by specified sender types","deprecated":false,"example":["worker"]},"ignoreOlderThan":{"type":"integer","title":"Ignore older than","description":"Ignore events older than this many days. Use 0 for no limit","default":3,"deprecated":false,"example":3},"slothMode":{"type":"boolean","title":"Sloth mode","description":"Causes enroll endpoint to be really really slow. This flag is for development and testing purposes only. Never use it in production.","default":false,"deprecated":false,"example":false}},"type":"object","required":["sourceTopic","targetTopic"],"title":"EnrollRequestModel","description":"Base API model."},"EnrollResponseModel":{"properties":{"id":{"type":"string","title":"Id","deprecated":false},"dependsOn":{"type":"string","title":"Dependson","deprecated":false},"hash":{"type":"string","title":"Hash","deprecated":false},"status":{"type":"string","title":"Status","default":"pending","deprecated":false}},"type":"object","required":["id","dependsOn","hash"],"title":"EnrollResponseModel","description":"Base API model."},"EntityCounts":{"properties":{"folders":{"type":"integer","title":"Folders","description":"Number of folders","deprecated":false,"example":10},"products":{"type":"integer","title":"Products","description":"Number of products","deprecated":false,"example":98},"versions":{"type":"integer","title":"Versions","description":"Number of versions","deprecated":false,"example":512},"representations":{"type":"integer","title":"Representations","description":"Number of representations","deprecated":false,"example":4853},"tasks":{"type":"integer","title":"Tasks","description":"Number of tasks","deprecated":false,"example":240},"workfiles":{"type":"integer","title":"Workfiles","description":"Number of workfiles","deprecated":false,"example":190}},"type":"object","required":["folders","products","versions","representations","tasks","workfiles"],"title":"EntityCounts","description":"Base API model."},"EntityIdResponse":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Entity ID","description":"Entity ID","example":"af10c8f0e9b111e9b8f90242ac130003"}},"type":"object","required":["id"],"title":"EntityIdResponse","description":"Base API model."},"EntityLinksAccessList":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"disabled":false},"link_types":{"items":{"type":"string"},"type":"array","title":"Link Types","disabled":false,"enum_resolver":{}}},"type":"object","title":"EntityLinksAccessList"},"EntityListAttributeDefinition":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9]{2,64}$","title":"Attribute name","deprecated":false,"example":"my_attribute"},"data":{"$ref":"#/components/schemas/AttributeData"}},"type":"object","required":["name","data"],"title":"EntityListAttributeDefinition","description":"Base API model."},"EntityListEnities":{"properties":{"entityType":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Entity type","deprecated":false},"entityIds":{"items":{"type":"string"},"type":"array","title":"Entity IDs","deprecated":false}},"type":"object","required":["entityType","entityIds"],"title":"EntityListEnities","description":"Base API model."},"EntityListFolderData":{"properties":{"color":{"type":"string","title":"Color","description":"Hex color code","deprecated":false},"icon":{"type":"string","title":"Icon","description":"Icon name","deprecated":false},"scope":{"items":{"type":"string"},"type":"array","title":"Scope","description":"Folder scope","deprecated":false}},"type":"object","title":"EntityListFolderData","description":"Base API model."},"EntityListFolderModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"label":{"type":"string","maxLength":255,"minLength":1,"title":"Folder label","deprecated":false},"parentId":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Parent folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"position":{"type":"integer","minimum":0.0,"title":"Folder position","default":0,"deprecated":false},"owner":{"type":"string","maxLength":255,"minLength":1,"title":"Owner user name","deprecated":false},"access":{"additionalProperties":{"type":"integer"},"type":"object","title":"Access control list","deprecated":false},"data":{"allOf":[{"$ref":"#/components/schemas/EntityListFolderData"}],"title":"Folder additional data","deprecated":false}},"type":"object","required":["id","label"],"title":"EntityListFolderModel","description":"Base API model."},"EntityListFolderOrderModel":{"properties":{"order":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Ordered list of folder IDs","deprecated":false}},"type":"object","required":["order"],"title":"EntityListFolderOrderModel","description":"Base API model."},"EntityListFolderPatchModel":{"properties":{"label":{"type":"string","maxLength":255,"minLength":1,"title":"Folder label","deprecated":false},"parentId":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Parent folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"access":{"additionalProperties":{"type":"integer"},"type":"object","title":"Access control list","deprecated":false},"data":{"allOf":[{"$ref":"#/components/schemas/EntityListFolderData"}],"title":"Folder additional data","deprecated":false}},"type":"object","title":"EntityListFolderPatchModel","description":"Base API model."},"EntityListFolderPostModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"label":{"type":"string","maxLength":255,"minLength":1,"title":"Folder label","deprecated":false},"parentId":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Parent folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"access":{"additionalProperties":{"type":"integer"},"type":"object","title":"Access control list","deprecated":false},"data":{"allOf":[{"$ref":"#/components/schemas/EntityListFolderData"}],"title":"Folder additional data","deprecated":false}},"type":"object","required":["label"],"title":"EntityListFolderPostModel","description":"Base API model."},"EntityListFoldersResponseModel":{"properties":{"folders":{"items":{"$ref":"#/components/schemas/EntityListFolderModel"},"type":"array","title":"Folders","deprecated":false}},"type":"object","title":"EntityListFoldersResponseModel","description":"Base API model."},"EntityListItemModel":{"properties":{"id":{"type":"string","title":"Item ID","deprecated":false,"example":"53c777d8321511f1831f8e70e23123f9"},"entityId":{"type":"string","title":"Entity ID","description":"ID of the entity in the list","deprecated":false,"example":"53c778b4321511f1831f8e70e23123f9"},"position":{"type":"integer","title":"Position","description":"Position of the item in the list","deprecated":false,"example":69},"label":{"type":"string","title":"Item label","description":"Label of the item","deprecated":false,"example":"Version 1"},"attrib":{"type":"object","title":"Item attributes","description":"Overrides of the listed entity attributes","deprecated":false},"data":{"type":"object","title":"Item data","description":"Additional data associated with the item","deprecated":false},"tags":{"items":{"type":"string"},"type":"array","title":"Item tags","description":"Tags associated with the item","deprecated":false},"folderPath":{"type":"string","title":"Folder path","description":"Path to the folder where the item is located","deprecated":false,"example":"/path/to/folder"},"createdBy":{"type":"string","title":"Created by","deprecated":false,"example":"admin"},"updatedBy":{"type":"string","title":"Updated by","deprecated":false,"example":"editor"},"createdAt":{"type":"string","format":"date-time","title":"Created at","deprecated":false},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","deprecated":false}},"type":"object","required":["entityId","position","folderPath"],"title":"EntityListItemModel","description":"Base API model."},"EntityListItemPatchModel":{"properties":{"entityId":{"type":"string","title":"Entity ID","description":"ID of the entity in the list","deprecated":false,"example":"53c778b4321511f1831f8e70e23123f9"},"position":{"type":"integer","title":"Position","description":"Position of the item in the list","deprecated":false,"example":69},"label":{"type":"string","title":"Item label","description":"Label of the item","deprecated":false,"example":"Version 1"},"attrib":{"type":"object","title":"Item attributes","description":"Overrides of the listed entity attributes","deprecated":false},"data":{"type":"object","title":"Item data","description":"Additional data associated with the item","deprecated":false},"tags":{"items":{"type":"string"},"type":"array","title":"Item tags","description":"Tags associated with the item","deprecated":false}},"type":"object","title":"EntityListItemPatchModel","description":"Base API model."},"EntityListItemPostModel":{"properties":{"id":{"type":"string","title":"Item ID","deprecated":false,"example":"53c777d8321511f1831f8e70e23123f9"},"entityId":{"type":"string","title":"Entity ID","description":"ID of the entity in the list","deprecated":false,"example":"53c778b4321511f1831f8e70e23123f9"},"position":{"type":"integer","title":"Position","description":"Position of the item in the list","deprecated":false,"example":69},"label":{"type":"string","title":"Item label","description":"Label of the item","deprecated":false,"example":"Version 1"},"attrib":{"type":"object","title":"Item attributes","description":"Overrides of the listed entity attributes","deprecated":false},"data":{"type":"object","title":"Item data","description":"Additional data associated with the item","deprecated":false},"tags":{"items":{"type":"string"},"type":"array","title":"Item tags","description":"Tags associated with the item","deprecated":false}},"type":"object","required":["entityId"],"title":"EntityListItemPostModel","description":"Base API model."},"EntityListModel":{"properties":{"id":{"type":"string","title":"ID","deprecated":false,"example":"53c774ae321511f1831f8e70e23123f9"},"entityListType":{"type":"string","title":"List type","description":"Type of the list","deprecated":false,"example":"generic"},"entityListFolderId":{"type":"string","title":"List folder ID","description":"ID of the folder containing the list","deprecated":false},"entityType":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Entity type","description":"Type of the entity that can be included in the list","deprecated":false,"example":"task"},"label":{"type":"string","title":"List label","deprecated":false,"example":"My list"},"access":{"additionalProperties":{"$ref":"#/components/schemas/ListAccessLevel"},"type":"object","title":"Access","description":"Access control for the list. Can be specified for users or teams.","deprecated":false,"example":{"john":10,"!producers":20}},"attrib":{"type":"object","title":"Attributes","description":"List attributes","deprecated":false},"data":{"type":"object","title":"Data","description":"Additional data associated with the list","deprecated":false},"template":{"type":"object","title":"Template","deprecated":false},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List tags","deprecated":false,"example":["tag1","tag2"]},"items":{"items":{"$ref":"#/components/schemas/EntityListItemModel"},"type":"array","title":"List items","deprecated":false},"owner":{"type":"string","title":"Owner","description":"Name of the user who created the list","deprecated":false,"example":"john"},"createdBy":{"type":"string","title":"Created by","deprecated":false,"example":"admin"},"updatedBy":{"type":"string","title":"Updated by","deprecated":false,"example":"editor"},"createdAt":{"type":"string","format":"date-time","title":"Created at","deprecated":false},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","deprecated":false},"active":{"type":"boolean","title":"List active","description":"Whether the list is active or not","deprecated":false,"example":true},"accessLevel":{"allOf":[{"$ref":"#/components/schemas/ListAccessLevel"}],"title":"Current user's access level","default":30,"deprecated":false}},"type":"object","required":["entityListType","entityType","label","active"],"title":"EntityListModel","description":"Base API model."},"EntityListMultiPatchItemModel":{"properties":{"id":{"type":"string","title":"Item ID","deprecated":false,"example":"53c777d8321511f1831f8e70e23123f9"},"entityId":{"type":"string","title":"Entity ID","description":"ID of the entity in the list","deprecated":false,"example":"53c778b4321511f1831f8e70e23123f9"},"position":{"type":"integer","title":"Position","description":"Position of the item in the list","deprecated":false,"example":69},"label":{"type":"string","title":"Item label","description":"Label of the item","deprecated":false,"example":"Version 1"},"attrib":{"type":"object","title":"Item attributes","description":"Overrides of the listed entity attributes","deprecated":false},"data":{"type":"object","title":"Item data","description":"Additional data associated with the item","deprecated":false},"tags":{"items":{"type":"string"},"type":"array","title":"Item tags","description":"Tags associated with the item","deprecated":false}},"type":"object","title":"EntityListMultiPatchItemModel","description":"Base API model."},"EntityListMultiPatchModel":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EntityListMultiPatchItemModel"},"type":"array","minItems":1,"title":"Patched items","deprecated":false},"mode":{"type":"string","enum":["replace","merge","delete"],"title":"Patch mode","description":"The mode of the operation. `replace` will replace all items with the provided ones. `merge` will merge the provided items with the existing ones.`delete` will delete items with matching ids from the list.","default":"replace","deprecated":false}},"type":"object","title":"EntityListMultiPatchModel","description":"Base API model."},"EntityListPatchModel":{"properties":{"label":{"type":"string","title":"List label","deprecated":false,"example":"My list"},"access":{"additionalProperties":{"$ref":"#/components/schemas/ListAccessLevel"},"type":"object","title":"Access","description":"Access control for the list. Can be specified for users or teams.","deprecated":false,"example":{"john":10,"!producers":20}},"attrib":{"type":"object","title":"Attributes","description":"List attributes","deprecated":false},"entityListFolderId":{"type":"string","title":"List folder ID","description":"ID of the folder containing the list","deprecated":false},"data":{"type":"object","title":"Data","description":"Additional data associated with the list","deprecated":false},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List tags","deprecated":false,"example":["tag1","tag2"]},"owner":{"type":"string","title":"Owner","description":"Name of the user who created the list","deprecated":false,"example":"john"},"active":{"type":"boolean","title":"List active","description":"Whether the list is active or not","deprecated":false,"example":true}},"type":"object","title":"EntityListPatchModel","description":"Base API model."},"EntityListPostModel":{"properties":{"id":{"type":"string","title":"ID","deprecated":false,"example":"53c774ae321511f1831f8e70e23123f9"},"entityListType":{"type":"string","title":"List type","description":"Type of the list","default":"generic","deprecated":false,"example":"generic"},"entityListFolderId":{"type":"string","title":"List folder ID","description":"ID of the folder containing the list","deprecated":false},"entityType":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Entity type","description":"Type of the entity that can be included in the list","deprecated":false,"example":"task"},"label":{"type":"string","title":"List label","deprecated":false,"example":"My list"},"access":{"additionalProperties":{"$ref":"#/components/schemas/ListAccessLevel"},"type":"object","title":"Access","description":"Access control for the list. Can be specified for users or teams.","deprecated":false,"example":{"john":10,"!producers":20}},"attrib":{"type":"object","title":"Attributes","description":"List attributes","deprecated":false},"data":{"type":"object","title":"Data","description":"Additional data associated with the list","deprecated":false},"template":{"type":"object","title":"Template","deprecated":false},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List tags","deprecated":false,"example":["tag1","tag2"]},"owner":{"type":"string","title":"Owner","description":"Name of the user who created the list","deprecated":false,"example":"john"},"active":{"type":"boolean","title":"List active","description":"Whether the list is active or not","default":true,"deprecated":false,"example":true},"items":{"items":{"$ref":"#/components/schemas/EntityListItemPostModel"},"type":"array","title":"List items","deprecated":false}},"type":"object","required":["entityType","label"],"title":"EntityListPostModel","description":"Base API model."},"EntityListSummary":{"properties":{"id":{"type":"string","title":"ID","deprecated":false,"example":"53c774ae321511f1831f8e70e23123f9"},"entityListType":{"type":"string","title":"List type","description":"Type of the list","deprecated":false,"example":"generic"},"entityType":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Entity type","description":"Type of the entity that can be included in the list","deprecated":false,"example":"task"},"label":{"type":"string","title":"List label","deprecated":false,"example":"My list"},"count":{"type":"integer","minimum":0.0,"title":"Item count","default":0,"deprecated":false}},"type":"object","required":["entityListType","entityType","label"],"title":"EntityListSummary","description":"Base API model."},"EntityNaming":{"properties":{"capitalization":{"type":"string","enum":["lower","upper","keep","pascal","camel"],"title":"Capitalization","description":"How to capitalize the entity names","default":"lower","disabled":false,"enum_resolver":{}},"separator":{"type":"string","enum":["","_","-","."],"title":"Separator","description":"Character to separate different parts of the name","default":"_","disabled":false,"enum_resolver":{}}},"type":"object","title":"EntityNaming"},"EnumItem":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"title":"Enum value","deprecated":false,"example":"my_value"},"label":{"type":"string","title":"Enum label","deprecated":false,"example":"My Value"},"description":{"type":"string","title":"Enum item description","deprecated":false,"example":"Description of My value"},"fulltext":{"items":{"type":"string"},"type":"array","title":"Fulltext search terms","deprecated":false,"example":["my","value"]},"group":{"type":"string","title":"Enum group","deprecated":false},"icon":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/IconModel"}],"title":"Icon","description":"Icon name (material symbol) or IconModel object","deprecated":false,"example":"dashboard"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","title":"Color in RGB hex format","deprecated":false,"example":"#FF0000"},"disabled":{"type":"boolean","title":"Is disabled","description":"Enum item is visible, but not selectable","default":false,"deprecated":false,"example":false},"disabledMessage":{"type":"string","title":"Disabled message","description":"Message to show when the option is disabled","deprecated":false,"example":"This option is not available"}},"type":"object","required":["value","label"],"title":"EnumItem","description":"Attribute enum item."},"EventModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Id","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"hash":{"type":"string","title":"Hash","deprecated":false},"topic":{"type":"string","title":"Topic","deprecated":false},"sender":{"type":"string","title":"Sender","description":"Identifier of the process that sent the event.","deprecated":false,"example":"service-processor-01"},"senderType":{"type":"string","title":"Sendertype","deprecated":false},"project":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Project name","description":"Name of the project if the event belong to one.","deprecated":false,"example":"MyProject"},"user":{"type":"string","title":"User name","deprecated":false,"example":"admin"},"dependsOn":{"type":"string","maxLength":32,"minLength":32,"title":"Depends on","description":"ID of the event this event depends on.","deprecated":false,"example":"69dd9b85a522fcedc14203ea95f54f52"},"status":{"type":"string","enum":["pending","in_progress","finished","failed","aborted","restarted"],"title":"Status","default":"pending","deprecated":false},"retries":{"type":"integer","title":"Retries","default":0,"deprecated":false},"description":{"type":"string","title":"Description","description":"Short, human-readable description of the event and its state","deprecated":false,"example":"Importing file 3 of 10"},"summary":{"type":"object","title":"Summary","description":"Arbitrary topic-specific data sent to clients in real time","deprecated":false},"payload":{"type":"object","title":"Payload","description":"Full event payload. Only avaiable in REST endpoint.","deprecated":false},"createdAt":{"type":"string","format":"date-time","title":"Createdat","deprecated":false},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","deprecated":false}},"type":"object","required":["hash","topic"],"title":"EventModel","description":"ID is an automatically assigned primary identifier of the event.\nApart from uniqueness, it does not have any special meaning. But it is used\nfor dependencies and hashing.\n\nHash is an unique value for an evend, which is per-topic deterministic.\nThis prevents storing two identical events by two different dispatchers.\nFor example 'enroll' endpoint, which is responsible to create new processing\njobs uses hash of source event id and the target topic. that effectively\nprevents two services starting the same job.\n\nDepends_on is nullable field, when used, it contains an ID of previously\nfinished event which this event depends.\nTBD: when a dependency is restarted, should all dependent\nevents be restarted as well?"},"EventOperationModel":{"properties":{"type":{"type":"string","enum":["delete","restart","abort"],"title":"Operation type","deprecated":false},"filter":{"allOf":[{"$ref":"#/components/schemas/QueryFilter"}],"title":"Filter","description":"Filter source events","deprecated":false}},"type":"object","required":["type","filter"],"title":"EventOperationModel","description":"Base API model."},"ExecuteResponseModel":{"properties":{"type":{"type":"string","enum":["form","launcher","navigate","query","redirect","simple"],"title":"Type","description":"The type of response","default":"simple","deprecated":false,"example":"launcher"},"success":{"type":"boolean","title":"Action success","description":"Payload is still parsed even if the action failed, but the message is highlighted as an error.If the action execution is broken beyond repair, Raise an exception instead of returning a response.","default":true,"deprecated":false},"message":{"type":"string","title":"Message","description":"The message to display","deprecated":false,"example":"Action executed successfully"},"payload":{"type":"object","title":"Response payload","description":"The payload of the response. Payload model is parsed by the client and its schema, is based on the type of action.","deprecated":false}},"type":"object","title":"ExecuteResponseModel","description":"Base API model."},"FileInfo":{"properties":{"size":{"type":"integer","title":"Size"},"filename":{"type":"string","title":"Filename","default":"unknown"},"contentType":{"type":"string","title":"Contenttype","default":"application/octet-stream"}},"type":"object","required":["size"],"title":"FileInfo","description":"Base API model."},"FilesystemSourceInfo":{"properties":{"type":{"type":"string","enum":["filesystem"],"title":"Type","default":"filesystem"},"path":{"allOf":[{"$ref":"#/components/schemas/PathDefinition"}],"title":"Path","deprecated":false}},"type":"object","title":"FilesystemSourceInfo","description":"Base API model."},"FolderAccess":{"properties":{"access_type":{"type":"string","title":"Type","default":"assigned","disabled":false,"enum_resolver":{}},"path":{"type":"string","title":"Path","description":"The path of the folder to allow access to. Required for access_type 'hierarchy and 'children'","default":"","example":"/assets/characters","disabled":false,"widget":"hierarchy"}},"type":"object","title":"FolderAccess","description":"FolderAccess model defines a single whitelist item on accessing a folder."},"FolderAccessList":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"disabled":false},"access_list":{"items":{"$ref":"#/components/schemas/FolderAccess"},"type":"array","title":"Access List","disabled":false,"layout":"compact"}},"type":"object","title":"FolderAccessList"},"FolderAttribModel":{"properties":{"priority":{"type":"string","enum":["urgent","high","normal","low"],"title":"Priority","_attrib_enum":true},"fps":{"type":"number","title":"FPS","description":"Frame rate","example":25},"resolutionWidth":{"type":"integer","exclusiveMaximum":50000.0,"title":"Width","description":"Horizontal resolution","example":1920},"resolutionHeight":{"type":"integer","exclusiveMaximum":50000.0,"title":"Height","description":"Vertical resolution","example":1080},"pixelAspect":{"type":"number","title":"Pixel aspect","example":1.0},"clipIn":{"type":"integer","title":"Clip In","example":1},"clipOut":{"type":"integer","title":"Clip Out","example":1},"frameStart":{"type":"integer","title":"Start frame","example":1001},"frameEnd":{"type":"integer","title":"End frame"},"handleStart":{"type":"integer","title":"Handle start"},"handleEnd":{"type":"integer","title":"Handle end"},"startDate":{"type":"string","format":"date-time","title":"Start date","description":"Date and time when the project or task or asset was started","example":"2021-01-01T00:00:00+00:00"},"endDate":{"type":"string","format":"date-time","title":"End date","description":"Deadline date and time","example":"2021-01-01T00:00:00+00:00"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"FolderAttribModel"},"FolderListItem":{"properties":{"id":{"type":"string","title":"Id"},"path":{"type":"string","title":"Path"},"parentId":{"type":"string","title":"Parentid"},"parents":{"items":{"type":"string"},"type":"array","title":"Parents"},"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"folderType":{"type":"string","title":"Foldertype"},"hasTasks":{"type":"boolean","title":"Hastasks","default":false},"hasChildren":{"type":"boolean","title":"Haschildren","default":false},"hasReviewables":{"type":"boolean","title":"Hasreviewables","default":false},"taskNames":{"items":{"type":"string"},"type":"array","title":"Tasknames"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"status":{"type":"string","title":"Status"},"attrib":{"type":"object","title":"Attrib"},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Ownattrib"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat"}},"type":"object","required":["id","path","parents","name","folderType","status","createdAt","updatedAt"],"title":"FolderListItem","description":"Base API model."},"FolderListModel":{"properties":{"detail":{"type":"string","title":"Detail"},"folders":{"items":{"$ref":"#/components/schemas/FolderListItem"},"type":"array","title":"Folders"}},"type":"object","required":["detail","folders"],"title":"FolderListModel","description":"Base API model."},"FolderModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Folder ID","description":"Unique identifier of the {entity_name}","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Folder name","example":"bush"},"label":{"type":"string","pattern":"^[^';]*$","title":"Folder label","example":"bush"},"folderType":{"type":"string","title":"Folder type","example":"Asset"},"parentId":{"type":"string","pattern":"^[0-f]{32}$","title":"Parent ID","description":"Parent folder ID in the hierarchy","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"path":{"type":"string","title":"Path","example":"/assets/characters/xenomorph"},"hasVersions":{"type":"boolean","title":"Has versions","example":true},"attrib":{"allOf":[{"$ref":"#/components/schemas/FolderAttribModel"}],"title":"Folder attributes"},"data":{"type":"object","title":"Folder auxiliary data"},"active":{"type":"boolean","title":"Folder active","description":"Whether the folder is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"status":{"type":"string","title":"Folder status","description":"Status of the folder","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Folder tags","description":"Tags assigned to the the folder","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the folder","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the folder","example":"Homer"},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["name"],"title":"FolderModel"},"FolderPatchModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Folder name","example":"bush"},"label":{"type":"string","pattern":"^[^';]*$","title":"Folder label","example":"bush"},"folderType":{"type":"string","title":"Folder type","example":"Asset"},"parentId":{"type":"string","pattern":"^[0-f]{32}$","title":"Parent ID","description":"Parent folder ID in the hierarchy","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"status":{"type":"string","title":"Folder status","description":"Status of the folder","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Folder tags","description":"Tags assigned to the the folder","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the folder","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the folder","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/FolderAttribModel"}],"title":"Folder attributes"},"data":{"type":"object","title":"Folder auxiliary data"},"active":{"type":"boolean","title":"Folder active","description":"Whether the folder is active","default":true}},"type":"object","title":"FolderPatchModel"},"FolderPostModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Entity ID","description":"Explicitly set the ID of the entity","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Folder name","example":"bush"},"label":{"type":"string","pattern":"^[^';]*$","title":"Folder label","example":"bush"},"folderType":{"type":"string","title":"Folder type","example":"Asset"},"parentId":{"type":"string","pattern":"^[0-f]{32}$","title":"Parent ID","description":"Parent folder ID in the hierarchy","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"status":{"type":"string","title":"Folder status","description":"Status of the folder","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Folder tags","description":"Tags assigned to the the folder","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the folder","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the folder","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/FolderAttribModel"}],"title":"Folder attributes"},"data":{"type":"object","title":"Folder auxiliary data"},"active":{"type":"boolean","title":"Folder active","description":"Whether the folder is active","default":true}},"type":"object","required":["name"],"title":"FolderPostModel"},"FolderSearchRequest":{"properties":{"taskFilter":{"allOf":[{"$ref":"#/components/schemas/QueryFilter"}],"title":"Filter","description":"Filter object used to resolve the tasks","deprecated":false},"taskSearch":{"type":"string","title":"Text search","description":"'fulltext' search used to resolve the tasks","deprecated":false},"folderFilter":{"allOf":[{"$ref":"#/components/schemas/QueryFilter"}],"title":"Folder Filter","description":"Filter object used to resolve the folders","deprecated":false},"folderSearch":{"type":"string","title":"Folder Text search","description":"'fulltext' search used to resolve the folders","deprecated":false}},"type":"object","title":"FolderSearchRequest","description":"Base API model."},"FolderSearchResponse":{"properties":{"folderIds":{"items":{"type":"string"},"type":"array","title":"Folderids","description":"List of folder ids containing tasks matching the query","deprecated":false,"example":["11111111-1111-1111-1111-111111111111","22222222-2222-2222-2222-222222222222"]}},"type":"object","title":"FolderSearchResponse","description":"Base API model."},"FolderSuggestionItem":{"properties":{"createdAt":{"type":"string","format":"date-time","title":"Creation Date","description":"The date and time when the suggested entity was created","deprecated":false,"example":"2023-01-01T12:00:00Z"},"relevance":{"type":"number","title":"Relevance Score","description":"The relevance score of the suggestion","deprecated":false,"example":0.85},"id":{"type":"string","title":"Id","deprecated":false,"example":"af3e4b3e-1b1b-4b3b-8b3b-3b3b3b3b3b3b"},"folderType":{"type":"string","title":"Foldertype","deprecated":false,"example":"Asset"},"name":{"type":"string","title":"Name","deprecated":false,"example":"my_character"},"label":{"type":"string","title":"Label","deprecated":false,"example":"My Character"},"thumbnailId":{"type":"string","title":"Thumbnailid","deprecated":false}},"type":"object","required":["id","folderType","name"],"title":"FolderSuggestionItem","description":"Base API model."},"FolderType":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","disabled":false},"original_name":{"type":"string","title":"Original name","disabled":false,"scope":[]},"shortName":{"type":"string","title":"Short name","default":"","disabled":false},"color":{"type":"string","title":"Color","default":"#cccccc","disabled":false,"widget":"color"},"icon":{"type":"string","title":"Icon","default":"folder","disabled":false,"widget":"icon"}},"type":"object","required":["name"],"title":"FolderType"},"FormFileData":{"properties":{"filename":{"type":"string","title":"Filename"},"payload":{"type":"string","title":"Payload"},"download":{"type":"boolean","title":"Download"}},"type":"object","required":["filename","payload"],"title":"FormFileData"},"FormSelectOption":{"properties":{"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"icon":{"type":"string","title":"Icon"},"color":{"type":"string","title":"Color"},"badges":{"items":{"type":"string"},"type":"array","title":"Badges"}},"type":"object","required":["value","label"],"title":"FormSelectOption"},"FrontendModuleListItem":{"properties":{"addonName":{"type":"string","title":"Addonname"},"addonVersion":{"type":"string","title":"Addonversion"},"modules":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Modules"}},"type":"object","required":["addonName","addonVersion","modules"],"title":"FrontendModuleListItem","description":"Base API model."},"FrontendScopeSettings":{"properties":{"admin":{"type":"boolean","title":"Admin"},"manager":{"type":"boolean","title":"Manager"},"sidebar":{"type":"string","title":"Sidebar"}},"type":"object","title":"FrontendScopeSettings"},"GenericViewModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"scope":{"type":"string","enum":["project","studio"],"title":"View scope","description":"Determines whether the view is only available for the given project or for all projects (studio).","example":"project"},"owner":{"type":"string","title":"View owner","description":"Name of the user who created the view. Owners have full control over the view, ","example":"steve"},"visibility":{"type":"string","enum":["public","private"],"title":"View visibility","description":"Visibility of the view. Public views are visible to all users, private views are only visible to the owner."},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project "},"position":{"type":"integer","title":"Position"},"accessLevel":{"type":"integer","title":"Accesslevel"},"settings":{"type":"object","title":"Settings"},"access":{"type":"object","title":"Access"},"viewType":{"type":"string","title":"Viewtype"}},"type":"object","required":["label","scope","owner","visibility","working","position","accessLevel","settings","access","viewType"],"title":"GenericViewModel","description":"Reports view model."},"GenericViewPatchModel":{"properties":{"label":{"type":"string","title":"Label"},"owner":{"type":"string","title":"Owner"},"settings":{"type":"object","title":"Settings"},"viewType":{"type":"string","title":"Viewtype"}},"type":"object","required":["viewType"],"title":"GenericViewPatchModel","description":"Reports view post model."},"GenericViewPostModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project ","default":true},"settings":{"type":"object","title":"Settings"},"viewType":{"type":"string","title":"Viewtype"}},"type":"object","required":["label","settings","viewType"],"title":"GenericViewPostModel","description":"Base API model."},"GetAttributeListModel":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/AttributeModel"},"type":"array","title":"Attributes configuration"}},"type":"object","title":"GetAttributeListModel","description":"Base API model."},"GetUrisRequest":{"properties":{"entityType":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Entity type","deprecated":false},"ids":{"items":{"type":"string"},"type":"array","title":"Entity IDs","deprecated":false}},"type":"object","required":["entityType"],"title":"GetUrisRequest","description":"Base API model."},"GetUrisResponse":{"properties":{"uris":{"items":{"$ref":"#/components/schemas/UriResponseItem"},"type":"array","title":"List of URIs","deprecated":false}},"type":"object","title":"GetUrisResponse","description":"Base API model."},"GuestUserModel":{"properties":{"email":{"type":"string","title":"Email","deprecated":false,"example":"foo.bar@example.com"},"fullName":{"type":"string","title":"Full name","deprecated":false,"example":"Foo Bar"},"status":{"type":"string","enum":["pending","active"],"title":"Status","default":"pending","deprecated":false,"example":"pending"}},"type":"object","required":["email"],"title":"GuestUserModel","description":"Base API model."},"GuestUsersListModel":{"properties":{"users":{"items":{"$ref":"#/components/schemas/GuestUserModel"},"type":"array","title":"Guest users","deprecated":false}},"type":"object","title":"GuestUsersListModel","description":"Base API model."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Health":{"properties":{"completion":{"allOf":[{"$ref":"#/components/schemas/HealthCompletion"}],"title":"Completion","description":"Task completion","deprecated":false},"storageUsage":{"allOf":[{"$ref":"#/components/schemas/HealthStorageUsage"}],"title":"Storageusage","description":"Storage usage","deprecated":false},"tasks":{"allOf":[{"$ref":"#/components/schemas/HealthTasks"}],"title":"Tasks","description":"Task statistics","deprecated":false},"statuses":{"additionalProperties":{"type":"integer"},"type":"object","title":"Statuses","description":"Task status statistics","deprecated":false}},"type":"object","required":["completion","storageUsage","tasks","statuses"],"title":"Health","description":"Base API model."},"HealthCompletion":{"properties":{"percentage":{"type":"integer","title":"Percentage","description":"Percentage of tasks completed","deprecated":false,"example":69},"behind":{"type":"integer","title":"Behind","description":"Number of days tasks are not completed after due date","deprecated":false,"example":5},"ahead":{"type":"integer","title":"Ahead","description":"Number of days tasks are completed before due date","deprecated":false,"example":3}},"type":"object","required":["percentage","behind","ahead"],"title":"HealthCompletion","description":"Base API model."},"HealthStorageUsage":{"properties":{"quota":{"type":"integer","title":"Quota","description":"Storage quota","deprecated":false,"example":1000000000},"used":{"type":"integer","title":"Used","description":"Storage used","deprecated":false,"example":500000000}},"type":"object","required":["quota","used"],"title":"HealthStorageUsage","description":"Base API model."},"HealthTasks":{"properties":{"total":{"type":"integer","title":"Total","description":"Total number of tasks","deprecated":false,"example":100},"completed":{"type":"integer","title":"Completed","description":"Number of completed tasks","deprecated":false,"example":50},"overdue":{"type":"integer","title":"Overdue","description":"Number of overdue tasks","deprecated":false,"example":10}},"type":"object","required":["total","completed","overdue"],"title":"HealthTasks","description":"Base API model."},"HeartbeatRequestModel":{"properties":{"hostname":{"type":"string","title":"Hostname"},"health":{"$ref":"#/components/schemas/HostHealthModel"},"services":{"items":{"type":"string"},"type":"array","title":"List of running services","deprecated":false,"example":["ftrack-processor","ftrack-event-server"]}},"type":"object","required":["hostname","health"],"title":"HeartbeatRequestModel","description":"Base API model."},"HeartbeatResponseModel":{"properties":{"services":{"items":{"$ref":"#/components/schemas/ServiceModel"},"type":"array","title":"List of services that should be running","deprecated":false}},"type":"object","title":"HeartbeatResponseModel","description":"Base API model."},"HeroTemplate":{"properties":{"name":{"type":"string","title":"Name","disabled":false},"directory":{"type":"string","title":"Directory template","disabled":false},"file":{"type":"string","title":"File name template","disabled":false}},"type":"object","required":["name","directory","file"],"title":"HeroTemplate"},"HierarchyFolderModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID","description":"Folder ID","example":"af10c8f0e9b111e9b8f90242ac130003"},"name":{"type":"string","title":"Folder name","deprecated":false,"example":"Tree"},"label":{"type":"string","title":"Folder label","deprecated":false,"example":"Tree"},"status":{"type":"string","title":"Folder status","deprecated":false,"example":"Tree"},"folderType":{"type":"string","title":"Folder type","deprecated":false,"example":"AssetBuild"},"hasTasks":{"type":"boolean","title":"Hastasks"},"taskNames":{"items":{"type":"string"},"type":"array","title":"Task names","deprecated":false,"example":["Modeling","Rigging"]},"parents":{"items":{"type":"string"},"type":"array","title":"Parents"},"parentId":{"type":"string","title":"Parent folder id","deprecated":false},"children":{"items":{"$ref":"#/components/schemas/HierarchyFolderModel"},"type":"array","title":"List of children","deprecated":false}},"type":"object","required":["id","name","label","status","hasTasks","taskNames","parents"],"title":"HierarchyFolderModel","description":"Base API model."},"HierarchyResponseModel":{"properties":{"detail":{"type":"string","title":"Detail"},"projectName":{"type":"string","title":"Projectname"},"hierarchy":{"items":{"$ref":"#/components/schemas/HierarchyFolderModel"},"type":"array","title":"Hierarchy"}},"type":"object","required":["detail","projectName","hierarchy"],"title":"HierarchyResponseModel","description":"Base API model."},"HostHealthModel":{"properties":{"cpu":{"type":"number","maximum":100.0,"minimum":0.0,"title":"CPU utilization","default":0,"deprecated":false,"example":0.5},"mem":{"type":"number","maximum":100.0,"minimum":0.0,"title":"RAM utilization","default":0,"deprecated":false,"example":42}},"type":"object","title":"HostHealthModel","description":"Base API model."},"HostListResponseModel":{"properties":{"hosts":{"items":{"$ref":"#/components/schemas/HostModel"},"type":"array","title":"Hosts","description":"List of registered hosts","deprecated":false}},"type":"object","title":"HostListResponseModel","description":"Base API model."},"HostModel":{"properties":{"name":{"type":"string","title":"Host name","deprecated":false,"example":"my-host"},"lastSeen":{"type":"string","format":"date-time","title":"Last seen time","deprecated":false,"example":"2026-04-07T00:04:21.670502"},"health":{"allOf":[{"$ref":"#/components/schemas/HostHealthModel"}],"title":"Host health","deprecated":false,"example":{"cpu":0.5,"mem":42}}},"type":"object","required":["name","lastSeen"],"title":"HostModel","description":"Base API model."},"HttpSourceInfo":{"properties":{"type":{"type":"string","enum":["http"],"title":"Type","default":"http"},"url":{"type":"string","title":"Url"},"filename":{"type":"string","title":"Filename"},"headers":{"additionalProperties":{"type":"string"},"type":"object","title":"Headers"}},"type":"object","required":["url"],"title":"HttpSourceInfo","description":"Base API model."},"IconModel":{"properties":{"type":{"type":"string","enum":["material-symbols","url"],"title":"Icon Type","default":"url","deprecated":false,"example":"material-symbols"},"name":{"type":"string","title":"Icon Name","description":"The name of the icon (for type material-symbols)","deprecated":false,"example":"icon_of_sin"},"color":{"type":"string","title":"Icon Color","description":"The color of the icon (for type material-symbols)","deprecated":false,"example":"#FF0000"},"url":{"type":"string","title":"Url","description":"The URL of the icon (for type url)","deprecated":false,"example":"https://example.com/icon.png"}},"type":"object","title":"IconModel","description":"Base API model."},"InfoResponseModel":{"properties":{"motd":{"type":"string","title":"Login Page Message","description":"Instance specific message to be displayed in the login page","deprecated":false,"example":"Hello and welcome to Ayon!"},"loginPageBackground":{"type":"string","title":"Loginpagebackground","description":"URL of the background image for the login page","deprecated":false,"example":"https://i.insider.com/602ee9d81a89f20019a377c6?width=1136&format=jpeg"},"loginPageBrand":{"type":"string","title":"Brand logo","description":"URL of the brand logo for the login page","deprecated":false},"releaseInfo":{"allOf":[{"$ref":"#/components/schemas/ReleaseInfo"}],"title":"Release info","description":"Information about the current release","deprecated":false},"version":{"type":"string","title":"Ayon version","description":"Version of the Ayon API","deprecated":false},"uptime":{"type":"number","title":"Uptime","description":"Time (seconds) since the server was started","deprecated":false},"noAdminUser":{"type":"boolean","title":"No admin user","description":"No admin user exists, display 'Create admin user' form","deprecated":false},"onboarding":{"type":"boolean","title":"Onboarding","deprecated":false},"hidePasswordAuth":{"type":"boolean","title":"Hide password authentication","description":"Password authentication will not be shown on the login page","deprecated":false},"passwordRecoveryAvailable":{"type":"boolean","title":"Password recovery","deprecated":false},"user":{"allOf":[{"$ref":"#/components/schemas/UserModel"}],"title":"User information","deprecated":false},"attributes":{"items":{"$ref":"#/components/schemas/AttributeModel"},"type":"array","title":"List of attributes","deprecated":false},"sites":{"items":{"$ref":"#/components/schemas/SiteInfo"},"type":"array","title":"List of sites","deprecated":false},"ssoOptions":{"items":{"$ref":"#/components/schemas/SSOOption"},"type":"array","title":"SSO options","deprecated":false},"frontendFlags":{"items":{"type":"string"},"type":"array","title":"Frontend flags","deprecated":false},"extras":{"type":"string","title":"Extras","deprecated":false},"disableChangelog":{"type":"boolean","title":"Disable changelog","description":"If set, the changelog will not be shown to the user","deprecated":false},"disableFeedback":{"type":"boolean","title":"Disable feedback","deprecated":false},"offlineMode":{"type":"boolean","title":"Offline mode","deprecated":false}},"type":"object","title":"InfoResponseModel","description":"Base API model."},"InitializeRequestModel":{"properties":{"adminName":{"type":"string","title":"User name","description":"Username","deprecated":false,"example":"admin"},"adminPassword":{"type":"string","title":"Password","description":"Password","deprecated":false,"example":"SecretPassword.123"},"adminFullName":{"type":"string","title":"Full name","description":"Full name","default":"","deprecated":false,"example":"Administrator"},"adminEmail":{"type":"string","title":"Administrator email","default":"","deprecated":false,"example":"admin@example.com"}},"type":"object","required":["adminName","adminPassword"],"title":"InitializeRequestModel","description":"Base API model."},"InstallAddonResponseModel":{"properties":{"eventId":{"type":"string","title":"Event ID","deprecated":false}},"type":"object","required":["eventId"],"title":"InstallAddonResponseModel","description":"Base API model."},"InstallResponseModel":{"properties":{"eventId":{"type":"string","title":"Event ID","deprecated":false}},"type":"object","title":"InstallResponseModel","description":"Base API model."},"Installer":{"properties":{"filename":{"type":"string","pattern":"^[\\w\\-+._]+$","title":"Filename","description":"Name of the package file","deprecated":false,"example":"ayon_installer_1.2.3_windows.exe"},"platform":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform"},"size":{"type":"integer","title":"Size"},"checksum":{"type":"string","title":"Checksum"},"checksumAlgorithm":{"type":"string","enum":["md5","sha1","sha256"],"title":"Checksumalgorithm"},"sources":{"items":{"$ref":"#/components/schemas/SourceModel"},"type":"array","title":"Sources","description":"List of sources to download the file from. Server source is added automatically by the server if the file is uploaded.","deprecated":false},"version":{"type":"string","title":"Version","description":"Version of the installer","deprecated":false,"example":"1.2.3"},"pythonVersion":{"type":"string","title":"Python version","description":"Version of Python that the installer is created with","deprecated":false,"example":"3.11"},"pythonModules":{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}]},"type":"object","title":"Python modules","description":"mapping of module name:version used to create the installer","deprecated":false,"example":{"requests":"2.25.1","pydantic":"1.8.2"}},"runtimePythonModules":{"additionalProperties":{"type":"string"},"type":"object","title":"Runtime Python modules","description":"mapping of module_name:version used to run the installer","deprecated":false,"example":{"requests":"2.25.1","pydantic":"1.8.2"}}},"type":"object","required":["filename","platform","version","pythonVersion"],"title":"Installer","description":"Base API model."},"InstallerListModel":{"properties":{"installers":{"items":{"$ref":"#/components/schemas/Installer"},"type":"array","title":"Installers","deprecated":false}},"type":"object","title":"InstallerListModel","description":"Base API model."},"InstallerManifest":{"properties":{"filename":{"type":"string","pattern":"^[\\w\\-+._]+$","title":"Filename","description":"Name of the package file","deprecated":false,"example":"ayon_installer_1.2.3_windows.exe"},"platform":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform"},"size":{"type":"integer","title":"Size"},"checksum":{"type":"string","title":"Checksum"},"checksumAlgorithm":{"type":"string","enum":["md5","sha1","sha256"],"title":"Checksumalgorithm"},"sources":{"items":{"$ref":"#/components/schemas/SourceModel"},"type":"array","title":"Sources","description":"List of sources to download the file from. Server source is added automatically by the server if the file is uploaded.","deprecated":false},"version":{"type":"string","title":"Version","description":"Version of the installer","deprecated":false,"example":"1.2.3"},"pythonVersion":{"type":"string","title":"Python version","description":"Version of Python that the installer is created with","deprecated":false,"example":"3.11"},"pythonModules":{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}]},"type":"object","title":"Python modules","description":"mapping of module name:version used to create the installer","deprecated":false,"example":{"requests":"2.25.1","pydantic":"1.8.2"}},"runtimePythonModules":{"additionalProperties":{"type":"string"},"type":"object","title":"Runtime Python modules","description":"mapping of module_name:version used to run the installer","deprecated":false,"example":{"requests":"2.25.1","pydantic":"1.8.2"}}},"type":"object","required":["filename","platform","version","pythonVersion"],"title":"InstallerManifest","description":"Base API model."},"LicenseListModel":{"properties":{"licenses":{"items":{"type":"object"},"type":"array","title":"Licenses","deprecated":false},"syncedAt":{"type":"number","title":"Syncedat"}},"type":"object","title":"LicenseListModel","description":"Base API model."},"LinkModel":{"properties":{"type":{"type":"string","enum":["homepage","github","documentation","license"],"title":"Link type","default":"homepage","deprecated":false,"example":"github"},"label":{"type":"string","title":"Link label","deprecated":false,"example":"ynput/my-addon"},"url":{"type":"string","title":"Link URL","deprecated":false,"example":"https://github.com/ynput/my-addon"}},"type":"object","required":["url"],"title":"LinkModel","description":"A model representing a link to an external resource.\n\nResource is an external website, containing additional information\nabout the addon, such as a homepage, GitHub repository or documentation."},"LinkType":{"properties":{"link_type":{"type":"string","maxLength":100,"minLength":1,"title":"Link type","disabled":false},"input_type":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Input type","disabled":false},"output_type":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Output type","disabled":false},"color":{"type":"string","title":"Color","disabled":false,"widget":"color"},"style":{"type":"string","enum":["solid","dashed"],"title":"Style","default":"solid","disabled":false}},"type":"object","required":["link_type","input_type","output_type"],"title":"LinkType"},"LinkTypeListResponse":{"properties":{"types":{"items":{"$ref":"#/components/schemas/LinkTypeModel"},"type":"array","title":"Types","description":"List of link types defined in the project.","deprecated":false,"example":[{"name":"reference|version|version","link_type":"reference","input_type":"version","output_type":"version","data":{}},{"name":"breakdown|folder|folder","link_type":"breakdown","input_type":"folder","output_type":"folder","data":{}}]}},"type":"object","required":["types"],"title":"LinkTypeListResponse","description":"Base API model."},"LinkTypeModel":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the link type"},"linkType":{"type":"string","title":"Linktype","description":"Type of the link"},"inputType":{"type":"string","title":"Inputtype","description":"Input entity type"},"outputType":{"type":"string","title":"Outputtype","description":"Output entity type"},"data":{"type":"object","title":"Data","description":"Additional link type data"}},"type":"object","required":["name","linkType","inputType","outputType"],"title":"LinkTypeModel","description":"Base API model."},"ListAccessLevel":{"type":"integer","enum":[0,10,20,30],"title":"ListAccessLevel","description":"An enumeration."},"ListBundleModel":{"properties":{"bundles":{"items":{"$ref":"#/components/schemas/BundleModel"},"type":"array","title":"Bundles","deprecated":false},"productionBundle":{"type":"string","title":"Productionbundle","deprecated":false,"example":"my_superior_bundle"},"stagingBundle":{"type":"string","title":"Stagingbundle","deprecated":false,"example":"my_superior_bundle"},"devBundles":{"items":{"type":"string"},"type":"array","title":"Devbundles","deprecated":false}},"type":"object","title":"ListBundleModel","description":"Base API model."},"ListProjectsItemModel":{"properties":{"name":{"type":"string","title":"Project name","deprecated":false},"code":{"type":"string","title":"Project code","deprecated":false},"active":{"type":"boolean","title":"Project is active","default":true,"deprecated":false},"library":{"type":"boolean","title":"Project is a library project","default":false,"deprecated":false},"pinned":{"type":"boolean","title":"Project is pinned","default":false,"deprecated":false},"projectFolder":{"type":"string","title":"Project folder id","deprecated":false},"createdAt":{"type":"string","format":"date-time","title":"Creation time","deprecated":false},"updatedAt":{"type":"string","format":"date-time","title":"Last modified time","deprecated":false}},"type":"object","required":["name","code","createdAt","updatedAt"],"title":"ListProjectsItemModel","description":"Base API model."},"ListProjectsResponseModel":{"properties":{"detail":{"type":"string","title":"Detail","default":"OK","deprecated":false,"example":"Showing LENGTH of COUNT projects"},"count":{"type":"integer","title":"Count","description":"Total count of projects (regardless the pagination)","default":0,"deprecated":false,"example":1},"projects":{"items":{"$ref":"#/components/schemas/ListProjectsItemModel"},"type":"array","title":"Projects","description":"List of projects","deprecated":false,"example":[{"name":"Example project","code":"ex","active":true,"library":false,"pinned":false,"createdAt":"2026-04-07T00:04:21.237472","updatedAt":"2026-04-07T00:04:21.237475"}]}},"type":"object","title":"ListProjectsResponseModel","description":"Base API model."},"ListsSettings":{"properties":{"rowHeight":{"type":"integer","title":"Rowheight"},"sortBy":{"type":"string","title":"Sortby"},"sortDesc":{"type":"boolean","title":"Sortdesc","default":false},"filter":{"$ref":"#/components/schemas/QueryFilter"},"columns":{"items":{"$ref":"#/components/schemas/ColumnItemModel"},"type":"array","title":"List of columns","example":[{"name":"name","pinned":true,"width":120},{"name":"status","pinned":true,"width":120},{"name":"assignees","width":120},{"name":"attrib.priority","width":120}]}},"type":"object","title":"ListsSettings","description":"Base API model."},"ListsViewModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"scope":{"type":"string","enum":["project","studio"],"title":"View scope","description":"Determines whether the view is only available for the given project or for all projects (studio).","example":"project"},"owner":{"type":"string","title":"View owner","description":"Name of the user who created the view. Owners have full control over the view, ","example":"steve"},"visibility":{"type":"string","enum":["public","private"],"title":"View visibility","description":"Visibility of the view. Public views are visible to all users, private views are only visible to the owner."},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project "},"position":{"type":"integer","title":"Position"},"accessLevel":{"type":"integer","title":"Accesslevel"},"settings":{"$ref":"#/components/schemas/ListsSettings"},"access":{"type":"object","title":"Access"},"viewType":{"type":"string","enum":["lists"],"title":"Viewtype","default":"lists"}},"type":"object","required":["label","scope","owner","visibility","working","position","accessLevel","settings","access"],"title":"ListsViewModel","description":"Lists view model."},"ListsViewPatchModel":{"properties":{"label":{"type":"string","title":"Label"},"owner":{"type":"string","title":"Owner"},"settings":{"$ref":"#/components/schemas/ListsSettings"},"viewType":{"type":"string","enum":["lists"],"title":"Viewtype","default":"lists"}},"type":"object","title":"ListsViewPatchModel","description":"Lists view post model."},"ListsViewPostModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project ","default":true},"settings":{"$ref":"#/components/schemas/ListsSettings"},"viewType":{"type":"string","enum":["lists"],"title":"Viewtype","default":"lists"}},"type":"object","required":["label","settings"],"title":"ListsViewPostModel","description":"Lists view post model."},"LocationInfo":{"properties":{"country":{"type":"string","title":"Country"},"subdivision":{"type":"string","title":"Subdivision"},"city":{"type":"string","title":"City"}},"type":"object","title":"LocationInfo"},"LoginRequestModel":{"properties":{"name":{"type":"string","title":"User name","description":"Username","deprecated":false,"example":"admin"},"password":{"type":"string","title":"Password","description":"Password","deprecated":false,"example":"SecretPassword.123"}},"type":"object","required":["name","password"],"title":"LoginRequestModel","description":"Base API model."},"LoginResponseModel":{"properties":{"detail":{"type":"string","title":"Detail message","description":"Text message, which may be displayed to the user","example":"Logged in as NAME"},"error":{"type":"string","title":"Error","example":"Unauthorized"},"token":{"type":"string","title":"Access token","example":"TOKEN"},"user":{"allOf":[{"$ref":"#/components/schemas/UserModel"}],"title":"User data"},"redirectUrl":{"type":"string","title":"Redirect URL","description":"URL to redirect the user after login","example":"/projects"}},"type":"object","title":"LoginResponseModel","description":"Base API model."},"LogoutResponseModel":{"properties":{"detail":{"type":"string","title":"Response detail","description":"Text description, which may be displayed to the user","default":"Logged out","example":"Logged out"}},"type":"object","title":"LogoutResponseModel","description":"Base API model."},"LookupRequestModel":{"properties":{"names":{"items":{"type":"string"},"type":"array","title":"Representation names","deprecated":false,"example":["ma","obj"]},"versionIds":{"items":{"type":"string"},"type":"array","title":"Version IDs","deprecated":false,"example":["c10d5bc73dcab7da4cba0f3e0b3c0aea"]},"context":{"items":{"$ref":"#/components/schemas/ContextFilterModel"},"type":"array","title":"Context filters","deprecated":false}},"type":"object","title":"LookupRequestModel","description":"Base API model."},"LookupResponseModel":{"properties":{"ids":{"items":{"type":"string"},"type":"array","title":"Representation IDs","description":"List of matching representation ids","deprecated":false,"example":["c10d5bc73dcab7da4cba0f3e0b3c0aea"]}},"type":"object","title":"LookupResponseModel","description":"Base API model."},"ManageInboxItemRequest":{"properties":{"projectName":{"type":"string","title":"Projectname","deprecated":false},"ids":{"items":{"type":"string"},"type":"array","title":"List of items","description":"List of reference_ids of items to be managed","deprecated":false},"all":{"type":"boolean","title":"All","description":"If true, all items will be managed","default":false,"deprecated":false},"status":{"type":"string","enum":["unread","read","inactive"],"title":"Status","description":"Status to set for the items","deprecated":false}},"type":"object","required":["projectName","status"],"title":"ManageInboxItemRequest","description":"Base API model."},"Metrics":{"properties":{"version":{"type":"string","title":"Ayon version","deprecated":false,"example":"1.14.5+202603301343"},"releaseInfo":{"allOf":[{"$ref":"#/components/schemas/ReleaseInfo"}],"title":"Release info","description":"Information about the branch and commit of the current release","deprecated":false,"example":{"version":"1.14.5","buildDate":"20260330","buildTime":"1343","frontendBranch":"develop","backendBranch":"develop","frontendCommit":"5357174d8","backendCommit":"fe58b306"}},"uptime":{"type":"number","title":"Uptime","description":"Time (seconds) since the server was (re)started","deprecated":false,"example":518163},"system":{"allOf":[{"$ref":"#/components/schemas/SystemMetricsData"}],"title":"System metrics","description":"System metrics data\nContains information about machine utilization,\nand database sizes.\n","deprecated":false},"userCounts":{"allOf":[{"$ref":"#/components/schemas/UserCounts"}],"title":"User counts","description":"Number of total and active users, admins and managers","deprecated":false},"projectCounts":{"allOf":[{"$ref":"#/components/schemas/ProjectCounts"}],"title":"Project counts","description":"Number of total and active projects","deprecated":false,"example":1},"projects":{"items":{"$ref":"#/components/schemas/ProjectMetrics"},"type":"array","title":"Project statistics","description":"Project specific metrics\n\nContain information about size and usage of each active project.\n","deprecated":false},"averageProjectEventCount":{"type":"integer","title":"Average project event count","description":"Average number of events per project\n\nThis disregards projects with less than 300 events\n(such as testing projects).\n","deprecated":false},"installedAddons":{"items":{"items":[{"type":"string"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Installed addons","description":"Addons and their versions installed on the server\n\nWe track what addons are installed on the server, and compare this to the\naddons which are actually used in the production bundle.\n","deprecated":false,"example":[["maya","1.0.0"],["maya","1.0.1"],["ftrack","1.2.3"]]},"eventTopics":{"additionalProperties":{"type":"integer"},"type":"object","title":"Event topics count","description":"Return the count of events per topic.\n\nThis helps us with optimization of event clean-up,\nand other maintenance tasks.\n","deprecated":false},"productionBundle":{"allOf":[{"$ref":"#/components/schemas/ProductionBundle"}],"title":"Production bundle","description":"Addons and their versions used in the production bundle\n\nWe track what addons are used in the production bundle, as well as what\nlauncher version is used. This is used to determine if the production\nbundle is up to date with the latest addons and launcher version,\nand if not, to notify the user that they should update in case of\nsecurity issues or other important changes.\n","deprecated":false},"studioSettingsOverrides":{"items":{"$ref":"#/components/schemas/SettingsOverrides"},"type":"array","title":"Studio settings overrides","description":"Studio settings overrides\n\nWe track what settings are overridden in the studio settings.\nThis helps us determine, which settins are used the most and which\nsettings are not used at all. This is used to determine how we should\norganize the settings in the UI and how the settings could be improved.\n","deprecated":false},"services":{"items":{"$ref":"#/components/schemas/ServiceInfo"},"type":"array","title":"Services","description":"List of active services","deprecated":false},"trafficStats":{"items":{"$ref":"#/components/schemas/TrafficStat"},"type":"array","title":"Traffic stats","deprecated":false},"userStats":{"items":{"$ref":"#/components/schemas/UserStat"},"type":"array","title":"User stats","deprecated":false}},"type":"object","title":"Metrics","description":"Metrics model"},"MigrateBundleSettingsRequest":{"properties":{"sourceBundle":{"type":"string","title":"Sourcebundle","description":"Source bundle","deprecated":false,"example":"old-bundle"},"targetBundle":{"type":"string","title":"Targetbundle","description":"Target bundle","deprecated":false,"example":"new-bundle"},"sourceVariant":{"type":"string","title":"Sourcevariant","description":"Source variant","deprecated":false,"example":"production"},"targetVariant":{"type":"string","title":"Targetvariant","description":"Target variant","deprecated":false,"example":"staging"},"withProjects":{"type":"boolean","title":"Withprojects","description":"Migrate project settings","default":true,"deprecated":false,"example":true}},"type":"object","required":["sourceBundle","targetBundle","sourceVariant","targetVariant"],"title":"MigrateBundleSettingsRequest","description":"Base API model."},"ModifyOverridesRequestModel":{"properties":{"action":{"type":"string","enum":["delete","pin"],"title":"Action","deprecated":false},"path":{"items":{"type":"string"},"type":"array","title":"Path","deprecated":false}},"type":"object","required":["action","path"],"title":"ModifyOverridesRequestModel","description":"Base API model."},"NewUserModel":{"properties":{"attrib":{"allOf":[{"$ref":"#/components/schemas/UserAttribModel"}],"title":"User attributes"},"data":{"type":"object","title":"User auxiliary data"},"active":{"type":"boolean","title":"User active","description":"Whether the user is active","default":true},"password":{"type":"string","title":"Password","description":"Password for the new user","deprecated":false},"apiKey":{"type":"string","title":"Apikey","description":"API Key for the new service user","deprecated":false}},"type":"object","title":"NewUserModel"},"OperationModel":{"properties":{"id":{"type":"string","title":"Operation ID","deprecated":false},"type":{"type":"string","enum":["create","update","delete"],"title":"Operation type","deprecated":false},"entityType":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Entity type","deprecated":false},"entityId":{"type":"string","title":"Entity ID","deprecated":false},"data":{"type":"object","title":"Data","deprecated":false},"force":{"type":"boolean","title":"Force recursive deletion","default":false,"deprecated":false},"asUser":{"type":"string","title":"Asuser"}},"type":"object","required":["type","entityType"],"title":"OperationModel","description":"Model for a single project-level operation.\n\nOperation type is one of create, update, delete.\n\nEach operation has a unique ID, that may be used to match the result\nin the response. The ID is automatically generated if not provided.\n\nThe entity ID is required for update and delete operations, optional for create.\nThe data field is required for create and update operations, ignored for delete.\n\nForce flag may be used for delete operations to force\nrecursive deletion of the children entities (if applicable)."},"OperationResponseModel":{"properties":{"id":{"type":"string","title":"Operation ID","deprecated":false},"type":{"type":"string","enum":["create","update","delete"],"title":"Operation type","deprecated":false},"entityType":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Entity type","deprecated":false},"entityId":{"type":"string","title":"Entity ID","deprecated":false},"success":{"type":"boolean","title":"Operation success","deprecated":false},"status":{"type":"integer","title":"HTTP-like status code","deprecated":false},"errorCode":{"type":"string","title":"Error code","deprecated":false},"detail":{"type":"string","title":"Error message","deprecated":false}},"type":"object","required":["id","type","entityType","success","status"],"title":"OperationResponseModel","description":"Response model for a single operation.\n\nEntity ID is `None` if the operation is a create and the operation fails.\nStatus returns HTTP-like status code (201, 204, 404, etc.)"},"OperationsRequestModel":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/OperationModel"},"type":"array","title":"Operations","deprecated":false},"canFail":{"type":"boolean","title":"Canfail","default":false},"waitForEvents":{"type":"boolean","title":"Waitforevents","default":false},"raiseOnError":{"type":"boolean","title":"Raiseonerror","default":false}},"type":"object","title":"OperationsRequestModel","description":"Base API model."},"OperationsResponseModel":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/OperationResponseModel"},"type":"array","title":"Operations","deprecated":false},"success":{"type":"boolean","title":"Overall success","default":false,"deprecated":false}},"type":"object","title":"OperationsResponseModel","description":"Base API model."},"OverviewSettings":{"properties":{"showHierarchy":{"type":"boolean","title":"Showhierarchy","default":true},"rowHeight":{"type":"integer","title":"Rowheight"},"groupBy":{"type":"string","title":"Groupby"},"groupSortByDesc":{"type":"boolean","title":"Groupsortbydesc","default":false},"showEmptyGroups":{"type":"boolean","title":"Showemptygroups","default":false},"sortBy":{"type":"string","title":"Sortby"},"sortDesc":{"type":"boolean","title":"Sortdesc","default":false},"filter":{"$ref":"#/components/schemas/QueryFilter"},"folderFilter":{"$ref":"#/components/schemas/QueryFilter"},"sliceType":{"type":"string","title":"Slicetype"},"columns":{"items":{"$ref":"#/components/schemas/ColumnItemModel"},"type":"array","title":"List of columns","example":[{"name":"name","pinned":true,"width":120},{"name":"status","pinned":true,"width":120},{"name":"assignees","width":120},{"name":"attrib.priority","width":120}]}},"type":"object","title":"OverviewSettings","description":"Base API model."},"OverviewViewModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"scope":{"type":"string","enum":["project","studio"],"title":"View scope","description":"Determines whether the view is only available for the given project or for all projects (studio).","example":"project"},"owner":{"type":"string","title":"View owner","description":"Name of the user who created the view. Owners have full control over the view, ","example":"steve"},"visibility":{"type":"string","enum":["public","private"],"title":"View visibility","description":"Visibility of the view. Public views are visible to all users, private views are only visible to the owner."},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project "},"position":{"type":"integer","title":"Position"},"accessLevel":{"type":"integer","title":"Accesslevel"},"settings":{"$ref":"#/components/schemas/OverviewSettings"},"access":{"type":"object","title":"Access"},"viewType":{"type":"string","enum":["overview"],"title":"Viewtype","default":"overview"}},"type":"object","required":["label","scope","owner","visibility","working","position","accessLevel","settings","access"],"title":"OverviewViewModel","description":"Overview view model."},"OverviewViewPatchModel":{"properties":{"label":{"type":"string","title":"Label"},"owner":{"type":"string","title":"Owner"},"settings":{"$ref":"#/components/schemas/OverviewSettings"},"viewType":{"type":"string","enum":["overview"],"title":"Viewtype","default":"overview"}},"type":"object","title":"OverviewViewPatchModel","description":"Overview view post model."},"OverviewViewPostModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project ","default":true},"settings":{"$ref":"#/components/schemas/OverviewSettings"},"viewType":{"type":"string","enum":["overview"],"title":"Viewtype","default":"overview"}},"type":"object","required":["label","settings"],"title":"OverviewViewPostModel","description":"Overview view post model."},"PasswordResetModel":{"properties":{"token":{"type":"string","title":"Token","deprecated":false},"password":{"type":"string","title":"New password","deprecated":false}},"type":"object","required":["token"],"title":"PasswordResetModel","description":"Base API model."},"PasswordResetRequestModel":{"properties":{"email":{"type":"string","title":"Email","deprecated":false,"example":"you@somewhere.com"}},"type":"object","required":["email"],"title":"PasswordResetRequestModel","description":"Base API model."},"PatchServiceRequestModel":{"properties":{"volumes":{"items":{"type":"string"},"type":"array","title":"Volumes","deprecated":false,"example":["/tmp:/tmp"]},"ports":{"items":{"type":"string"},"type":"array","title":"Ports","deprecated":false,"example":["8080:8080"]},"memLimit":{"type":"string","title":"Memory Limit","deprecated":false,"example":"1g"},"user":{"type":"string","title":"User","deprecated":false,"example":"1000"},"env":{"type":"object","title":"Env","deprecated":false},"storagePath":{"type":"string","title":"Storage","deprecated":false,"example":"/mnt/storage"},"shouldRun":{"type":"boolean","title":"Shouldrun","deprecated":false},"hostname":{"type":"string","title":"Hostname","deprecated":false},"config":{"allOf":[{"$ref":"#/components/schemas/ServiceConfigModel"}],"title":"Config","description":"Deprecated, use top level fields instead","deprecated":true,"example":{}}},"type":"object","title":"PatchServiceRequestModel","description":"Base API model."},"PathDefinition":{"properties":{"windows":{"type":"string","title":"Windows","default":""},"linux":{"type":"string","title":"Linux","default":""},"darwin":{"type":"string","title":"Darwin","default":""}},"type":"object","title":"PathDefinition","description":"Base API model."},"Permissions":{"properties":{"studio":{"allOf":[{"$ref":"#/components/schemas/StudioManagementPermissions"}],"title":"Studio permissions","disabled":false,"scope":["studio"]},"project":{"allOf":[{"$ref":"#/components/schemas/ProjectManagementPermissions"}],"title":"Project permissions","disabled":false},"create":{"allOf":[{"$ref":"#/components/schemas/FolderAccessList"}],"title":"Restrict folder creation","description":"Whitelist folders a user can create","disabled":false},"read":{"allOf":[{"$ref":"#/components/schemas/FolderAccessList"}],"title":"Restrict folder read","description":"Whitelist folders a user can read","disabled":false},"update":{"allOf":[{"$ref":"#/components/schemas/FolderAccessList"}],"title":"Restrict folder update","description":"Whitelist folders a user can update","disabled":false},"publish":{"allOf":[{"$ref":"#/components/schemas/FolderAccessList"}],"title":"Restrict publishing","description":"Whitelist folders a user can publish to","disabled":false},"delete":{"allOf":[{"$ref":"#/components/schemas/FolderAccessList"}],"title":"Restrict folder delete","description":"Whitelist folders a user can delete","disabled":false},"attrib_read":{"allOf":[{"$ref":"#/components/schemas/AttributeReadAccessList"}],"title":"Restrict attribute read","description":"Whitelist attributes a user can read","disabled":false},"attrib_write":{"allOf":[{"$ref":"#/components/schemas/AttributeWriteAccessList"}],"title":"Restrict attribute update","description":"Whitelist attributes a user can write","disabled":false},"activities":{"allOf":[{"$ref":"#/components/schemas/ActivitiesAccessList"}],"title":"Restrict activities","description":"Whitelist activities a user can perform","disabled":false},"actions":{"allOf":[{"$ref":"#/components/schemas/ActionsAccessList"}],"title":"Restrict actions","description":"Whitelist actions a user can perform","disabled":false},"links":{"allOf":[{"$ref":"#/components/schemas/EntityLinksAccessList"}],"title":"Restrict entity links creation","description":"Whitelist link types a user can create between entities","disabled":false},"endpoints":{"allOf":[{"$ref":"#/components/schemas/EndpointsAccessList"}],"title":"Restrict REST endpoints","description":"Whitelist REST endpoints a user can access","disabled":false},"advanced":{"allOf":[{"$ref":"#/components/schemas/ProjectAdvancedPermissions"}],"title":"Advanced access control","disabled":false}},"type":"object","title":"Permissions"},"ProductAttribModel":{"properties":{"productGroup":{"type":"string","title":"Product group"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"ProductAttribModel"},"ProductBaseType":{"properties":{"name":{"type":"string","title":"Name","default":"","disabled":false},"color":{"type":"string","title":"Color","default":"#cccccc","disabled":false,"widget":"color"},"icon":{"type":"string","title":"Icon","default":"deployed_code","disabled":false,"widget":"icon"}},"type":"object","title":"ProductBaseType","description":"Product type customization settings."},"ProductBaseTypes":{"properties":{"default":{"allOf":[{"$ref":"#/components/schemas/DefaultProductBaseType"}],"title":"Default appearance","description":"Default appearance for product types","default":{"color":"#cccccc","icon":"deployed_code"},"disabled":false},"definitions":{"items":{"$ref":"#/components/schemas/ProductBaseType"},"type":"array","title":"Appearance overrides","disabled":false}},"type":"object","title":"ProductBaseTypes","description":"Product types customization settings."},"ProductModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Product ID","description":"Unique identifier of the {entity_name}","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Name","description":"Name of the product","example":"modelMain"},"folderId":{"type":"string","pattern":"^[0-f]{32}$","title":"Folder ID","description":"ID of the parent folder","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"productType":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Product type","description":"Product type","example":"modelMain"},"productBaseType":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Product base type","description":"Product base type","example":"model"},"path":{"type":"string","title":"Path","example":"/assets/characters/xenomorph/modelMain"},"attrib":{"allOf":[{"$ref":"#/components/schemas/ProductAttribModel"}],"title":"Product attributes"},"data":{"type":"object","title":"Product auxiliary data"},"active":{"type":"boolean","title":"Product active","description":"Whether the product is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"status":{"type":"string","title":"Product status","description":"Status of the product","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Product tags","description":"Tags assigned to the the product","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the product","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the product","example":"Homer"},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["name","folderId","productType"],"title":"ProductModel"},"ProductPatchModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Name","description":"Name of the product","example":"modelMain"},"folderId":{"type":"string","pattern":"^[0-f]{32}$","title":"Folder ID","description":"ID of the parent folder","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"productType":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Product type","description":"Product type","example":"modelMain"},"productBaseType":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Product base type","description":"Product base type","example":"model"},"status":{"type":"string","title":"Product status","description":"Status of the product","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Product tags","description":"Tags assigned to the the product","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the product","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the product","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/ProductAttribModel"}],"title":"Product attributes"},"data":{"type":"object","title":"Product auxiliary data"},"active":{"type":"boolean","title":"Product active","description":"Whether the product is active","default":true}},"type":"object","title":"ProductPatchModel"},"ProductPostModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Entity ID","description":"Explicitly set the ID of the entity","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Name","description":"Name of the product","example":"modelMain"},"folderId":{"type":"string","pattern":"^[0-f]{32}$","title":"Folder ID","description":"ID of the parent folder","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"productType":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Product type","description":"Product type","example":"modelMain"},"productBaseType":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Product base type","description":"Product base type","example":"model"},"status":{"type":"string","title":"Product status","description":"Status of the product","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Product tags","description":"Tags assigned to the the product","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the product","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the product","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/ProductAttribModel"}],"title":"Product attributes"},"data":{"type":"object","title":"Product auxiliary data"},"active":{"type":"boolean","title":"Product active","description":"Whether the product is active","default":true}},"type":"object","required":["name","folderId","productType"],"title":"ProductPostModel"},"ProductSuggestionItem":{"properties":{"createdAt":{"type":"string","format":"date-time","title":"Creation Date","description":"The date and time when the suggested entity was created","deprecated":false,"example":"2023-01-01T12:00:00Z"},"relevance":{"type":"number","title":"Relevance Score","description":"The relevance score of the suggestion","deprecated":false,"example":0.85},"id":{"type":"string","title":"Id","deprecated":false,"example":"af3e4b3e-1b1b-4b3b-8b3b-3b3b3b3b3b3b"},"name":{"type":"string","title":"Name","deprecated":false,"example":"model_main"},"productType":{"type":"string","title":"Producttype","deprecated":false,"example":"Model"},"parent":{"allOf":[{"$ref":"#/components/schemas/FolderSuggestionItem"}],"title":"Parent","deprecated":false}},"type":"object","required":["id","name","productType"],"title":"ProductSuggestionItem","description":"Base API model."},"ProductTypeListItem":{"properties":{"name":{"type":"string","title":"Product Type Name","deprecated":false},"baseType":{"type":"string","title":"Base Product Type Name","deprecated":false},"color":{"type":"string","title":"Color","deprecated":false},"icon":{"type":"string","title":"Icon","deprecated":false}},"type":"object","required":["name"],"title":"ProductTypeListItem","description":"Base API model."},"ProductTypesList":{"properties":{"productTypes":{"items":{"$ref":"#/components/schemas/ProductTypeListItem"},"type":"array","title":"Product Types","deprecated":false},"default":{"$ref":"#/components/schemas/DefaultProductType"}},"type":"object","required":["default"],"title":"ProductTypesList","description":"Base API model."},"ProductionBundle":{"properties":{"addons":{"additionalProperties":{"type":"string"},"type":"object","title":"Addons","deprecated":false,"example":{"maya":"1.0.0","nuke":"1.0.0","ftrack":"1.0.0"}},"launcherVersion":{"type":"string","title":"Launcher version","deprecated":false,"example":"1.0.0"},"dependencyPackages":{"additionalProperties":{"type":"string"},"type":"object","title":"Dependency packages","deprecated":false,"example":{"windows":"ayon_2502101448_windows.zip","darwin":"ayon_2502101448_darwin.zip","linux":"ayon_2502101448_linux.zip"}}},"type":"object","title":"ProductionBundle","description":"Base API model."},"ProjectActivityPostModel":{"properties":{"id":{"type":"string","title":"Id","description":"Explicitly set the ID of the activity","deprecated":false},"activityType":{"type":"string","enum":["comment","watch","reviewable","status.change","assignee.add","assignee.remove","version.publish"],"title":"Activitytype","deprecated":false,"example":"comment"},"body":{"type":"string","title":"Body","default":"","deprecated":false,"example":"This is a comment"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","deprecated":false,"example":["tag1","tag2"]},"files":{"items":{"type":"string"},"type":"array","title":"Files","deprecated":false,"example":["file1","file2"]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","deprecated":false,"example":"2021-01-01T00:00:00Z"},"data":{"type":"object","title":"Data","description":"Additional data","deprecated":false,"example":{"key":"value"}}},"type":"object","required":["activityType"],"title":"ProjectActivityPostModel","description":"Base API model."},"ProjectAdvancedPermissions":{"properties":{"show_sibling_tasks":{"type":"boolean","title":"Show sibling tasks","description":"If a user can access a task through the 'Assigned' permission, enabling this will also show all sibling tasks in the same folder. When disabled, only the assigned task is visible.","default":true,"disabled":false}},"type":"object","title":"ProjectAdvancedPermissions"},"ProjectBundle":{"properties":{"addons":{"additionalProperties":{"type":"string"},"type":"object","title":"Addons","description":"Dictionary of addon names and their versions. Use `null` to disable an addon."},"installerVersion":{"type":"string","title":"Installer Version"},"dependencyPackages":{"additionalProperties":{"type":"string"},"type":"object","title":"Platform"},"addonMetadata":{"items":{"$ref":"#/components/schemas/AddonMetadata"},"type":"array","title":"Addon Metadata"},"installerOptions":{"items":{"type":"string"},"type":"array","title":"Installer Options"},"dependencyPackageOptions":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Dependency Package Options"}},"type":"object","required":["addons"],"title":"ProjectBundle","description":"Base API model."},"ProjectBundleModel":{"properties":{"production":{"type":"string","title":"Production"},"staging":{"type":"string","title":"Staging"}},"type":"object","title":"ProjectBundleModel","description":"Base API model."},"ProjectCounts":{"properties":{"total":{"type":"integer","title":"Total projects","default":0,"deprecated":false,"example":6},"active":{"type":"integer","title":"Active projects","default":0,"deprecated":false,"example":1}},"type":"object","title":"ProjectCounts","description":"Base API model."},"ProjectFolderData":{"properties":{"color":{"type":"string","title":"Color","description":"Hex color code","deprecated":false},"icon":{"type":"string","title":"Icon","description":"Icon name","deprecated":false}},"type":"object","title":"ProjectFolderData","description":"Base API model."},"ProjectFolderModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"label":{"type":"string","maxLength":255,"minLength":1,"title":"Folder label","deprecated":false},"parentId":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Parent folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"position":{"type":"integer","minimum":0.0,"title":"Folder position","default":0,"deprecated":false},"data":{"allOf":[{"$ref":"#/components/schemas/ProjectFolderData"}],"title":"Folder additional data","deprecated":false}},"type":"object","required":["id","label"],"title":"ProjectFolderModel","description":"Base API model."},"ProjectFolderOrderModel":{"properties":{"order":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Ordered list of folder IDs","deprecated":false}},"type":"object","required":["order"],"title":"ProjectFolderOrderModel","description":"Base API model."},"ProjectFolderPatchModel":{"properties":{"label":{"type":"string","maxLength":255,"minLength":1,"title":"Folder label","deprecated":false},"parentId":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Parent folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"data":{"allOf":[{"$ref":"#/components/schemas/ProjectFolderData"}],"title":"Folder additional data","deprecated":false}},"type":"object","title":"ProjectFolderPatchModel","description":"Base API model."},"ProjectFolderPostModel":{"properties":{"id":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"label":{"type":"string","maxLength":255,"minLength":1,"title":"Folder label","deprecated":false},"parentId":{"type":"string","maxLength":32,"minLength":32,"pattern":"^[0-9a-f]{32}$","title":"Parent folder ID","deprecated":false,"example":"af10c8f0e9b111e9b8f90242ac130003"},"data":{"allOf":[{"$ref":"#/components/schemas/ProjectFolderData"}],"title":"Folder additional data","deprecated":false}},"type":"object","required":["label"],"title":"ProjectFolderPostModel","description":"Base API model."},"ProjectFoldersResponseModel":{"properties":{"folders":{"items":{"$ref":"#/components/schemas/ProjectFolderModel"},"type":"array","title":"Folders","deprecated":false}},"type":"object","title":"ProjectFoldersResponseModel","description":"Base API model."},"ProjectManagementPermissions":{"properties":{"anatomy":{"type":"integer","title":"Project anatomy","description":"Allow users to view or edit the project anatomy","default":0,"disabled":false,"widget":"permission"},"access":{"type":"integer","title":"Project access","description":"Allow users to view or assign users to project access groups","default":0,"disabled":false,"widget":"permission"},"settings":{"type":"integer","title":"Project addon settings","description":"Allow users to view or edit the project addon settings","default":0,"disabled":false,"widget":"permission"}},"type":"object","title":"ProjectManagementPermissions"},"ProjectMetrics":{"properties":{"nickname":{"type":"string","title":"Project nickname","deprecated":false,"example":"crazy-pink-cat"},"folderCount":{"type":"integer","title":"Folder count","default":0,"deprecated":false,"example":52},"productCount":{"type":"integer","title":"Product count","default":0,"deprecated":false,"example":587},"versionCount":{"type":"integer","title":"Version count","default":0,"deprecated":false,"example":2348},"representationCount":{"type":"integer","title":"Representation count","default":0,"deprecated":false,"example":2888},"taskCount":{"type":"integer","title":"Task count","default":0,"deprecated":false,"example":222},"workfileCount":{"type":"integer","title":"Workfile count","default":0,"deprecated":false,"example":323},"rootCount":{"type":"integer","title":"Root count","deprecated":false,"example":2},"teamCount":{"type":"integer","title":"Team count","deprecated":false,"example":2},"duration":{"type":"integer","title":"Duration","description":"Duration in days","deprecated":false,"example":30},"dbSize":{"type":"integer","title":"Dbsize","deprecated":false},"storageUtilization":{"type":"integer","title":"Storageutilization","deprecated":false},"folderTypes":{"items":{"type":"string"},"type":"array","title":"Folder types","description":"List of folder types in the project. Collected only in the 'saturated' mode.","deprecated":false,"example":["Folder","Asset","Episode","Sequence"]},"taskTypes":{"items":{"type":"string"},"type":"array","title":"Task types","description":"List of task types in the project. Collected only in the 'saturated' mode.","deprecated":false,"example":["Art","Modeling","Texture","Lookdev"]},"statuses":{"items":{"type":"string"},"type":"array","title":"Statuses","description":"List of statuses in the project. Collected only in the 'saturated' mode.","deprecated":false,"example":["Not ready","In progress","Pending review","Approved"]}},"type":"object","required":["nickname"],"title":"ProjectMetrics","description":"Project metrics model"},"ProjectModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Project name","description":"Name is an unique id of the {entity_name}","example":"awesome_project"},"code":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project code","example":"prj"},"library":{"type":"boolean","title":"Library","default":false},"folderTypes":{"items":{"$ref":"#/components/schemas/FolderType"},"type":"array","title":"Folder types","deprecated":false},"taskTypes":{"items":{"$ref":"#/components/schemas/TaskType"},"type":"array","title":"Task types","deprecated":false},"linkTypes":{"items":{"$ref":"#/components/schemas/LinkTypeModel"},"type":"array","title":"Link types","example":[{"name":"reference|version|version","link_type":"reference","input_type":"version","output_type":"version","data":{"color":"#ff0000"}}]},"statuses":{"items":{"$ref":"#/components/schemas/Status"},"type":"array","title":"Statuses","deprecated":false},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags","deprecated":false},"config":{"type":"object","title":"Project config","default":{}},"attrib":{"allOf":[{"$ref":"#/components/schemas/pydantic__main__ProjectAttribModel"}],"title":"Project attributes"},"data":{"type":"object","title":"Project auxiliary data"},"active":{"type":"boolean","title":"Project active","description":"Whether the project is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["name","code"],"title":"ProjectModel"},"ProjectOptionsModel":{"properties":{"project_code_regex":{"type":"string","title":"Project Code Regex","description":"A regular expression that is used to create project code from the project name.","default":"^.{0,3}","disabled":false}},"type":"object","title":"ProjectOptionsModel"},"ProjectPatchModel":{"properties":{"code":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project code","example":"prj"},"library":{"type":"boolean","title":"Library","default":false},"folderTypes":{"items":{"$ref":"#/components/schemas/FolderType"},"type":"array","title":"Folder types","deprecated":false},"taskTypes":{"items":{"$ref":"#/components/schemas/TaskType"},"type":"array","title":"Task types","deprecated":false},"linkTypes":{"items":{"$ref":"#/components/schemas/LinkTypeModel"},"type":"array","title":"Link types","example":[{"name":"reference|version|version","link_type":"reference","input_type":"version","output_type":"version","data":{"color":"#ff0000"}}]},"statuses":{"items":{"$ref":"#/components/schemas/Status"},"type":"array","title":"Statuses","deprecated":false},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags","deprecated":false},"config":{"type":"object","title":"Project config","default":{}},"attrib":{"allOf":[{"$ref":"#/components/schemas/pydantic__main__ProjectAttribModel"}],"title":"Project attributes"},"data":{"type":"object","title":"Project auxiliary data"},"active":{"type":"boolean","title":"Project active","description":"Whether the project is active","default":true}},"type":"object","title":"ProjectPatchModel"},"ProjectPostModel":{"properties":{"code":{"type":"string","pattern":"^[a-zA-Z0-9_]*$","title":"Project code","example":"prj"},"library":{"type":"boolean","title":"Library","default":false},"folderTypes":{"items":{"$ref":"#/components/schemas/FolderType"},"type":"array","title":"Folder types","deprecated":false},"taskTypes":{"items":{"$ref":"#/components/schemas/TaskType"},"type":"array","title":"Task types","deprecated":false},"linkTypes":{"items":{"$ref":"#/components/schemas/LinkTypeModel"},"type":"array","title":"Link types","example":[{"name":"reference|version|version","link_type":"reference","input_type":"version","output_type":"version","data":{"color":"#ff0000"}}]},"statuses":{"items":{"$ref":"#/components/schemas/Status"},"type":"array","title":"Statuses","deprecated":false},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags","deprecated":false},"config":{"type":"object","title":"Project config","default":{}},"attrib":{"allOf":[{"$ref":"#/components/schemas/pydantic__main__ProjectAttribModel"}],"title":"Project attributes"},"data":{"type":"object","title":"Project auxiliary data"},"active":{"type":"boolean","title":"Project active","description":"Whether the project is active","default":true}},"type":"object","required":["code"],"title":"ProjectPostModel"},"ProjectTagsModel":{"properties":{"folders":{"items":{"type":"string"},"type":"array","title":"Folders","deprecated":false},"tasks":{"items":{"type":"string"},"type":"array","title":"Tasks","deprecated":false},"products":{"items":{"type":"string"},"type":"array","title":"Products","deprecated":false},"versions":{"items":{"type":"string"},"type":"array","title":"Versions","deprecated":false},"representations":{"items":{"type":"string"},"type":"array","title":"Representations","deprecated":false},"workfiles":{"items":{"type":"string"},"type":"array","title":"Workfiles","deprecated":false}},"type":"object","title":"ProjectTagsModel","description":"Base API model."},"ProjectTeamsResponseModel":{"properties":{"teamSizeActive":{"type":"integer","title":"Teamsizeactive","description":"Number of active team members","default":0,"deprecated":false},"teamSizeTotal":{"type":"integer","title":"Teamsizetotal","description":"Total number of team members","default":0,"deprecated":false},"usersWithAccessActive":{"type":"integer","title":"Userswithaccessactive","description":"Number of active users","default":0,"deprecated":false},"usersWithAccessTotal":{"type":"integer","title":"Userswithaccesstotal","description":"Total number of users","default":0,"deprecated":false},"roles":{"additionalProperties":{"type":"integer"},"type":"object","title":"Roles","description":"Number of users per role","deprecated":false,"example":{"artist":1,"viewer":2}}},"type":"object","required":["roles"],"title":"ProjectTeamsResponseModel","description":"Base API model."},"PublishTemplate":{"properties":{"name":{"type":"string","title":"Name","disabled":false},"directory":{"type":"string","title":"Directory template","disabled":false},"file":{"type":"string","title":"File name template","disabled":false}},"type":"object","required":["name","directory","file"],"title":"PublishTemplate"},"QueryCondition":{"properties":{"key":{"type":"string","title":"Key","description":"Path to the key separated by slashes","deprecated":false,"example":"summary/newValue"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"integer"},"type":"array"},{"items":{"type":"number"},"type":"array"}],"title":"Value","description":"Value to compare against","deprecated":false,"example":"New value"},"operator":{"type":"string","enum":["eq","like","lt","gt","lte","gte","ne","isnull","notnull","in","notin","includes","excludes","includesall","excludesall","includesany","excludesany"],"title":"Operator","description":"Comparison operator","default":"eq","deprecated":false,"example":"eq"}},"type":"object","required":["key"],"title":"QueryCondition","description":"Base API model."},"QueryFilter":{"properties":{"conditions":{"items":{"anyOf":[{"$ref":"#/components/schemas/QueryCondition"},{"$ref":"#/components/schemas/QueryFilter"}]},"type":"array","title":"Conditions","description":"List of conditions to be evaluated","deprecated":false},"operator":{"type":"string","enum":["and","or"],"title":"Operator","description":"Operator to use when joining conditions","default":"and","deprecated":false}},"type":"object","title":"QueryFilter","description":"Base API model."},"QueryRequestModel":{"properties":{"entity":{"type":"string","enum":["event","project","user","folder","product","task","version","representation","workfile"],"title":"Entity","deprecated":false},"filter":{"allOf":[{"$ref":"#/components/schemas/QueryFilter"}],"title":"Filter","description":"Filter events","deprecated":false},"limit":{"type":"integer","title":"Limit","description":"Maximum number of events to return","default":100,"deprecated":false},"offset":{"type":"integer","title":"Offset","description":"Offset of the first event to return","default":0,"deprecated":false}},"type":"object","required":["entity"],"title":"QueryRequestModel","description":"Base API model."},"ReleaseInfo":{"properties":{"version":{"type":"string","title":"Backend version","deprecated":false,"example":"1.0.0"},"buildDate":{"type":"string","title":"Build date","deprecated":false,"example":"20231013"},"buildTime":{"type":"string","title":"Build time","deprecated":false,"example":"1250"},"frontendBranch":{"type":"string","title":"Frontend branch","deprecated":false,"example":"main"},"backendBranch":{"type":"string","title":"Backend branch","deprecated":false,"example":"main"},"frontendCommit":{"type":"string","title":"Frontend commit","deprecated":false,"example":"1234567"},"backendCommit":{"type":"string","title":"Backend commit","deprecated":false,"example":"1234567"}},"type":"object","required":["version","buildDate","buildTime","frontendBranch","backendBranch","frontendCommit","backendCommit"],"title":"ReleaseInfo","description":"Base API model."},"ReleaseInfoModel":{"properties":{"name":{"type":"string","title":"Release name","deprecated":false,"example":"2023.08-Kitsu"},"label":{"type":"string","title":"Release label","deprecated":false,"example":"2D Animation"},"release":{"type":"string","title":"Release","deprecated":false,"example":"2023.08"},"description":{"type":"string","title":"Release bio","default":"","deprecated":false,"example":"2D Animation"},"icon":{"type":"string","title":"Release icon","default":"","deprecated":false,"example":"skeleton"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","deprecated":false},"mandatoryAddons":{"items":{"type":"string"},"type":"array","title":"Mandatoryaddons","deprecated":false},"addons":{"items":{"$ref":"#/components/schemas/AddonVersionDetail"},"type":"array","title":"Addons","deprecated":false},"installers":{"items":{"$ref":"#/components/schemas/InstallerManifest"},"type":"array","title":"Installers","deprecated":false},"dependencyPackages":{"items":{"$ref":"#/components/schemas/DependencyPackageManifest"},"type":"array","title":"Dependencypackages","deprecated":false}},"type":"object","required":["name","label","release","createdAt"],"title":"ReleaseInfoModel","description":"Base API model."},"ReleaseListItemModel":{"properties":{"name":{"type":"string","title":"Release name","deprecated":false,"example":"2023.08-Kitsu"},"label":{"type":"string","title":"Release label","deprecated":false,"example":"2D Animation"},"release":{"type":"string","title":"Release","deprecated":false,"example":"2023.08"},"description":{"type":"string","title":"Release bio","default":"","deprecated":false,"example":"2D Animation"},"icon":{"type":"string","title":"Release icon","default":"","deprecated":false,"example":"skeleton"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","deprecated":false},"mandatoryAddons":{"items":{"type":"string"},"type":"array","title":"Mandatoryaddons","deprecated":false},"isLatest":{"type":"boolean","title":"Islatest","deprecated":false},"addons":{"items":{"type":"string"},"type":"array","title":"Addons","deprecated":false}},"type":"object","required":["name","label","release","createdAt","isLatest","addons"],"title":"ReleaseListItemModel","description":"Base API model."},"ReleaseListModel":{"properties":{"releases":{"items":{"$ref":"#/components/schemas/ReleaseListItemModel"},"type":"array","title":"Releases","deprecated":false},"detail":{"type":"string","title":"Detail","default":""}},"type":"object","required":["releases"],"title":"ReleaseListModel","description":"Base API model."},"RenamePresetModel":{"properties":{"name":{"type":"string","title":"New name of the anatomy preset","description":"The new name of the anatomy preset.","deprecated":false}},"type":"object","required":["name"],"title":"RenamePresetModel","description":"Base API model."},"RepresentationAttribModel":{"properties":{"fps":{"type":"number","title":"FPS","description":"Frame rate","example":25},"resolutionWidth":{"type":"integer","exclusiveMaximum":50000.0,"title":"Width","description":"Horizontal resolution","example":1920},"resolutionHeight":{"type":"integer","exclusiveMaximum":50000.0,"title":"Height","description":"Vertical resolution","example":1080},"pixelAspect":{"type":"number","title":"Pixel aspect","example":1.0},"clipIn":{"type":"integer","title":"Clip In","example":1},"clipOut":{"type":"integer","title":"Clip Out","example":1},"frameStart":{"type":"integer","title":"Start frame","example":1001},"frameEnd":{"type":"integer","title":"End frame"},"handleStart":{"type":"integer","title":"Handle start"},"handleEnd":{"type":"integer","title":"Handle end"},"path":{"type":"string","title":"Path"},"template":{"type":"string","title":"Template"},"extension":{"type":"string","title":"File extension"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"RepresentationAttribModel"},"RepresentationFileModel":{"properties":{"id":{"type":"string","title":"File ID","description":"Unique (within the representation) ID of the file","example":"7da4cba0f3e0b3c0aeac10d5bc73dcab"},"name":{"type":"string","title":"File name","description":"File name"},"path":{"type":"string","title":"File path","description":"Path to the file","example":"{root}/demo_Commercial/shots/sh010/workfile/workfileCompositing/v001/sh010_workfile Compositing_v001.ma"},"size":{"type":"integer","title":"File size","description":"Size of the file in bytes","default":0,"example":"123456"},"hash":{"type":"string","title":"Hash of the file","example":"e831c13f0ba0fbbfe102cd50420439d1"},"hashType":{"type":"string","enum":["md5","sha1","sha256","op3"],"title":"Hash type. 'op3' is the default for OpenPype 3 imports","default":"md5","example":"md5"}},"type":"object","required":["id","path"],"title":"RepresentationFileModel","description":"Base API model."},"RepresentationModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Representation ID","description":"Unique identifier of the {entity_name}","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Name","description":"The name of the representation","example":"ma"},"versionId":{"type":"string","pattern":"^[0-f]{32}$","title":"Version ID","description":"ID of the parent version","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"files":{"items":{"$ref":"#/components/schemas/RepresentationFileModel"},"type":"array","title":"Files","description":"List of files"},"traits":{"type":"object","title":"Traits","description":"Dict of traits","example":{"ayon.2d.PixelBased.v1":{"display_window_width":1920,"display_window_height":1080},"ayon.2d.Image.v1":{}}},"path":{"type":"string","title":"Path","example":"/assets/characters/xenomorph/modelMain/v003/ma"},"attrib":{"allOf":[{"$ref":"#/components/schemas/RepresentationAttribModel"}],"title":"Representation attributes"},"data":{"type":"object","title":"Representation auxiliary data"},"active":{"type":"boolean","title":"Representation active","description":"Whether the representation is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"status":{"type":"string","title":"Representation status","description":"Status of the representation","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Representation tags","description":"Tags assigned to the the representation","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the representation","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the representation","example":"Homer"},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["name","versionId"],"title":"RepresentationModel"},"RepresentationPatchModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Name","description":"The name of the representation","example":"ma"},"versionId":{"type":"string","pattern":"^[0-f]{32}$","title":"Version ID","description":"ID of the parent version","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"files":{"items":{"$ref":"#/components/schemas/RepresentationFileModel"},"type":"array","title":"Files","description":"List of files"},"traits":{"type":"object","title":"Traits","description":"Dict of traits","example":{"ayon.2d.PixelBased.v1":{"display_window_width":1920,"display_window_height":1080},"ayon.2d.Image.v1":{}}},"status":{"type":"string","title":"Representation status","description":"Status of the representation","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Representation tags","description":"Tags assigned to the the representation","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the representation","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the representation","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/RepresentationAttribModel"}],"title":"Representation attributes"},"data":{"type":"object","title":"Representation auxiliary data"},"active":{"type":"boolean","title":"Representation active","description":"Whether the representation is active","default":true}},"type":"object","title":"RepresentationPatchModel"},"RepresentationPostModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Entity ID","description":"Explicitly set the ID of the entity","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Name","description":"The name of the representation","example":"ma"},"versionId":{"type":"string","pattern":"^[0-f]{32}$","title":"Version ID","description":"ID of the parent version","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"files":{"items":{"$ref":"#/components/schemas/RepresentationFileModel"},"type":"array","title":"Files","description":"List of files"},"traits":{"type":"object","title":"Traits","description":"Dict of traits","example":{"ayon.2d.PixelBased.v1":{"display_window_width":1920,"display_window_height":1080},"ayon.2d.Image.v1":{}}},"status":{"type":"string","title":"Representation status","description":"Status of the representation","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Representation tags","description":"Tags assigned to the the representation","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the representation","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the representation","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/RepresentationAttribModel"}],"title":"Representation attributes"},"data":{"type":"object","title":"Representation auxiliary data"},"active":{"type":"boolean","title":"Representation active","description":"Whether the representation is active","default":true}},"type":"object","required":["name","versionId"],"title":"RepresentationPostModel"},"ResolveRequestModel":{"properties":{"resolveRoots":{"type":"boolean","title":"Resolve roots","description":"If x-ayon-site-id header is provided, resolve representation path roots","default":false,"deprecated":false},"uris":{"items":{"type":"string"},"type":"array","title":"URIs","description":"List of uris to resolve","deprecated":false,"example":["ayon+entity://myproject/assets/env/beach?product=layout&version=v004"]}},"type":"object","required":["uris"],"title":"ResolveRequestModel","description":"Base API model."},"ResolvedEntityModel":{"properties":{"projectName":{"type":"string","title":"Project name","deprecated":false,"example":"demo_Big_Feature"},"folderId":{"type":"string","title":"Folder id","deprecated":false,"example":"0254c370005811ee9a740242ac130004"},"productId":{"type":"string","title":"Product id","deprecated":false,"example":"0255ce50005811ee9a740242ac130004"},"taskId":{"type":"string","title":"Task id","deprecated":false},"versionId":{"type":"string","title":"Version id","deprecated":false,"example":"0256ba2c005811ee9a740242ac130004"},"representationId":{"type":"string","title":"Representation id","deprecated":false},"workfileId":{"type":"string","title":"Workfile id","deprecated":false},"filePath":{"type":"string","title":"File path","description":"Path to the file if a representation is specified","deprecated":false,"example":"/path/to/file.ma"},"target":{"type":"string","enum":["folder","product","version","representation","task","workfile"],"title":"Target entity type","description":"The deepest entity type queried","deprecated":false}},"type":"object","title":"ResolvedEntityModel","description":"Base API model."},"ResolvedURIModel":{"properties":{"uri":{"type":"string","title":"Resolved URI","deprecated":false,"example":"ayon+entity://demo_Big_Feature/assets/environments/01_pfueghtiaoft?product=layoutMain&version=v004&representation=ma"},"entities":{"items":{"$ref":"#/components/schemas/ResolvedEntityModel"},"type":"array","title":"Resolved entities","deprecated":false,"example":[{"projectName":"demo_Big_Feature","folderId":"0254c370005811ee9a740242ac130004","productId":"0255ce50005811ee9a740242ac130004","versionId":"0256ba2c005811ee9a740242ac130004","filePath":"/path/to/file.ma"}]},"error":{"type":"string","title":"Error","description":"Error message if the URI could not be resolved","deprecated":false}},"type":"object","required":["uri"],"title":"ResolvedURIModel","description":"Base API model."},"RestartRequiredModel":{"properties":{"required":{"type":"boolean","title":"Required","description":"Whether the server requires a restart","deprecated":false},"reason":{"type":"string","title":"Reason","description":"The reason for the restart","deprecated":false}},"type":"object","required":["required"],"title":"RestartRequiredModel","description":"Base API model."},"ReviewableAuthor":{"properties":{"name":{"type":"string","title":"Author Name","deprecated":false},"fullName":{"type":"string","title":"Author Full Name","deprecated":false}},"type":"object","required":["name"],"title":"ReviewableAuthor","description":"Base API model."},"ReviewableModel":{"properties":{"fileId":{"type":"string","title":"Reviewable ID","deprecated":false},"activityId":{"type":"string","title":"Activity ID","deprecated":false},"filename":{"type":"string","title":"Reviewable Name","deprecated":false},"label":{"type":"string","title":"Reviewable Label","deprecated":false},"mimetype":{"type":"string","title":"Reviewable Mimetype","deprecated":false},"availability":{"type":"string","enum":["unknown","conversionRequired","conversionRecommended","ready"],"title":"Reviewable availability","default":"unknown","deprecated":false},"mediaInfo":{"type":"object","title":"Media information","deprecated":false},"createdFrom":{"type":"string","title":"File ID of the original file","deprecated":false},"processing":{"allOf":[{"$ref":"#/components/schemas/ReviewableProcessingStatus"}],"title":"Processing","description":"Information about the processing status","deprecated":false},"createdAt":{"type":"string","format":"date-time","title":"Creation Date","deprecated":false},"updatedAt":{"type":"string","format":"date-time","title":"Update Date","deprecated":false},"author":{"allOf":[{"$ref":"#/components/schemas/ReviewableAuthor"}],"title":"Author Information","deprecated":false}},"type":"object","required":["fileId","activityId","filename","mimetype","author"],"title":"ReviewableModel","description":"Base API model."},"ReviewableProcessingStatus":{"properties":{"eventId":{"type":"string","title":"Event ID","deprecated":false},"status":{"type":"string","title":"Processing Status","deprecated":false},"description":{"type":"string","title":"Processing Description","deprecated":false}},"type":"object","required":["status","description"],"title":"ReviewableProcessingStatus","description":"Base API model."},"ReviewsSettings":{"properties":{"rowHeight":{"type":"integer","title":"Rowheight"},"sortBy":{"type":"string","title":"Sortby"},"sortDesc":{"type":"boolean","title":"Sortdesc","default":false},"filter":{"$ref":"#/components/schemas/QueryFilter"},"columns":{"items":{"$ref":"#/components/schemas/ColumnItemModel"},"type":"array","title":"List of columns","example":[{"name":"name","pinned":true,"width":120},{"name":"status","pinned":true,"width":120},{"name":"assignees","width":120},{"name":"attrib.priority","width":120}]},"gridHeight":{"type":"integer","title":"Gridheight"}},"type":"object","title":"ReviewsSettings","description":"Base API model."},"ReviewsViewModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"scope":{"type":"string","enum":["project","studio"],"title":"View scope","description":"Determines whether the view is only available for the given project or for all projects (studio).","example":"project"},"owner":{"type":"string","title":"View owner","description":"Name of the user who created the view. Owners have full control over the view, ","example":"steve"},"visibility":{"type":"string","enum":["public","private"],"title":"View visibility","description":"Visibility of the view. Public views are visible to all users, private views are only visible to the owner."},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project "},"position":{"type":"integer","title":"Position"},"accessLevel":{"type":"integer","title":"Accesslevel"},"settings":{"$ref":"#/components/schemas/ReviewsSettings"},"access":{"type":"object","title":"Access"},"viewType":{"type":"string","enum":["reviews"],"title":"Viewtype","default":"reviews"}},"type":"object","required":["label","scope","owner","visibility","working","position","accessLevel","settings","access"],"title":"ReviewsViewModel","description":"Reviews view model."},"ReviewsViewPatchModel":{"properties":{"label":{"type":"string","title":"Label"},"owner":{"type":"string","title":"Owner"},"settings":{"$ref":"#/components/schemas/ReviewsSettings"},"viewType":{"type":"string","enum":["reviews"],"title":"Viewtype","default":"reviews"}},"type":"object","title":"ReviewsViewPatchModel","description":"Reviews view post model."},"ReviewsViewPostModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project ","default":true},"settings":{"$ref":"#/components/schemas/ReviewsSettings"},"viewType":{"type":"string","enum":["reviews"],"title":"Viewtype","default":"reviews"}},"type":"object","required":["label","settings"],"title":"ReviewsViewPostModel","description":"Reviews view post model."},"Root":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]{1,}$","title":"Root name","example":"work","disabled":false},"windows":{"type":"string","title":"Windows","default":"","example":"C:/projects","disabled":false},"linux":{"type":"string","title":"Linux","default":"","example":"/mnt/share/projects","disabled":false},"darwin":{"type":"string","title":"Darwin","default":"","example":"/Volumes/projects","disabled":false}},"type":"object","required":["name"],"title":"Root","description":"Setup root paths"},"SSOOption":{"properties":{"name":{"type":"string","title":"Provider name","description":"Unique name of the SSO provider","deprecated":false},"hidden":{"type":"boolean","title":"Hidden","description":"If True, the provider will not be shown in the UI","default":false,"deprecated":false},"title":{"type":"string","title":"Title","description":"Nice human-readable title of the provider","deprecated":false},"icon":{"type":"string","title":"Icon","deprecated":false},"color":{"type":"string","title":"Button background color","default":"#47b7da","deprecated":false},"textColor":{"type":"string","title":"Button text color","default":"#ffffff","deprecated":false},"redirectKey":{"type":"string","title":"Redirectkey"},"url":{"type":"string","title":"Url"},"args":{"additionalProperties":{"type":"string"},"type":"object","title":"Args","deprecated":false},"callback":{"type":"string","title":"Callback","deprecated":false}},"type":"object","required":["name","url","callback"],"title":"SSOOption","description":"Base API model."},"Secret":{"properties":{"name":{"type":"string","title":"Secret name","deprecated":false},"value":{"type":"string","title":"Secret value","deprecated":false}},"type":"object","title":"Secret","description":"Base API model."},"ServerConfigModel":{"properties":{"studio_name":{"type":"string","title":"Studio Name","description":"The name of the studio","default":"","example":"Ynput","disabled":false},"customization":{"allOf":[{"$ref":"#/components/schemas/CustomizationModel"}],"title":"Customization","description":"Customization options for the web interface","disabled":false},"authentication":{"allOf":[{"$ref":"#/components/schemas/AuthenticationModel"}],"title":"Authentication","description":"Settings related to user authentication","disabled":false},"project_options":{"allOf":[{"$ref":"#/components/schemas/ProjectOptionsModel"}],"title":"Project Options","disabled":false},"changelog":{"allOf":[{"$ref":"#/components/schemas/ChangelogSettingsModel"}],"title":"Changelog Settings","description":"Settings for the changelog feature","disabled":false}},"type":"object","title":"ServerConfigModel"},"ServerSourceInfo":{"properties":{"type":{"type":"string","enum":["server"],"title":"Type","default":"server"},"filename":{"type":"string","title":"Filename"},"path":{"type":"string","title":"Path"}},"type":"object","title":"ServerSourceInfo","description":"Base API model."},"ServiceConfigModel":{"properties":{"volumes":{"items":{"type":"string"},"type":"array","title":"Volumes","deprecated":false,"example":["/tmp:/tmp"]},"ports":{"items":{"type":"string"},"type":"array","title":"Ports","deprecated":false,"example":["8080:8080"]},"memLimit":{"type":"string","title":"Memory Limit","deprecated":false,"example":"1g"},"user":{"type":"string","title":"User","deprecated":false,"example":"1000"},"env":{"type":"object","title":"Env","deprecated":false},"storagePath":{"type":"string","title":"Storage","deprecated":false,"example":"/mnt/storage"}},"type":"object","title":"ServiceConfigModel","description":"Base API model."},"ServiceDataModel":{"properties":{"volumes":{"items":{"type":"string"},"type":"array","title":"Volumes","deprecated":false,"example":["/tmp:/tmp"]},"ports":{"items":{"type":"string"},"type":"array","title":"Ports","deprecated":false,"example":["8080:8080"]},"memLimit":{"type":"string","title":"Memory Limit","deprecated":false,"example":"1g"},"user":{"type":"string","title":"User","deprecated":false,"example":"1000"},"env":{"type":"object","title":"Env","deprecated":false},"storagePath":{"type":"string","title":"Storage","deprecated":false,"example":"/mnt/storage"},"image":{"type":"string","title":"Image","deprecated":false,"example":"ayon/ftrack-addon-leecher:2.0.0"}},"type":"object","title":"ServiceDataModel","description":"Base API model."},"ServiceInfo":{"properties":{"addonName":{"type":"string","title":"Addon name","deprecated":false,"example":"kitsu"},"addonVersion":{"type":"string","title":"Addon version","deprecated":false,"example":"1.0.0"},"serviceName":{"type":"string","title":"Service name","deprecated":false,"example":"processor"}},"type":"object","required":["addonName","addonVersion","serviceName"],"title":"ServiceInfo","description":"Base API model."},"ServiceListModel":{"properties":{"services":{"items":{"$ref":"#/components/schemas/ServiceModel"},"type":"array","title":"Services","deprecated":false}},"type":"object","title":"ServiceListModel","description":"Base API model."},"ServiceModel":{"properties":{"name":{"type":"string","title":"Name","deprecated":false},"hostname":{"type":"string","title":"Hostname","deprecated":false,"example":"worker03"},"addonName":{"type":"string","title":"Addonname","deprecated":false,"example":"ftrack"},"addonVersion":{"type":"string","title":"Addonversion","deprecated":false,"example":"2.0.0"},"service":{"type":"string","title":"Service","deprecated":false,"example":"collector"},"shouldRun":{"type":"boolean","title":"Shouldrun","deprecated":false},"isRunning":{"type":"boolean","title":"Isrunning","deprecated":false},"lastSeen":{"type":"string","format":"date-time","title":"Lastseen","deprecated":false},"lastSeenDelta":{"type":"number","title":"Lastseendelta","deprecated":false},"data":{"allOf":[{"$ref":"#/components/schemas/ServiceDataModel"}],"title":"Data","deprecated":false}},"type":"object","required":["name","hostname","addonName","addonVersion","service","shouldRun","isRunning"],"title":"ServiceModel","description":"Base API model."},"SessionModel":{"properties":{"user":{"$ref":"#/components/schemas/UserModel"},"token":{"type":"string","title":"Token"},"created":{"type":"number","title":"Created","default":0},"lastUsed":{"type":"number","title":"Lastused","default":0},"isService":{"type":"boolean","title":"Isservice","default":false},"isApiKey":{"type":"boolean","title":"Isapikey","default":false},"clientInfo":{"$ref":"#/components/schemas/ClientInfo"}},"type":"object","required":["user","token"],"title":"SessionModel","description":"Base API model."},"SetAttributeListModel":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/AttributeModel"},"type":"array","title":"Attributes configuration"},"deleteMissing":{"type":"boolean","title":"Delete missing","description":"Delete custom attributes not includedin the payload from the database.","default":false}},"type":"object","title":"SetAttributeListModel","description":"Base API model."},"SetDefaultViewRequestModel":{"properties":{"viewId":{"type":"string","pattern":"^[0-9a-f]{32}$","title":"View ID","deprecated":false,"example":"54c0764e321511f1831f8e70e23123f9"}},"type":"object","required":["viewId"],"title":"SetDefaultViewRequestModel","description":"Base API model."},"SettingsOverrides":{"properties":{"addonName":{"type":"string","title":"Addon name","deprecated":false,"example":"resolve"},"addonVersion":{"type":"string","title":"Addon version","deprecated":false,"example":"1.0.0"},"paths":{"items":{"items":{"type":"string"},"type":"array"},"type":"array","title":"Path","description":"List of paths to settings, which have a studio override","deprecated":false,"example":[["imageio","ocio_config","override_global_config"]]}},"type":"object","title":"SettingsOverrides","description":"Settings overrides model"},"ShareOption":{"properties":{"shareType":{"type":"string","title":"Sharetype"},"value":{"type":"string","title":"Value"},"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"attribute":{"type":"string","title":"Attribute"}},"type":"object","required":["shareType","value","name","label"],"title":"ShareOption","description":"Base API model."},"ShareOptions":{"properties":{"options":{"items":{"$ref":"#/components/schemas/ShareOption"},"type":"array","title":"Options"}},"type":"object","required":["options"],"title":"ShareOptions","description":"Base API model."},"SimpleFormField":{"properties":{"type":{"type":"string","enum":["text","boolean","select","multiselect","hidden","integer","float","label","file"],"title":"Type"},"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"placeholder":{"title":"Placeholder"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"integer"},"type":"array"},{"items":{"type":"number"},"type":"array"},{"$ref":"#/components/schemas/FormFileData"}],"title":"Value"},"regex":{"type":"string","title":"Regex"},"multiline":{"type":"boolean","title":"Multiline"},"syntax":{"type":"string","title":"Syntax"},"options":{"items":{"$ref":"#/components/schemas/FormSelectOption"},"type":"array","title":"Options"},"highlight":{"type":"string","enum":["info","warning","error"],"title":"Highlight"},"min":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Min"},"max":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Max"},"validExtensions":{"items":{"type":"string"},"type":"array","title":"Validextensions"}},"type":"object","required":["type","name"],"title":"SimpleFormField"},"SiteInfo":{"properties":{"id":{"type":"string","title":"Site identifier","deprecated":false},"platform":{"type":"string","enum":["windows","linux","darwin"],"title":"Platform","deprecated":false},"hostname":{"type":"string","title":"Machine hostname","deprecated":false},"version":{"type":"string","title":"Ayon version","deprecated":false},"users":{"items":{"type":"string"},"type":"array","uniqueItems":true,"title":"List of users","deprecated":false}},"type":"object","required":["id","platform","hostname","version","users"],"title":"SiteInfo","description":"Base API model."},"SortReviewablesRequest":{"properties":{"sort":{"items":{"type":"string"},"type":"array","title":"Reviewables Order","description":"List of reviewable (activity) ids in the order you want them to appear in the UI.","deprecated":false,"example":["c197712a48ef11ef95450242ac1f0004","c519a3f448ef11ef95450242ac1f0004","c8edce0648ef11ef95450242ac1f0004"]}},"type":"object","title":"SortReviewablesRequest","description":"Base API model."},"SourceModel":{"properties":{"type":{"type":"string","enum":["server","http"],"title":"Source type","description":"If set to server, the file is stored on the server. If set to http, the file is downloaded from the specified URL.","deprecated":false,"example":"http"},"url":{"type":"string","title":"Download URL","description":"URL to download the file from. Only used if type is http","deprecated":false,"example":"https://example.com/file.zip"}},"type":"object","required":["type"],"title":"SourceModel","description":"Base API model."},"SourcesPatchModel":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/SourceModel"},"type":"array","title":"Sources","description":"List of sources to download the file from. Server source is added automatically by the server if the file is uploaded.","deprecated":false}},"type":"object","title":"SourcesPatchModel","description":"Base API model."},"SpawnServiceRequestModel":{"properties":{"addonName":{"type":"string","title":"Addon name","deprecated":false,"example":"ftrack"},"addonVersion":{"type":"string","title":"Addon version","deprecated":false,"example":"2.0.0"},"service":{"type":"string","title":"Service","deprecated":false,"example":"leecher"},"hostname":{"type":"string","title":"Host","deprecated":false,"example":"worker03"},"config":{"allOf":[{"$ref":"#/components/schemas/ServiceConfigModel"}],"title":"Config","deprecated":false}},"type":"object","required":["addonName","addonVersion","service","hostname"],"title":"SpawnServiceRequestModel","description":"Base API model."},"StagingDirectory":{"properties":{"name":{"type":"string","title":"Name","disabled":false},"directory":{"type":"string","title":"Directory","default":"","disabled":false}},"type":"object","required":["name"],"title":"StagingDirectory"},"Status":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","disabled":false},"original_name":{"type":"string","title":"Original Name","disabled":false,"scope":[]},"shortName":{"type":"string","title":"Short name","default":"","example":"PRG","disabled":false},"state":{"type":"string","enum":["not_started","in_progress","done","blocked"],"title":"State","default":"not_started","example":"in_progress","disabled":false,"enum_resolver":{}},"icon":{"type":"string","title":"Icon","default":"","example":"play_arrow","disabled":false,"widget":"icon"},"color":{"type":"string","title":"Color","default":"#cacaca","example":"#3498db","disabled":false,"widget":"color"},"scope":{"items":{"type":"string"},"type":"array","title":"Scope","description":"Limit the status to specific entity types.","example":["folder","product","version","representation","task","workfile"],"disabled":false,"enum_resolver":{}}},"type":"object","required":["name"],"title":"Status"},"StudioManagementPermissions":{"properties":{"create_projects":{"type":"boolean","title":"Create projects","description":"Allow users to create new projects","default":false,"disabled":false,"scope":["studio"],"widget":"permission"},"list_all_users":{"type":"boolean","title":"List all users","description":"Allow users to list all users in the studio","default":false,"disabled":false,"scope":["studio"],"widget":"permission"}},"type":"object","title":"StudioManagementPermissions"},"SuggestRequest":{"properties":{"entityType":{"type":"string","enum":["folder","task","version"],"title":"Entitytype","deprecated":false,"example":"task"},"entityId":{"type":"string","title":"Entityid","deprecated":false,"example":"af3e4b3e-1b1b-4b3b-8b3b-3b3b3b3b3b3b"}},"type":"object","required":["entityType","entityId"],"title":"SuggestRequest","description":"Base API model."},"SuggestResponse":{"properties":{"users":{"items":{"$ref":"#/components/schemas/UserSuggestionItem"},"type":"array","title":"Users","deprecated":false},"tasks":{"items":{"$ref":"#/components/schemas/TaskSuggestionItem"},"type":"array","title":"Tasks","deprecated":false},"versions":{"items":{"$ref":"#/components/schemas/VersionSuggestionItem"},"type":"array","title":"Versions","deprecated":false}},"type":"object","title":"SuggestResponse","description":"Base API model."},"SystemMetricsData":{"properties":{"cpuUsage":{"type":"number","title":"CPU usage","default":0,"deprecated":false,"example":12.3},"memoryUsage":{"type":"number","title":"Memory usage","default":0,"deprecated":false,"example":12.3},"swapUsage":{"type":"number","title":"Swap usage","default":0,"deprecated":false,"example":12.3},"uptimeSeconds":{"type":"number","title":"Uptime","default":0,"deprecated":false,"example":123456},"runtimeSeconds":{"type":"number","title":"Runtime","default":0,"deprecated":false,"example":123456},"dbSizeShared":{"type":"integer","title":"Shared database size","default":0,"deprecated":false,"example":123456},"dbSizeTotal":{"type":"integer","title":"Total database size","default":0,"deprecated":false,"example":123456},"dbAvailableConnections":{"type":"integer","title":"Available database connections","default":0,"deprecated":false,"example":123456},"redisSizeTotal":{"type":"integer","title":"Total redis size","default":0,"deprecated":false,"example":123456},"storageUtilizationTotal":{"type":"integer","title":"Total storage utilization","default":0,"deprecated":false,"example":123456}},"type":"object","title":"SystemMetricsData","description":"Base API model."},"Tag":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","disabled":false},"original_name":{"type":"string","title":"Original name","disabled":false,"scope":[]},"color":{"type":"string","title":"Color","default":"#cacaca","example":"#3498db","disabled":false,"widget":"color"}},"type":"object","required":["name"],"title":"Tag"},"TakeResponseModel":{"properties":{"eventId":{"type":"string","title":"Event ID","deprecated":false,"example":"aae4b3d4-7b7b-4b7b-8b7b-7b7b7b7b7b7b"},"actionIdentifier":{"type":"string","title":"Action Identifier","deprecated":false,"example":"launch-maya"},"args":{"items":{"type":"string"},"type":"array","title":"Action Arguments","default":[],"deprecated":false,"example":["-file","path/to/file.ma"]},"context":{"allOf":[{"$ref":"#/components/schemas/ActionContext"}],"title":"Action Context","deprecated":false},"addonName":{"type":"string","title":"Addon Name","deprecated":false,"example":"maya"},"addonVersion":{"type":"string","title":"Addon Version","deprecated":false,"example":"1.5.6"},"variant":{"type":"string","title":"Action Variant","deprecated":false,"example":"production"},"userName":{"type":"string","title":"User Name","description":"The user who initiated the action","deprecated":false,"example":"john.doe"}},"type":"object","required":["eventId","actionIdentifier","context","addonName","addonVersion","variant","userName"],"title":"TakeResponseModel","description":"Base API model."},"TaskAttribModel":{"properties":{"priority":{"type":"string","enum":["urgent","high","normal","low"],"title":"Priority","_attrib_enum":true},"fps":{"type":"number","title":"FPS","description":"Frame rate","example":25},"resolutionWidth":{"type":"integer","exclusiveMaximum":50000.0,"title":"Width","description":"Horizontal resolution","example":1920},"resolutionHeight":{"type":"integer","exclusiveMaximum":50000.0,"title":"Height","description":"Vertical resolution","example":1080},"pixelAspect":{"type":"number","title":"Pixel aspect","example":1.0},"clipIn":{"type":"integer","title":"Clip In","example":1},"clipOut":{"type":"integer","title":"Clip Out","example":1},"frameStart":{"type":"integer","title":"Start frame","example":1001},"frameEnd":{"type":"integer","title":"End frame"},"handleStart":{"type":"integer","title":"Handle start"},"handleEnd":{"type":"integer","title":"Handle end"},"startDate":{"type":"string","format":"date-time","title":"Start date","description":"Date and time when the project or task or asset was started","example":"2021-01-01T00:00:00+00:00"},"endDate":{"type":"string","format":"date-time","title":"End date","description":"Deadline date and time","example":"2021-01-01T00:00:00+00:00"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"TaskAttribModel"},"TaskModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Task ID","description":"Unique identifier of the {entity_name}","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Folder ID","example":"modeling"},"label":{"type":"string","pattern":"^[^';]*$","title":"Task label","example":"Modeling of a model"},"taskType":{"type":"string","title":"Task type","example":"Modeling"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"assignees":{"items":{"type":"string"},"type":"array","title":"Assignees","description":"List of users assigned to the task","example":["john_doe","jane_doe"]},"folderId":{"type":"string","pattern":"^[0-f]{32}$","title":"Folder ID","description":"Folder ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"path":{"type":"string","title":"Path","example":"/assets/characters/xenomorph/modeling"},"attrib":{"allOf":[{"$ref":"#/components/schemas/TaskAttribModel"}],"title":"Task attributes"},"data":{"type":"object","title":"Task auxiliary data"},"active":{"type":"boolean","title":"Task active","description":"Whether the task is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"status":{"type":"string","title":"Task status","description":"Status of the task","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Task tags","description":"Tags assigned to the the task","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the task","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the task","example":"Homer"},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["name","taskType"],"title":"TaskModel"},"TaskPatchModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Folder ID","example":"modeling"},"label":{"type":"string","pattern":"^[^';]*$","title":"Task label","example":"Modeling of a model"},"taskType":{"type":"string","title":"Task type","example":"Modeling"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"assignees":{"items":{"type":"string"},"type":"array","title":"Assignees","description":"List of users assigned to the task","example":["john_doe","jane_doe"]},"folderId":{"type":"string","pattern":"^[0-f]{32}$","title":"Folder ID","description":"Folder ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"status":{"type":"string","title":"Task status","description":"Status of the task","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Task tags","description":"Tags assigned to the the task","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the task","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the task","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/TaskAttribModel"}],"title":"Task attributes"},"data":{"type":"object","title":"Task auxiliary data"},"active":{"type":"boolean","title":"Task active","description":"Whether the task is active","default":true}},"type":"object","title":"TaskPatchModel"},"TaskPostModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Entity ID","description":"Explicitly set the ID of the entity","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Folder ID","example":"modeling"},"label":{"type":"string","pattern":"^[^';]*$","title":"Task label","example":"Modeling of a model"},"taskType":{"type":"string","title":"Task type","example":"Modeling"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"assignees":{"items":{"type":"string"},"type":"array","title":"Assignees","description":"List of users assigned to the task","example":["john_doe","jane_doe"]},"folderId":{"type":"string","pattern":"^[0-f]{32}$","title":"Folder ID","description":"Folder ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"status":{"type":"string","title":"Task status","description":"Status of the task","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Task tags","description":"Tags assigned to the the task","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the task","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the task","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/TaskAttribModel"}],"title":"Task attributes"},"data":{"type":"object","title":"Task auxiliary data"},"active":{"type":"boolean","title":"Task active","description":"Whether the task is active","default":true}},"type":"object","required":["name","taskType"],"title":"TaskPostModel"},"TaskProgressSettings":{"properties":{"filter":{"$ref":"#/components/schemas/QueryFilter"},"sliceType":{"type":"string","title":"Slicetype"},"columns":{"items":{"$ref":"#/components/schemas/ColumnItemModel"},"type":"array","title":"List of columns","example":[{"name":"name","pinned":true,"width":120},{"name":"status","pinned":true,"width":120},{"name":"assignees","width":120},{"name":"attrib.priority","width":120}]}},"type":"object","title":"TaskProgressSettings","description":"Base API model."},"TaskProgressViewModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"scope":{"type":"string","enum":["project","studio"],"title":"View scope","description":"Determines whether the view is only available for the given project or for all projects (studio).","example":"project"},"owner":{"type":"string","title":"View owner","description":"Name of the user who created the view. Owners have full control over the view, ","example":"steve"},"visibility":{"type":"string","enum":["public","private"],"title":"View visibility","description":"Visibility of the view. Public views are visible to all users, private views are only visible to the owner."},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project "},"position":{"type":"integer","title":"Position"},"accessLevel":{"type":"integer","title":"Accesslevel"},"settings":{"$ref":"#/components/schemas/TaskProgressSettings"},"access":{"type":"object","title":"Access"},"viewType":{"type":"string","enum":["taskProgress"],"title":"Viewtype","default":"taskProgress"}},"type":"object","required":["label","scope","owner","visibility","working","position","accessLevel","settings","access"],"title":"TaskProgressViewModel","description":"Task progress view model."},"TaskProgressViewPatchModel":{"properties":{"label":{"type":"string","title":"Label"},"owner":{"type":"string","title":"Owner"},"settings":{"$ref":"#/components/schemas/TaskProgressSettings"},"viewType":{"type":"string","enum":["taskProgress"],"title":"Viewtype","default":"taskProgress"}},"type":"object","title":"TaskProgressViewPatchModel","description":"Task progress view post model."},"TaskProgressViewPostModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project ","default":true},"settings":{"$ref":"#/components/schemas/TaskProgressSettings"},"viewType":{"type":"string","enum":["taskProgress"],"title":"Viewtype","default":"taskProgress"}},"type":"object","required":["label","settings"],"title":"TaskProgressViewPostModel","description":"Task progress view post model."},"TaskSuggestionItem":{"properties":{"createdAt":{"type":"string","format":"date-time","title":"Creation Date","description":"The date and time when the suggested entity was created","deprecated":false,"example":"2023-01-01T12:00:00Z"},"relevance":{"type":"number","title":"Relevance Score","description":"The relevance score of the suggestion","deprecated":false,"example":0.85},"id":{"type":"string","title":"Id","deprecated":false,"example":"af3e4b3e-1b1b-4b3b-8b3b-3b3b3b3b3b3b"},"taskType":{"type":"string","title":"Tasktype","deprecated":false,"example":"Modeling"},"name":{"type":"string","title":"Name","deprecated":false,"example":"modeling"},"label":{"type":"string","title":"Label","deprecated":false},"thumbnailId":{"type":"string","title":"Thumbnailid","deprecated":false},"parent":{"allOf":[{"$ref":"#/components/schemas/FolderSuggestionItem"}],"title":"Parent","deprecated":false}},"type":"object","required":["id","taskType","name"],"title":"TaskSuggestionItem","description":"Base API model."},"TaskType":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","disabled":false},"original_name":{"type":"string","title":"Original name","disabled":false,"scope":[]},"shortName":{"type":"string","title":"Short name","default":"","disabled":false},"color":{"type":"string","title":"Color","default":"#cccccc","disabled":false,"widget":"color"},"icon":{"type":"string","title":"Icon","default":"task_alt","disabled":false,"widget":"icon"}},"type":"object","required":["name"],"title":"TaskType"},"TasksFoldersQuery":{"properties":{"filter":{"allOf":[{"$ref":"#/components/schemas/QueryFilter"}],"title":"Filter","description":"Filter object used to resolve the tasks","deprecated":false},"search":{"type":"string","title":"Text search","description":"'fulltext' search used to resolve the tasks","deprecated":false}},"type":"object","title":"TasksFoldersQuery","description":"Base API model."},"TasksFoldersResponse":{"properties":{"folderIds":{"items":{"type":"string"},"type":"array","title":"Folderids","description":"List of folder ids containing tasks matching the query","deprecated":false,"example":["11111111-1111-1111-1111-111111111111","22222222-2222-2222-2222-222222222222"]}},"type":"object","title":"TasksFoldersResponse","description":"Base API model."},"TeamListItemModel":{"properties":{"name":{"type":"string","maxLength":64,"minLength":2,"title":"Name","description":"Team name","deprecated":false},"memberCount":{"type":"integer","title":"Membercount","description":"Number of members in the team","deprecated":false},"members":{"items":{"$ref":"#/components/schemas/TeamMemberModel"},"type":"array","title":"Members","description":"Team members","deprecated":false},"leaders":{"items":{"$ref":"#/components/schemas/TeamMemberModel"},"type":"array","title":"Leaders","description":"Team leaders","deprecated":false}},"type":"object","required":["name","memberCount"],"title":"TeamListItemModel","description":"Base API model."},"TeamMemberModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User's name","deprecated":false},"leader":{"type":"boolean","title":"Is user a leader","default":false,"deprecated":false},"roles":{"items":{"type":"string"},"type":"array","title":"User's role","deprecated":false}},"type":"object","required":["name"],"title":"TeamMemberModel","description":"Base API model."},"TeamModel":{"properties":{"name":{"type":"string","maxLength":64,"minLength":2,"title":"Name","description":"Team name","deprecated":false},"members":{"items":{"$ref":"#/components/schemas/TeamMemberModel"},"type":"array","title":"Members","description":"Team members","deprecated":false}},"type":"object","required":["name"],"title":"TeamModel","description":"Base API model."},"TeamPutModel":{"properties":{"members":{"items":{"$ref":"#/components/schemas/TeamMemberModel"},"type":"array","title":"Team members","deprecated":false}},"type":"object","required":["members"],"title":"TeamPutModel","description":"Base API model."},"Templates":{"properties":{"version_padding":{"type":"integer","exclusiveMinimum":0.0,"title":"Version padding","default":3,"disabled":false},"version":{"type":"string","title":"Version template","default":"v{version:0>{@version_padding}}","disabled":false},"frame_padding":{"type":"integer","exclusiveMinimum":0.0,"title":"Frame padding","default":4,"disabled":false},"frame":{"type":"string","title":"Frame template","default":"{frame:0>{@frame_padding}}","disabled":false},"work":{"items":{"$ref":"#/components/schemas/WorkTemplate"},"type":"array","title":"Work","disabled":false},"publish":{"items":{"$ref":"#/components/schemas/PublishTemplate"},"type":"array","title":"Publish","disabled":false},"hero":{"items":{"$ref":"#/components/schemas/HeroTemplate"},"type":"array","title":"Hero","disabled":false},"delivery":{"items":{"$ref":"#/components/schemas/DeliveryTemplate"},"type":"array","title":"Delivery","disabled":false},"staging":{"items":{"$ref":"#/components/schemas/StagingDirectory"},"type":"array","title":"Staging directories","disabled":false},"others":{"items":{"$ref":"#/components/schemas/CustomTemplate"},"type":"array","title":"Others","disabled":false}},"type":"object","title":"Templates"},"TrafficStat":{"properties":{"date":{"type":"string","title":"Date"},"service":{"type":"string","title":"Service"},"ingress":{"type":"integer","title":"Ingress"},"egress":{"type":"integer","title":"Egress"}},"type":"object","required":["date","service","ingress","egress"],"title":"TrafficStat","description":"Base API model."},"UpdateEventRequestModel":{"properties":{"sender":{"type":"string","title":"Sender","description":"Identifier of the process that sent the event.","deprecated":false,"example":"service-processor-01"},"projectName":{"type":"string","title":"Project name","description":"Deprecated use 'project' instead","deprecated":true},"project":{"type":"string","pattern":"^[a-zA-Z0-9_]([a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9_])?$","title":"Project name","description":"Name of the project if the event belong to one.","deprecated":false,"example":"MyProject"},"user":{"type":"string","title":"User name","deprecated":false,"example":"admin"},"status":{"type":"string","enum":["pending","in_progress","finished","failed","aborted","restarted"],"title":"Status","deprecated":false,"example":"in_progress"},"description":{"type":"string","title":"Description","description":"Short, human-readable description of the event and its state","deprecated":false,"example":"Importing file 3 of 10"},"summary":{"type":"object","title":"Summary","deprecated":false,"example":{}},"payload":{"type":"object","title":"Payload","deprecated":false,"example":{}},"progress":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Progress","description":"Percentage of progress. Transmitted to clients in real time.","deprecated":false,"example":42},"retries":{"type":"integer","title":"Retries","description":"Force number of attempted retries","deprecated":false,"example":1}},"type":"object","title":"UpdateEventRequestModel","description":"Base API model."},"UpdateReviewablesRequest":{"properties":{"label":{"type":"string","title":"Reviewable Label","deprecated":false,"example":"Shoulder detail"}},"type":"object","title":"UpdateReviewablesRequest","description":"Base API model."},"UriResponseItem":{"properties":{"id":{"type":"string","title":"Entity ID","deprecated":false},"uri":{"type":"string","title":"Entity URI","deprecated":false}},"type":"object","required":["id","uri"],"title":"UriResponseItem","description":"Base API model."},"UserAttribModel":{"properties":{"fullName":{"type":"string","title":"Full name","example":"Jane Doe"},"email":{"type":"string","title":"E-Mail","example":"jane.doe@ayon.cloud"},"avatarUrl":{"type":"string","title":"Avatar URL"},"developerMode":{"type":"boolean","title":"Developer mode","example":true}},"type":"object","title":"UserAttribModel"},"UserCounts":{"properties":{"total":{"type":"integer","title":"Total users","default":0,"deprecated":false,"example":69},"active":{"type":"integer","title":"Active users","default":0,"deprecated":false,"example":42},"admins":{"type":"integer","title":"Admin users","default":0,"deprecated":false,"example":1},"managers":{"type":"integer","title":"Manager users","default":0,"deprecated":false,"example":8},"services":{"type":"integer","title":"Service users","default":0,"deprecated":false,"example":1},"licensesTotal":{"type":"integer","title":"Total licenses","default":0,"deprecated":false,"example":42},"licensesUsed":{"type":"integer","title":"Used licenses","default":0,"deprecated":false,"example":42}},"type":"object","title":"UserCounts","description":"Base API model."},"UserModel":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"User name","description":"Name is an unique id of the {entity_name}","example":"awesome_user"},"uiExposureLevel":{"type":"integer","title":"UI Exposure Level","example":100},"attrib":{"allOf":[{"$ref":"#/components/schemas/UserAttribModel"}],"title":"User attributes"},"data":{"type":"object","title":"User auxiliary data"},"active":{"type":"boolean","title":"User active","description":"Whether the user is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["name"],"title":"UserModel"},"UserPatchModel":{"properties":{"attrib":{"allOf":[{"$ref":"#/components/schemas/UserAttribModel"}],"title":"User attributes"},"data":{"type":"object","title":"User auxiliary data"},"active":{"type":"boolean","title":"User active","description":"Whether the user is active","default":true}},"type":"object","title":"UserPatchModel"},"UserPermissionsModel":{"properties":{"user_level":{"type":"string","enum":["admin","manager","user"],"title":"User Level","default":"user","example":"user","disabled":false},"studio":{"allOf":[{"$ref":"#/components/schemas/StudioManagementPermissions"}],"title":"Studio Permissions","description":"Permissions for the studio","disabled":false},"projects":{"additionalProperties":{"$ref":"#/components/schemas/Permissions"},"type":"object","title":"Projects Permissions","description":"Permissions for individual projects","example":{"project01":{"studio":{"create_projects":false,"list_all_users":false},"project":{"anatomy":0,"access":0,"settings":0},"create":{"enabled":false,"access_list":[]},"read":{"enabled":false,"access_list":[]},"update":{"enabled":false,"access_list":[]},"publish":{"enabled":false,"access_list":[]},"delete":{"enabled":false,"access_list":[]},"attrib_read":{"enabled":false,"attributes":[]},"attrib_write":{"enabled":false,"attributes":[],"fields":[]},"activities":{"enabled":false,"activities":[]},"actions":{"enabled":false,"actions":[]},"links":{"enabled":false,"link_types":[]},"endpoints":{"enabled":false,"endpoints":[]},"advanced":{"show_sibling_tasks":true}},"project02":{"studio":{"create_projects":false,"list_all_users":false},"project":{"anatomy":0,"access":0,"settings":0},"create":{"enabled":false,"access_list":[]},"read":{"enabled":false,"access_list":[]},"update":{"enabled":false,"access_list":[]},"publish":{"enabled":false,"access_list":[]},"delete":{"enabled":false,"access_list":[]},"attrib_read":{"enabled":false,"attributes":[]},"attrib_write":{"enabled":false,"attributes":[],"fields":[]},"activities":{"enabled":false,"activities":[]},"actions":{"enabled":false,"actions":[]},"links":{"enabled":false,"link_types":[]},"endpoints":{"enabled":false,"endpoints":[]},"advanced":{"show_sibling_tasks":true}}},"disabled":false}},"type":"object","title":"UserPermissionsModel"},"UserPoolModel":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"type":{"type":"string","enum":["fixed","metered"],"title":"Type"},"valid":{"type":"boolean","title":"Valid"},"note":{"type":"string","title":"Note"},"exp":{"type":"integer","title":"Exp"},"max":{"type":"integer","title":"Max"},"used":{"type":"integer","title":"Used"},"meta":{"type":"object","title":"Meta"}},"type":"object","required":["id","label","type","valid","note","exp","max","used"],"title":"UserPoolModel","description":"Base API model."},"UserSessionModel":{"properties":{"token":{"type":"string","title":"Token"},"isService":{"type":"boolean","title":"Isservice"},"lastUsed":{"type":"number","title":"Lastused"},"clientInfo":{"$ref":"#/components/schemas/ClientInfo"}},"type":"object","required":["token","isService","lastUsed"],"title":"UserSessionModel","description":"Base API model."},"UserSessionsResponseModel":{"properties":{"sessions":{"items":{"$ref":"#/components/schemas/UserSessionModel"},"type":"array","title":"Sessions"}},"type":"object","required":["sessions"],"title":"UserSessionsResponseModel","description":"Base API model."},"UserStat":{"properties":{"date":{"type":"string","title":"Date"},"users":{"additionalProperties":{"type":"string"},"type":"object","title":"Users"}},"type":"object","required":["date","users"],"title":"UserStat","description":"Base API model."},"UserSuggestionItem":{"properties":{"createdAt":{"type":"string","format":"date-time","title":"Creation Date","description":"The date and time when the suggested entity was created","deprecated":false,"example":"2023-01-01T12:00:00Z"},"relevance":{"type":"number","title":"Relevance Score","description":"The relevance score of the suggestion","deprecated":false,"example":0.85},"name":{"type":"string","title":"Name","deprecated":false,"example":"john"},"fullName":{"type":"string","title":"Fullname","deprecated":false,"example":"John Doe"}},"type":"object","required":["name"],"title":"UserSuggestionItem","description":"Base API model."},"UserVerificationResponse":{"properties":{"available":{"type":"boolean","title":"Available","default":false},"detail":{"type":"string","title":"Detail"},"data":{"type":"object","title":"Data"}},"type":"object","title":"UserVerificationResponse","description":"Base API model."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VariantCopyRequest":{"properties":{"addonName":{"type":"string","title":"Addonname","description":"Addon name","deprecated":false},"copyFrom":{"type":"string","enum":["production","staging"],"title":"Copyfrom","description":"Source variant","deprecated":false,"example":"production"},"copyTo":{"type":"string","enum":["production","staging"],"title":"Copyto","description":"Destination variant","deprecated":false,"example":"staging"}},"type":"object","required":["addonName","copyFrom","copyTo"],"title":"VariantCopyRequest","description":"Base API model."},"VersionAttribModel":{"properties":{"fps":{"type":"number","title":"FPS","description":"Frame rate","example":25},"resolutionWidth":{"type":"integer","exclusiveMaximum":50000.0,"title":"Width","description":"Horizontal resolution","example":1920},"resolutionHeight":{"type":"integer","exclusiveMaximum":50000.0,"title":"Height","description":"Vertical resolution","example":1080},"pixelAspect":{"type":"number","title":"Pixel aspect","example":1.0},"clipIn":{"type":"integer","title":"Clip In","example":1},"clipOut":{"type":"integer","title":"Clip Out","example":1},"frameStart":{"type":"integer","title":"Start frame","example":1001},"frameEnd":{"type":"integer","title":"End frame"},"handleStart":{"type":"integer","title":"Handle start"},"handleEnd":{"type":"integer","title":"Handle end"},"intent":{"type":"string","title":"Intent"},"machine":{"type":"string","title":"Machine"},"source":{"type":"string","title":"Source"},"comment":{"type":"string","title":"Comment"},"site":{"type":"string","title":"Site","example":"workstation42"},"families":{"items":{"type":"string"},"type":"array","title":"Families"},"colorSpace":{"type":"string","title":"Color space","example":"rec709"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"VersionAttribModel"},"VersionInfo":{"properties":{"hasSettings":{"type":"boolean","title":"Hassettings","default":false,"deprecated":false},"hasSiteSettings":{"type":"boolean","title":"Hassitesettings","default":false,"deprecated":false},"frontendScopes":{"additionalProperties":{"$ref":"#/components/schemas/FrontendScopeSettings"},"type":"object","title":"Frontendscopes","deprecated":false},"clientPyproject":{"type":"object","title":"Clientpyproject","deprecated":false},"clientSourceInfo":{"items":{"anyOf":[{"$ref":"#/components/schemas/FilesystemSourceInfo"},{"$ref":"#/components/schemas/ServerSourceInfo"},{"$ref":"#/components/schemas/HttpSourceInfo"}]},"type":"array","title":"Clientsourceinfo","deprecated":false},"services":{"type":"object","title":"Services","deprecated":false},"isBroken":{"type":"boolean","title":"Isbroken","default":false,"deprecated":false},"reason":{"additionalProperties":{"type":"string"},"type":"object","title":"Reason","deprecated":false},"projectCanOverrideAddonVersion":{"type":"boolean","title":"Projectcanoverrideaddonversion","default":false,"deprecated":false}},"type":"object","title":"VersionInfo","description":"Base API model."},"VersionModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Version ID","description":"Unique identifier of the {entity_name}","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"version":{"type":"integer","title":"Version","description":"Version number","example":1},"productId":{"type":"string","pattern":"^[0-f]{32}$","title":"Product ID","description":"ID of the parent product","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"taskId":{"type":"string","pattern":"^[0-f]{32}$","title":"Task ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"author":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"Author","example":"john_doe"},"path":{"type":"string","title":"Path","example":"/assets/characters/xenomorph/modelMain/v003"},"attrib":{"allOf":[{"$ref":"#/components/schemas/VersionAttribModel"}],"title":"Version attributes"},"data":{"type":"object","title":"Version auxiliary data"},"active":{"type":"boolean","title":"Version active","description":"Whether the version is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"status":{"type":"string","title":"Version status","description":"Status of the version","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Version tags","description":"Tags assigned to the the version","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the version","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the version","example":"Homer"},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["version","productId"],"title":"VersionModel"},"VersionPatchModel":{"properties":{"version":{"type":"integer","title":"Version","description":"Version number","example":1},"productId":{"type":"string","pattern":"^[0-f]{32}$","title":"Product ID","description":"ID of the parent product","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"taskId":{"type":"string","pattern":"^[0-f]{32}$","title":"Task ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"author":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"Author","example":"john_doe"},"status":{"type":"string","title":"Version status","description":"Status of the version","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Version tags","description":"Tags assigned to the the version","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the version","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the version","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/VersionAttribModel"}],"title":"Version attributes"},"data":{"type":"object","title":"Version auxiliary data"},"active":{"type":"boolean","title":"Version active","description":"Whether the version is active","default":true}},"type":"object","title":"VersionPatchModel"},"VersionPostModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Entity ID","description":"Explicitly set the ID of the entity","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"version":{"type":"integer","title":"Version","description":"Version number","example":1},"productId":{"type":"string","pattern":"^[0-f]{32}$","title":"Product ID","description":"ID of the parent product","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"taskId":{"type":"string","pattern":"^[0-f]{32}$","title":"Task ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"author":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-]*[a-zA-Z0-9]$","title":"Author","example":"john_doe"},"status":{"type":"string","title":"Version status","description":"Status of the version","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Version tags","description":"Tags assigned to the the version","example":["flabadob","blip","blop","blup"]},"createdBy":{"type":"string","title":"Created by","description":"Who created the version","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the version","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/VersionAttribModel"}],"title":"Version attributes"},"data":{"type":"object","title":"Version auxiliary data"},"active":{"type":"boolean","title":"Version active","description":"Whether the version is active","default":true}},"type":"object","required":["version","productId"],"title":"VersionPostModel"},"VersionReviewablesModel":{"properties":{"id":{"type":"string","title":"Version ID","deprecated":false,"example":"1a3b34ce-1b2c-4d5e-6f7a-8b9c0d1e2f3a"},"name":{"type":"string","title":"Version Name","deprecated":false,"example":"v001"},"version":{"type":"string","title":"Version Number","deprecated":false,"example":1},"status":{"type":"string","title":"Version Status","deprecated":false,"example":"In Review"},"productId":{"type":"string","title":"Product ID","deprecated":false,"example":"1a3b34ce-1b2c-4d5e-6f7a-8b9c0d1e2f3a"},"productName":{"type":"string","title":"Product Name","deprecated":false,"example":"Product Name"},"productType":{"type":"string","title":"Product Type","deprecated":false,"example":"Product Type"},"attrib":{"type":"object","title":"Version attributes","deprecated":false},"reviewables":{"items":{"$ref":"#/components/schemas/ReviewableModel"},"type":"array","title":"Reviewables","description":"List of available reviewables","deprecated":false}},"type":"object","required":["id","name","version","status","productId","productName","productType"],"title":"VersionReviewablesModel","description":"Base API model."},"VersionSuggestionItem":{"properties":{"createdAt":{"type":"string","format":"date-time","title":"Creation Date","description":"The date and time when the suggested entity was created","deprecated":false,"example":"2023-01-01T12:00:00Z"},"relevance":{"type":"number","title":"Relevance Score","description":"The relevance score of the suggestion","deprecated":false,"example":0.85},"id":{"type":"string","title":"Id","deprecated":false,"example":"af3e4b3e-1b1b-4b3b-8b3b-3b3b3b3b3b3b"},"version":{"type":"integer","title":"Version","deprecated":false,"example":1},"parent":{"allOf":[{"$ref":"#/components/schemas/ProductSuggestionItem"}],"title":"Parent","deprecated":false},"name":{"type":"string","title":"Name","deprecated":false}},"type":"object","required":["id","version"],"title":"VersionSuggestionItem","description":"Base API model."},"VersionsSettings":{"properties":{"showProducts":{"type":"boolean","title":"Showproducts","default":false},"rowHeight":{"type":"integer","title":"Rowheight"},"showGrid":{"type":"boolean","title":"Showgrid","default":true},"gridHeight":{"type":"integer","title":"Gridheight"},"featuredVersionOrder":{"items":{"type":"string"},"type":"array","title":"Featuredversionorder"},"slicerType":{"type":"string","title":"Slicertype"},"groupBy":{"type":"string","title":"Groupby"},"groupSortByDesc":{"type":"boolean","title":"Groupsortbydesc","default":false},"showEmptyGroups":{"type":"boolean","title":"Showemptygroups","default":false},"sortBy":{"type":"string","title":"Sortby"},"sortDesc":{"type":"boolean","title":"Sortdesc","default":false},"filter":{"$ref":"#/components/schemas/QueryFilter"},"columns":{"items":{"$ref":"#/components/schemas/ColumnItemModel"},"type":"array","title":"List of columns","example":[{"name":"name","pinned":true,"width":120},{"name":"status","pinned":true,"width":120},{"name":"assignees","width":120},{"name":"attrib.priority","width":120}]}},"type":"object","title":"VersionsSettings","description":"Base API model."},"VersionsViewModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"scope":{"type":"string","enum":["project","studio"],"title":"View scope","description":"Determines whether the view is only available for the given project or for all projects (studio).","example":"project"},"owner":{"type":"string","title":"View owner","description":"Name of the user who created the view. Owners have full control over the view, ","example":"steve"},"visibility":{"type":"string","enum":["public","private"],"title":"View visibility","description":"Visibility of the view. Public views are visible to all users, private views are only visible to the owner."},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project "},"position":{"type":"integer","title":"Position"},"accessLevel":{"type":"integer","title":"Accesslevel"},"settings":{"$ref":"#/components/schemas/VersionsSettings"},"access":{"type":"object","title":"Access"},"viewType":{"type":"string","enum":["versions"],"title":"Viewtype","default":"versions"}},"type":"object","required":["label","scope","owner","visibility","working","position","accessLevel","settings","access"],"title":"VersionsViewModel","description":"Versions view model."},"VersionsViewPatchModel":{"properties":{"label":{"type":"string","title":"Label"},"owner":{"type":"string","title":"Owner"},"settings":{"$ref":"#/components/schemas/VersionsSettings"},"viewType":{"type":"string","enum":["versions"],"title":"Viewtype","default":"versions"}},"type":"object","title":"VersionsViewPatchModel","description":"Versions view post model."},"VersionsViewPostModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project ","default":true},"settings":{"$ref":"#/components/schemas/VersionsSettings"},"viewType":{"type":"string","enum":["versions"],"title":"Viewtype","default":"versions"}},"type":"object","required":["label","settings"],"title":"VersionsViewPostModel","description":"Versions view post model."},"ViewListItemModel":{"properties":{"id":{"type":"string","title":"View ID","description":"Unique identifier for the view within the given scope."},"label":{"type":"string","title":"View label","description":"Human-readable name of the view.","example":"To review"},"scope":{"type":"string","enum":["project","studio"],"title":"View scope","description":"Determines whether the view is only available for the given project or for all projects (studio).","example":"project"},"owner":{"type":"string","title":"View owner","description":"Name of the user who created the view. Owners have full control over the view, ","example":"steve"},"visibility":{"type":"string","enum":["public","private"],"title":"View visibility","description":"Visibility of the view. Public views are visible to all users, private views are only visible to the owner."},"working":{"type":"boolean","title":"Working view","description":"Working view is a special type of the view that automatically stores the current view settings without explicitly saving them. Working views are always private and scoped to the project "},"position":{"type":"integer","title":"Position"},"accessLevel":{"type":"integer","title":"Accesslevel"}},"type":"object","required":["label","scope","owner","visibility","working","position","accessLevel"],"title":"ViewListItemModel","description":"View list item model."},"ViewListModel":{"properties":{"views":{"items":{"$ref":"#/components/schemas/ViewListItemModel"},"type":"array","title":"List of views"}},"type":"object","required":["views"],"title":"ViewListModel","description":"Base API model."},"WatchersModel":{"properties":{"watchers":{"items":{"type":"string"},"type":"array","title":"Watchers","deprecated":false,"example":["user1","user2"]}},"type":"object","required":["watchers"],"title":"WatchersModel","description":"Base API model."},"WorkTemplate":{"properties":{"name":{"type":"string","title":"Name","disabled":false},"directory":{"type":"string","title":"Directory template","disabled":false},"file":{"type":"string","title":"File name template","disabled":false}},"type":"object","required":["name","directory","file"],"title":"WorkTemplate"},"WorkfileAttribModel":{"properties":{"extension":{"type":"string","title":"File extension"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"WorkfileAttribModel"},"WorkfileModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Workfile ID","description":"Unique identifier of the {entity_name}","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"path":{"type":"string","title":"Path","description":"Path to the workfile","example":"{root['work']}/Project/workfiles/ma/modelMain_v001.ma"},"taskId":{"type":"string","pattern":"^[0-f]{32}$","title":"Task ID","description":"ID of the parent task","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"createdBy":{"type":"string","title":"Created by","description":"Who created the workfile","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the workfile","example":"Homer"},"attrib":{"allOf":[{"$ref":"#/components/schemas/WorkfileAttribModel"}],"title":"Workfile attributes"},"data":{"type":"object","title":"Workfile auxiliary data"},"active":{"type":"boolean","title":"Workfile active","description":"Whether the workfile is active","default":true},"ownAttrib":{"items":{"type":"string"},"type":"array","title":"Own attributes","example":["frameStart","frameEnd"]},"status":{"type":"string","title":"Workfile status","description":"Status of the workfile","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Workfile tags","description":"Tags assigned to the the workfile","example":["flabadob","blip","blop","blup"]},"createdAt":{"type":"string","format":"date-time","title":"Created at","description":"Time of creation","example":"2023-01-01T00:00:00+00:00"},"updatedAt":{"type":"string","format":"date-time","title":"Updated at","description":"Time of last update","example":"2023-01-01T00:00:00+00:00"}},"type":"object","required":["path","taskId"],"title":"WorkfileModel"},"WorkfilePatchModel":{"properties":{"path":{"type":"string","title":"Path","description":"Path to the workfile","example":"{root['work']}/Project/workfiles/ma/modelMain_v001.ma"},"taskId":{"type":"string","pattern":"^[0-f]{32}$","title":"Task ID","description":"ID of the parent task","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"createdBy":{"type":"string","title":"Created by","description":"Who created the workfile","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the workfile","example":"Homer"},"status":{"type":"string","title":"Workfile status","description":"Status of the workfile","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Workfile tags","description":"Tags assigned to the the workfile","example":["flabadob","blip","blop","blup"]},"attrib":{"allOf":[{"$ref":"#/components/schemas/WorkfileAttribModel"}],"title":"Workfile attributes"},"data":{"type":"object","title":"Workfile auxiliary data"},"active":{"type":"boolean","title":"Workfile active","description":"Whether the workfile is active","default":true}},"type":"object","title":"WorkfilePatchModel"},"WorkfilePostModel":{"properties":{"id":{"type":"string","pattern":"^[0-f]{32}$","title":"Entity ID","description":"Explicitly set the ID of the entity","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"path":{"type":"string","title":"Path","description":"Path to the workfile","example":"{root['work']}/Project/workfiles/ma/modelMain_v001.ma"},"taskId":{"type":"string","pattern":"^[0-f]{32}$","title":"Task ID","description":"ID of the parent task","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"thumbnailId":{"type":"string","pattern":"^[0-f]{32}$","title":"Thumbnail ID","example":"c10d5bc73dcab7da4cba0f3e0b3c0aea"},"createdBy":{"type":"string","title":"Created by","description":"Who created the workfile","example":"Moe"},"updatedBy":{"type":"string","title":"Updated by","description":"Who last updated the workfile","example":"Homer"},"status":{"type":"string","title":"Workfile status","description":"Status of the workfile","example":"In progress"},"tags":{"items":{"type":"string"},"type":"array","title":"Workfile tags","description":"Tags assigned to the the workfile","example":["flabadob","blip","blop","blup"]},"attrib":{"allOf":[{"$ref":"#/components/schemas/WorkfileAttribModel"}],"title":"Workfile attributes"},"data":{"type":"object","title":"Workfile auxiliary data"},"active":{"type":"boolean","title":"Workfile active","description":"Whether the workfile is active","default":true}},"type":"object","required":["path","taskId"],"title":"WorkfilePostModel"},"YnputCloudInfoModel":{"properties":{"instanceId":{"type":"string","title":"Instanceid","description":"Ynput cloud instance ID","deprecated":false},"instanceName":{"type":"string","title":"Instancename","description":"Name of the instance","deprecated":false,"example":"ayon-staging"},"orgId":{"type":"string","title":"Orgid","description":"Organization ID","deprecated":false},"orgName":{"type":"string","title":"Orgname","description":"Name of the organization","deprecated":false,"example":"Ynput"},"orgTitle":{"type":"string","title":"Orgtitle","description":"Name of the organization","deprecated":true,"example":"Ynput"},"managed":{"type":"boolean","title":"Managed","description":"Is the instance managed by Ynput Cloud?","default":false,"deprecated":false},"collectSaturatedMetrics":{"type":"boolean","title":"Collectsaturatedmetrics","description":"Collect saturated metrics","default":false,"deprecated":false},"subscriptions":{"items":{"$ref":"#/components/schemas/YnputCloudSubscriptionModel"},"type":"array","title":"Subscriptions","description":"List of subscriptions","deprecated":false},"connected":{"type":"boolean","title":"Connected","description":"Is the instance connected to Ynput Cloud?","default":false,"deprecated":false},"offlineMode":{"type":"boolean","title":"Offlinemode","description":"AYON is in offline mode","deprecated":false}},"type":"object","required":["instanceId"],"title":"YnputCloudInfoModel","description":"Base API model."},"YnputCloudSubscriptionModel":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the subscription","deprecated":false},"productType":{"type":"string","title":"Producttype","description":"Type of the subscription","deprecated":false},"trialEnd":{"type":"string","title":"Trialend","description":"End date of the trial","deprecated":false}},"type":"object","required":["name","productType"],"title":"YnputCloudSubscriptionModel","description":"Base API model."},"YnputConnectRequestModel":{"properties":{"key":{"type":"string","title":"Key","description":"Ynput cloud key","deprecated":false}},"type":"object","required":["key"],"title":"YnputConnectRequestModel","description":"Model for the request to set the Ynput Cloud key"},"addons__list_addons__AddonList":{"properties":{"addons":{"items":{"$ref":"#/components/schemas/addons__list_addons__AddonListItem"},"type":"array","title":"Addons","description":"List of available addons","deprecated":false}},"type":"object","required":["addons"],"title":"AddonList","description":"Base API model."},"addons__list_addons__AddonListItem":{"properties":{"name":{"type":"string","title":"Name","description":"Machine friendly name of the addon","deprecated":false},"title":{"type":"string","title":"Title","description":"Human friendly title of the addon","deprecated":false},"versions":{"additionalProperties":{"$ref":"#/components/schemas/VersionInfo"},"type":"object","title":"Versions","description":"List of available versions","deprecated":false},"description":{"type":"string","title":"Description","description":"Addon description","deprecated":false},"productionVersion":{"type":"string","title":"Productionversion","description":"Production version of the addon","deprecated":false},"stagingVersion":{"type":"string","title":"Stagingversion","description":"Staging version of the addon","deprecated":false},"addonType":{"type":"string","enum":["server","pipeline"],"title":"Addontype","description":"Type of the addon","deprecated":false},"system":{"type":"boolean","title":"System","description":"Is the addon a system addon?","default":false,"deprecated":false},"projectCanOverrideAddonVersion":{"type":"boolean","title":"Projectcanoverrideaddonversion","description":"Allow project override","default":false,"deprecated":false}},"type":"object","required":["name","title","versions","description","addonType"],"title":"AddonListItem","description":"Base API model."},"ayon_server__settings__anatomy__ProjectAttribModel":{"properties":{"priority":{"type":"string","enum":["urgent","high","normal","low"],"title":"Priority","default":"normal","_attrib_enum":true},"fps":{"type":"number","title":"FPS","description":"Frame rate","default":25,"example":25},"resolutionWidth":{"type":"integer","exclusiveMaximum":50000.0,"title":"Width","description":"Horizontal resolution","default":1920,"example":1920},"resolutionHeight":{"type":"integer","exclusiveMaximum":50000.0,"title":"Height","description":"Vertical resolution","default":1080,"example":1080},"pixelAspect":{"type":"number","title":"Pixel aspect","default":1.0,"example":1.0},"clipIn":{"type":"integer","title":"Clip In","default":1,"example":1},"clipOut":{"type":"integer","title":"Clip Out","default":1,"example":1},"frameStart":{"type":"integer","title":"Start frame","default":1001,"example":1001},"frameEnd":{"type":"integer","title":"End frame","default":1001},"handleStart":{"type":"integer","title":"Handle start","default":0},"handleEnd":{"type":"integer","title":"Handle end","default":0},"startDate":{"type":"string","format":"date-time","title":"Start date","description":"Date and time when the project or task or asset was started","example":"2021-01-01T00:00:00+00:00"},"endDate":{"type":"string","format":"date-time","title":"End date","description":"Deadline date and time","example":"2021-01-01T00:00:00+00:00"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"ProjectAttribModel"},"market__models__AddonList":{"properties":{"addons":{"items":{"$ref":"#/components/schemas/market__models__AddonListItem"},"type":"array","title":"Addons","deprecated":false}},"type":"object","title":"AddonList","description":"Base API model."},"market__models__AddonListItem":{"properties":{"name":{"type":"string","title":"Addon name","deprecated":false,"example":"maya"},"title":{"type":"string","title":"Addon title","deprecated":false,"example":"Maya"},"description":{"type":"string","title":"Description","description":"Addon description","deprecated":false,"example":"Maya is a 3D computer graphics application"},"orgName":{"type":"string","title":"Organization name","deprecated":false,"example":"ynput-official"},"orgTitle":{"type":"string","title":"Organization title","deprecated":false,"example":"Ynput"},"icon":{"type":"string","title":"Icon URL","deprecated":false,"example":"https://example.com/maya.png"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","deprecated":false},"flags":{"items":{"type":"string"},"type":"array","title":"Flags","deprecated":false},"latestVersion":{"type":"string","title":"Latestversion","description":"Latest version of the addon","deprecated":false,"example":"1.0.0"},"links":{"items":{"$ref":"#/components/schemas/LinkModel"},"type":"array","title":"Links","description":"Links to the addon's homepage and GitHub repository","deprecated":false,"example":[{"type":"github","url":"https://github.com/ynput/ayon-maya"}]},"available":{"type":"boolean","title":"Available","description":"Addon is avaliable for download","default":true,"deprecated":false},"currentProductionVersion":{"type":"string","title":"Current production version","deprecated":false,"example":"1.0.0"},"currentLatestVersion":{"type":"string","title":"Latest installed version","deprecated":false,"example":"1.0.0"},"isOutdated":{"type":"boolean","title":"Is the current version outdated","default":false,"deprecated":false,"example":false}},"type":"object","required":["name","title"],"title":"AddonListItem","description":"Base API model."},"pydantic__main__ProjectAttribModel":{"properties":{"priority":{"type":"string","enum":["urgent","high","normal","low"],"title":"Priority","default":"normal","_attrib_enum":true},"fps":{"type":"number","title":"FPS","description":"Frame rate","default":25,"example":25},"resolutionWidth":{"type":"integer","exclusiveMaximum":50000.0,"title":"Width","description":"Horizontal resolution","default":1920,"example":1920},"resolutionHeight":{"type":"integer","exclusiveMaximum":50000.0,"title":"Height","description":"Vertical resolution","default":1080,"example":1080},"pixelAspect":{"type":"number","title":"Pixel aspect","default":1.0,"example":1.0},"clipIn":{"type":"integer","title":"Clip In","default":1,"example":1},"clipOut":{"type":"integer","title":"Clip Out","default":1,"example":1},"frameStart":{"type":"integer","title":"Start frame","default":1001,"example":1001},"frameEnd":{"type":"integer","title":"End frame","default":1001},"handleStart":{"type":"integer","title":"Handle start","default":0},"handleEnd":{"type":"integer","title":"Handle end","default":0},"startDate":{"type":"string","format":"date-time","title":"Start date","description":"Date and time when the project or task or asset was started","example":"2021-01-01T00:00:00+00:00"},"endDate":{"type":"string","format":"date-time","title":"End date","description":"Deadline date and time","example":"2021-01-01T00:00:00+00:00"},"description":{"type":"string","title":"Description","description":"Textual description of the entity","example":"A very nice entity"}},"type":"object","title":"ProjectAttribModel"}}}}