diff --git a/docs/openapi.json b/docs/openapi.json index 9ed4b8d60a..860d585ad1 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -1 +1 @@ -{"info":{"title":"Kitsu API","description":"\n## Welcome to the Kitsu API specification\n```Version: 0.18.8```\n\nThe Kitsu API allows to store and manage the data of your animation/VFX production. Through it you can link all the tools of your pipeline and make sure they are all synchronized.\n\nAn easy to use Python client to access this API is available:\n[Python Kitsu Client documentation](https://gazu.cg-wire.com/)\n\n## Authentication
\n\n

Before you can use any of the endpoints outline below,\nyou will have to get a JWT token to authorize your requests.\n\nYou can get a authorization token using a (form-encoded) POST request to ```/auth/login```.\nWith curl this would look something like ```curl -X POST /auth/login -d \"email=&password=```.\n\nThe response is a JSON object, specifically you'll need to provide the ```access_token``` for your future requests.\n\nHere is a complete authentication process as an example (again using curl):\n```\n$ curl -X POST /api/auth/login -d \"email=&password=\"'\n{\"login\": true\", \"access_token\": \"eyJ0e...\", ...}\n$ jwt=eyJ0e... # Store the access token for easier use\n$ curl -H \"Authorization: Bearer $jwt\" /api/data/projects\n[{...},\n{...}]\n```\n[OpenAPI definition](/openapi.json)\n","contact":{"name":"CGWire","url":"https://www.cg-wire.com"},"version":"0.18.8","license":{"name":"AGPL 3.0","url":"https://www.gnu.org/licenses/agpl-3.0.en.html"}},"paths":{"/auth/login":{"post":{"summary":"Log in user by creating and registering auth tokens.","description":"Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.","responses":{"200":{"description":"Login successful"},"400":{"description":"Login failed"},"500":{"description":"Database not reachable"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"password","required":true,"type":"string","format":"password","x-example":"mysecretpassword"},{"in":"formData","name":"otp","required":false,"type":"string","format":"password","x-example":123456}],"tags":["Authentication"]}},"/auth/logout":{"get":{"summary":"Log user out by revoking his auth tokens.","description":"Once logged out, current user cannot access the API anymore.","responses":{"200":{"description":"Logout successful"},"500":{"description":"Access token not found"}},"tags":["Authentication"]}},"/auth/authenticated":{"get":{"summary":"Returns information if the user is authenticated else it returns a 401","description":"response.
","responses":{"200":{"description":"User authenticated"},"401":{"description":"Person not found"}},"tags":["Authentication"]}},"/auth/register":{"post":{"summary":"Allow a user to register himself to the service.","responses":{"201":{"description":"Registration successful"},"400":{"description":"Invalid password or email"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password_2","required":true,"type":"string","format":"password"},{"in":"formData","name":"first_name","required":true,"type":"string"},{"in":"formData","name":"last_name","required":true,"type":"string"}],"tags":["Authentication"]}},"/auth/change-password":{"post":{"summary":"Allow the user to change his password.","description":"Prior to modifying the password, it requires to give the current password (to make sure the user changing the password is not someone who stealed the session). The new password requires a confirmation to ensure that the user didn't make a mistake by typing his new password.","responses":{"200":{"description":"Password changed"},"400":{"description":"Invalid password or inactive user"}},"parameters":[{"in":"formData","name":"old_password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password_2","required":true,"type":"string","format":"password"}],"tags":["Authentication"]}},"/auth/reset-password":{"put":{"summary":"Resource to allow a user to change his password when he forgets it.","description":"It uses a classic scheme: a token is sent by email to the user. Then he can change his password.","responses":{"200":{"description":"Password reset"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"token","required":true,"type":"string","format":"JWT token"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password2","required":true,"type":"string","format":"password"}],"tags":["Authentication"]},"post":{"summary":"Resource to allow a user to change his password when he forgets it.","description":"It uses a classic scheme: a token is sent by email to the user. Then he can change his password.","responses":{"200":{"description":"Reset token sent"},"400":{"description":"Email not listed in database"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"}],"tags":["Authentication"]}},"/auth/refresh-token":{"get":{"summary":"Tokens are considered as outdated every two weeks.","description":"This route allows to make their lifetime long before they get outdated.","responses":{"200":{"description":"Access Token"}},"tags":["Authentication"]}},"/auth/totp":{"delete":{"summary":"Resource to allow a user to disable TOTP.","responses":{"200":{"description":"TOTP disabled"},"400":{"description":"TOTP not enabled"}},"tags":["Authentication"]},"put":{"summary":"Resource to allow a user to pre-enable TOTP.","responses":{"200":{"description":"TOTP enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"post":{"summary":"Resource to allow a user to enable TOTP.","responses":{"200":{"description":"TOTP enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/auth/email-otp":{"delete":{"summary":"Resource to allow a user to disable OTP by email.","responses":{"200":{"description":"OTP by email disabled."},"400":{"description":"Invalid password. Wrong or expired token. Inactive user. Wrong 2FA."}},"tags":["Authentication"]},"put":{"summary":"Resource to allow a user to pre-enable OTP by email.","responses":{"200":{"description":"OTP by email enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"get":{"summary":"Resource to send an OTP by email to user.","responses":{"200":{"description":"OTP by email sent"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"post":{"summary":"Resource to allow a user to enable OTP by email.","responses":{"200":{"description":"OTP by email enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/auth/recovery-codes":{"put":{"summary":"Resource to allow a user to generate new recovery codes.","responses":{"200":{"description":"new recovery codes."},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/auth/fido":{"delete":{"summary":"Resource to allow a user to unregister a FIDO device.","responses":{"200":{"description":"FIDO device unregistered."},"400":{"description":"Invalid password Wrong or expired token Inactive user Wrong 2FA"}},"tags":["Authentication"]},"put":{"summary":"Resource to allow a user to pre-register a FIDO device.","responses":{"200":{"description":"FIDO device pre-registered."},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"get":{"summary":"Resource to get a challenge for a FIDO device.","responses":{"200":{"description":"Challenge for FIDO device."},"400":{"description":"Wrong parameter."}},"tags":["Authentication"]},"post":{"summary":"Resource to allow a user to register a FIDO device.","responses":{"200":{"description":"FIDO device registered."},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/data/asset-types":{"get":{"summary":"Retrieve all asset types (entity types that are not shot, sequence or episode).","responses":{"200":{"description":"All asset types"}},"tags":["Assets"]}},"/data/asset-types/{asset_type_id}":{"get":{"summary":"Retrieve given asset type.","responses":{"200":{"description":"Given asset type"}},"parameters":[{"in":"path","name":"asset_type_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/assets":{"get":{"summary":"Retrieve all entities that are not shot or sequence.","description":"Adds project name and asset type name.
","responses":{"200":{"description":"All assets"}},"tags":["Assets"]}},"/data/assets/all":{"get":{"summary":"Retrieve all entities that are not shot or sequence.","description":"Adds project name and asset type name.
","responses":{"200":{"description":"All assets"}},"tags":["Assets"]}},"/data/assets/with-tasks":{"get":{"summary":"Retrieve all entities that are not shot or sequence.","description":"Adds project name and asset type name and all related tasks. If episode_id is given as parameter, it returns assets not linked to an episode and assets linked to given episode.","responses":{"200":{"description":"All assets with tasks"}},"tags":["Assets"]}},"/data/assets/{asset_id}":{"delete":{"summary":"Delete given asset.","responses":{"204":{"description":"Given asset deleted"}},"parameters":[{"in":"path","name":"asset_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]},"get":{"summary":"Retrieve given asset.","responses":{"200":{"description":"Given asset"}},"parameters":[{"in":"path","name":"asset_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/assets/{asset_id}/assets":{"get":{"summary":"Retrieve all assets for a given asset.","responses":{"200":{"description":"All assets for a given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given shot.","responses":{"200":{"description":"All tasks related to given shot"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given asset.","responses":{"200":{"description":"All task types related to given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/cast-in":{"get":{"summary":"Resource to retrieve the casting of a given asset.","responses":{"200":{"description":"Casting of given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/casting":{"put":{"summary":"Resource to allow the modification of assets linked to a asset.","responses":{"200":{"description":"Modification of assets linked to given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]},"get":{"summary":"Resource to retrieve the casting of a given asset.","responses":{"200":{"description":"Casting of given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/shot-asset-instances":{"get":{"summary":"Retrieve all shot asset instances linked to asset.","responses":{"200":{"description":"All shot asset instances linked to asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/scene-asset-instances":{"get":{"summary":"Retrieve all scene asset instances linked to asset.","responses":{"200":{"description":"All scene asset instances linked to asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/asset-asset-instances":{"get":{"summary":"Retrieve all asset instances instantiated inside this asset.","responses":{"200":{"description":"All asset instances instantiated inside given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]},"post":{"summary":"Create an asset instance inside given asset.","responses":{"201":{"description":"Asset instance created inside given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/projects/{project_id}/asset-types/{asset_type_id}/assets":{"get":{"summary":"Retrieve all assets for given project and entity type.","responses":{"200":{"description":"All assets for given project and entity type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/projects/{project_id}/asset-types/{asset_type_id}/assets/new":{"post":{"summary":"Create new asset resource.","responses":{"201":{"description":"New asset resource created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Asset","description":"Name, description, data and ID of asset","schema":{"type":"object","required":["name","description","data","source_id"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"data":{"type":"string"},"source_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Assets"]}},"/data/projects/{project_id}/asset-types":{"get":{"summary":"Retrieve all asset types for given project.","responses":{"200":{"description":"All asset types for given project"}},"parameters":[{"in":"path","name":"project_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/shots/{shot_id}/asset-types":{"get":{"summary":"Retrieve all asset shots for given shot.","responses":{"200":{"description":"All asset shots for given shot"}},"parameters":[{"in":"path","name":"shot_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/projects/{project_id}/assets":{"get":{"summary":"Retrieve all assets for given project.","responses":{"200":{"description":"All assets for given project"}},"parameters":[{"in":"path","name":"project_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/projects/{project_id}/entities/{entity_id}/casting":{"put":{"summary":"Resource to allow the modification of assets linked to an entity.","responses":{"200":{"description":"Modification of assets linked to an entity"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]},"get":{"summary":"Resource to retrieve the casting of a given entity.","responses":{"200":{"description":"Casting of given entity"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/asset-types/{asset_type_id}/casting":{"get":{"summary":"Resource to retrieve the casting of assets from given asset type.","responses":{"200":{"description":"Casting of assets from given asset type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/episodes/casting":{"get":{"summary":"Resource to retrieve the casting of episodes.","responses":{"200":{"description":"Casting of episodes"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/sequences/{sequence_id}/casting":{"get":{"summary":"Resource to retrieve the casting of shots from given sequence.","responses":{"200":{"description":"Casting of shots from given sequence"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting":{"get":{"summary":"Resource to retrieve the casting of shots from given episode.","responses":{"200":{"description":"Casting for all shots from given episode."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/sequences/all/casting":{"get":{"summary":"Resource to retrieve the casting of shots from all sequences of given","description":"project.
","responses":{"200":{"description":"Casting for all shots from given project."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/entity-links":{"get":{"summary":"Retrieve all entity links related to given project.","description":"
Results can be paginated using page and limit query parameters. If you
prefer a more accurate pagination, you can use and
cursor_created_at to get the next page.
","responses":{"200":{"description":"All entity links related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"page","required":false,"type":"string","format":"Number","x-example":2},{"in":"limit","name":"page","required":false,"type":"string","format":"Number","x-example":100},{"in":"cursor_created_at","name":"page","required":false,"type":"string","format":"Datetime","x-example":"2020-01-01T00:00:00"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/entity-links/{entity_link_id}":{"delete":{"summary":"Delete given entity link.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"Entity link deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"entity_link_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/scenes/{scene_id}/asset-instances":{"get":{"summary":"Retrieve all asset instances linked to scene.","responses":{"200":{"description":"All asset instances linked to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]},"post":{"summary":"Create an asset instance on given scene.","responses":{"201":{"description":"Asset instances created on given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/scenes/{scene_id}/camera-instances":{"get":{"summary":"Retrieve all camera instances linked to scene.","responses":{"201":{"description":"All camera instances linked to scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/shots/{shot_id}/asset-instances":{"get":{"summary":"Retrieve all asset instances linked to shot.","responses":{"200":{"description":"All assets linked to shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]},"post":{"summary":"Add an asset instance to given shot.","responses":{"201":{"description":"Asset instance added to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/shots/{shot_id}/asset-instances/{asset_instance_id}":{"delete":{"summary":"Remove an asset instance from given shot.","responses":{"204":{"description":"Asset instance removed from given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/tasks/{task_id}/comments/{comment_id}/ack":{"post":{"summary":"Acknowledge given comment.","description":"If it's already acknowledged, remove acknowledgement.","responses":{"200":{"description":"Comment acknowledged"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/tasks/{task_id}/comments/{comment_id}/reply":{"post":{"summary":"Reply to given comment.","description":"Add comment to its replies list.","responses":{"200":{"description":"Reply to given comment"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"text","type":"string","x-example":"comment"}],"tags":["Comments"]}},"/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}":{"delete":{"summary":"Delete attachment linked to a comment matching given ID.","responses":{"204":{"description":"Empty response"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"attachment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}":{"delete":{"summary":"Delete given comment reply.","responses":{"200":{"description":"Given comment reply deleted"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"reply_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/attachment-files/{attachment_file_id}/file/{file_name}":{"get":{"summary":"Download attachment file.","responses":{"200":{"description":"Attachment file downloaded","schema":{"type":"file"}},"404":{"description":"Download failed"}},"parameters":[{"in":"path","name":"attachment_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"file_name","required":true,"type":"string","x-example":"filename"}],"tags":["Comments"],"produces":["multipart/form-data","image/png","image/gif","image/jpeg"]}},"/actions/tasks/{task_id}/comments/{comment_id}/add-attachment":{"post":{"summary":"Add given files to the comment entry as attachments.","responses":{"201":{"description":"Given files added to the comment entry as attachments"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"files","type":"file","required":true}],"tags":["Comments"],"consumes":["image/png","image/gif","image/jpeg","multipart/form-data"]}},"/data/projects/{project_id}/attachment-files":{"get":{"summary":"Return all attachment files related to given project.","responses":{"200":{"description":"All attachment files related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/tasks/{task_id}/attachment-files":{"get":{"summary":"Return all attachment files related to given task.","responses":{"200":{"description":"All attachment files related to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/actions/tasks/{task_id}/comment":{"post":{"summary":"Create a new comment for given task.","description":"It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.","responses":{"201":{"description":"New comment created"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Comment","description":"person ID, name, comment, revision and change status of task","schema":{"type":"object","required":["task_status_id"],"properties":{"task_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"created_at":{"type":"string","format":"date-time","example":"2022-07-12T13:00:00"},"checklist":{"type":"object","properties":{"item 1":{"type":"string"}}}}}}],"tags":["Comments"]}},"/actions/projects/{project_id}/tasks/comment-many":{"post":{"summary":"Create several comments at once.","description":"Each comment requires a text, a task id, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.","responses":{"201":{"description":"Given files added to the comment entry as attachments"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Comment","description":"person ID, name, comment, revision and change status of task","schema":{"type":"object","required":["task_status_id"],"properties":{"task_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"object_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"created_at":{"type":"string","format":"date-time","example":"2022-07-12T13:00:00"},"checklist":{"type":"object","properties":{"item 1":{"type":"string"}}}}}}],"tags":["Comments"]}},"/data/persons":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/persons/{instance_id}":{"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/projects":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/projects/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/project-status":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/project-status/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/entity-types":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/entity-types/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/entities":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/entities/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/task-types":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/task-types/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/task-status":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/task-status/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/tasks":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/tasks/{instance_id}":{"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/departments":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/departments/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/organisations":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/organisations/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/file-status/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/file-status/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/softwares":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/softwares/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a software corresponding at given ID and return it as a","description":"JSON object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"software_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/output-files":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/output-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON","description":"object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"output_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/output-types":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/output-types/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve an output type corresponding at given ID and return it as a","description":"JSON object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/preview-files":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/preview-files/{instance_id}":{"delete":{"summary":"Delete a preview file corresponding at given ID and retuns","description":"a 204 status code.
","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/working-files":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/working-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a working file corresponding at given ID and return it as a","description":"JSON object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/attachment-files":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/attachment-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/comments":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/comments/{instance_id}":{"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/time-spents/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/time-spents/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/day-offs/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/day-offs/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/custom-actions/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/custom-actions/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/status-automations/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/status-automations/{instance_id}":{"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/asset-instances/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/asset-instances/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/playlists/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/playlists/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/events/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/events/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/notifications/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/notifications/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/search-filters/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/search-filters/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/search-filter-groups/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/search-filter-groups/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/schedule-items/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/schedule-items/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/news/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/news/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/milestones/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/milestones/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/metadata-descriptors/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/metadata-descriptors/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/subscriptions/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/subscriptions/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/entity-links/":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/entity-links/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/preview-background-files":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]},"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/preview-background-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/entities/{entity_id}/news":{"get":{"summary":"Retrieve all news linked to a given entity.","responses":{"200":{"description":"All news linked to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entities"]}},"/data/entities/{entity_id}/preview-files":{"get":{"summary":"Retrieve all preview files linked to a given entity.","responses":{"200":{"description":"All preview files linked to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entities"]}},"/data/entities/{entity_id}/time-spents":{"get":{"summary":"Retrieve all time spents linked to a given entity.","responses":{"200":{"description":"All time spents linked to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entities"]}},"/data/entities/{entity_id}/entities-linked/with-tasks":{"get":{"summary":"Resource to retrieve the entities linked on a given entity.","responses":{"200":{"description":"Entities linked on given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entity"]}},"/export/csv/projects/{project_id}/assets.csv":{"get":{"summary":"Export assets linked to a given project as csv.","responses":{"200":{"description":"Assets exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/projects/{project_id}/shots.csv":{"get":{"summary":"Export shots linked to a given project as csv.","responses":{"200":{"description":"Shots exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/projects/{project_id}/casting.csv":{"get":{"summary":"Export casting linked to a given project as csv.","responses":{"200":{"description":"Casting exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/projects/{project_id}/edits.csv":{"get":{"summary":"Export edits linked to a given project as csv.","responses":{"200":{"description":"Edits exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/playlists/{playlist_id}":{"get":{"summary":"Export a given playlist as csv.","responses":{"200":{"description":"Playlist exported as csv"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/persons.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/projects.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/tasks.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/time-spents.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/task-types.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/data/events/last":{"get":{"summary":"Retrieve last events.","responses":{"200":{"description":"All login logs"}},"parameters":[{"in":"query","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"only_files","type":"boolean","default":false},{"in":"query","name":"page_size","type":"integer","default":100,"x-example":100},{"in":"query","name":"project_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Events"]}},"/data/events/login-logs/last":{"get":{"summary":"Retrieve all login logs.","responses":{"200":{"description":"All login logs"}},"parameters":[{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12T00:00:00"},{"in":"query","name":"page_size","type":"integer","x-example":100}],"tags":["Events"]}},"/data/files/{file_id}":{"get":{"summary":"Get information about a file that could be a working file as much as an","description":"output file.
","responses":{"200":{"description":"Information about file"}},"parameters":[{"in":"path","name":"file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/tasks/{task_id}/working-files":{"get":{"summary":"Return last working files revision for each file name for given task.","responses":{"200":{"description":"Last working files revision for each file name for given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/tasks/{task_id}/working-files/new":{"post":{"summary":"Create new working file.","description":"A working file is a file used to produce output files. It is the file the CG artist is working on. It is versioned, tied to a task and a software and requires a comment each time it is created. A path is generated for each file created. The path format is defined in the file tree template file.","responses":{"201":{"description":"New working file created","schema":{"type":"file"}},"400":{"description":"Given working file already exists"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, mode, description, comment, person ID, software ID, revision and separator.","schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"mode":{"type":"string","default":"working"},"description":{"type":"string"},"comment":{"type":"string"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"software_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"revision":{"type":"integer"},"sep":{"type":"string","default":"/"}}}}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]}},"/data/tasks/{task_id}/working-files/last-revisions":{"get":{"summary":"Return last working files revision for each file name for given task.","responses":{"200":{"description":"Last working files revision for each file name for given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/tasks/{task_id}/working-file-path":{"post":{"summary":"Generate a working file path from file tree template.","description":"Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.","responses":{"200":{"description":"Working file path generated"},"400":{"description":"Malformed file tree"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, software, mode, revision and separator.","schema":{"type":"object","properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"working"},"software_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"revision":{"type":"integer"},"separator":{"type":"string","default":"/"}}}}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new":{"post":{"summary":"Create new output file linked to assets through an instance of this asset for a given shot.","description":"Some output files are linked to assets through an instance of this asset for a given shot. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target instance. It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file.","responses":{"200":{"description":"New output file created","schema":{"type":"file"}},"400":{"description":"Given output file already exists Given person not found Given output type not found"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, mode, output type ID, task type ID, person ID, working file ID, file status ID, comment, extension, representation, revision, number of elements and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"working_file_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"file_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"is_sequence":{"type":"boolean","default":false},"comment":{"type":"string"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"nb_elements":{"type":"integer","default":1},"sep":{"type":"string","default":"/"}}}}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision":{"post":{"summary":"Get next revision for given asset instance, output type, task type and name.","responses":{"200":{"description":"Next revision for given asset instance, output type, task type and name"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, output type ID, task type ID.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions":{"get":{"summary":"Get last revisions of output files for given instance grouped by output type and file name.","responses":{"200":{"description":"Last revisions of output files for given instance grouped by output type and file name"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types":{"get":{"summary":"Return all types of output generated for given instance.","responses":{"200":{"description":"All types of output generated for given instance and temporal_entity"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files":{"get":{"summary":"Get all output files for given asset instance and given output type.","responses":{"200":{"description":"All output files for given asset instance and given output type"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path":{"post":{"summary":"Generate an output file path from file tree template","description":"Generate file path based on several parameters: asset instance, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision in case no revision is given in parameter.","responses":{"200":{"description":"Output file path generated"},"400":{"description":"Malformed file tree"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Asset instance, output type, task type, revision, mode, name and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"separator":{"type":"string","default":"/"}}}}],"tags":["Files"]}},"/data/entities/{entity_id}/working-files":{"get":{"summary":"Get all working files for a given entity and possibly a task and a name.","responses":{"200":{"description":"All working files for given entity and possibly a task and a name"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-files/new":{"post":{"summary":"Create new output file linked to a given entity.","description":"Output files are linked to entities. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target entity (an asset, a shot, a sequence, ...). It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file. Revision is automatically set.","responses":{"200":{"description":"New output file created","schema":{"type":"file"}},"400":{"description":"Given output file already exists Given person not found Given output type not found"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, mode, output type ID, task type ID, person ID, working file ID, file status ID, comment, extension, representation, revision, number of elements and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"working_file_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"file_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"nb_elements":{"type":"integer","default":1},"sep":{"type":"string","default":"/"}}}}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]}},"/data/entities/{entity_id}/output-files/next-revision":{"post":{"summary":"Get next revision for given entity, output type, task type and name.","responses":{"200":{"description":"Next revision for given entity, output type, task type and name"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, output type ID, task type ID.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Files"]}},"/data/entities/{entity_id}/output-files/last-revisions":{"get":{"summary":"Get last revisions of output files for given entity grouped by output type and file name.","responses":{"200":{"description":"Last revisions of output files for given entity grouped by output type and file name"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-types":{"get":{"summary":"Return all types of output generated for given entity.","responses":{"200":{"description":"All types of output generated for given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-types/{output_type_id}/output-files":{"get":{"summary":"Get all output files for given entity and given output type.","responses":{"200":{"description":"All output files for given entity and given output type"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-files":{"get":{"summary":"Get all output files for given entity.","responses":{"200":{"description":"All output files for given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/projects/{project_id}/output-files":{"get":{"summary":"Get all output files for given poject.","responses":{"200":{"description":"All output files for given project."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/output-files":{"get":{"summary":"Get all output files for given asset instance and given output type.","responses":{"200":{"description":"All output files for given asset instance and given temporal entity (shot, sequence, etc.)"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"cache"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-file-path":{"post":{"summary":"Generate an output file path from file tree template","description":"Generate file path based on several parameters: entity, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision if not given.","responses":{"200":{"description":"Output file path generated"},"400":{"description":"Malformed file tree"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Entity, output type, task type, revision, mode, name and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"separator":{"type":"string","default":"/"}}}}],"tags":["Files"]}},"/data/working-files/{working_file_id}/file":{"get":{"summary":"Download a working file.","responses":{"200":{"description":"Working file downloaded","schema":{"type":"file"}}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]},"post":{"summary":"Store a working file.","responses":{"201":{"description":"Working file stored"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Files"]}},"/actions/projects/{project_id}/set-file-tree":{"post":{"summary":"Define a template file to use for given project.","description":"Template files are located on the server side. Each template has a name which means that you just have to give a name to \"select\" the template to link with the project.","responses":{"200":{"description":"Template file defined"},"400":{"description":"Selected tree not available"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Tree name","schema":{"type":"object","required":["tree_name"],"properties":{"tree_name":{"type":"string"}}}}],"tags":["Files"]}},"/actions/working-files/{working_file_id}/comment":{"put":{"summary":"Update comment on given working file.","responses":{"200":{"description":"Comment updated on given working file"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Comment","schema":{"type":"object","required":["comment"],"properties":{"comment":{"type":"string"}}}}],"tags":["Files"]}},"/actions/working-files/{working_file_id}/modified":{"put":{"summary":"Update working file modification date with current date.","responses":{"200":{"description":"Working file modification date updated"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/import/shotgun/persons":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/projects":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/episodes":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/sequences":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/shots":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/scenes":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/assets":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/steps":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/status":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/tasks":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/versions":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/notes":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/errors":{"get":{"summary":"Import shotgun error resource.","responses":{"200":{"description":"Resource imported"}},"tags":["Import"]},"post":{"summary":"Serialize shotgun error resource.","responses":{"200":{"description":"Resource serialized"}},"tags":["Import"]}},"/import/shotgun/projectconnections":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/errors/{error_id}":{"delete":{"summary":"Delete error.","responses":{"204":{"description":"Error deleted"},"404":{"description":"Error non-existant or Statement error"}},"parameters":[{"in":"path","name":"error_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"]}},"/import/shotgun/remove/project":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/person":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/shot":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/scene":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/episode":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/sequence":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/asset":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/projectconnection":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/step":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/status":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/task":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/note":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/version":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/csv/persons":{"post":{"summary":"Import persons via a .csv file.","responses":{"201":{"description":"The lists of imported persons."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/assets":{"post":{"summary":"Import project assets via a .csv file.","responses":{"201":{"description":"The lists of imported assets."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/shots":{"post":{"summary":"Import project shots via a .csv file.","responses":{"201":{"description":"The lists of imported assets."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/edits":{"post":{"summary":"Import project edits.","responses":{"201":{"description":"Edits imported"},"400":{"description":"Format error"}},"parameters":[{"in":"formData","name":"file","type":"file","required":true},{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/casting":{"post":{"summary":"Import project casting links via a .csv file.","responses":{"201":{"description":"The lists of imported casting links."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations":{"post":{"summary":"Import the estimations of task-types for given project.","responses":{"201":{"description":"Estimations imported"},"400":{"description":"Format error"}},"parameters":[{"in":"formData","name":"file","type":"file","required":true},{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations":{"post":{"summary":"Import the estimations of task-types for given episode of given project.","responses":{"201":{"description":"Estimations imported"},"400":{"description":"Format error"}},"parameters":[{"in":"formData","name":"file","type":"file","required":true},{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/edl/projects/{project_id}":{"post":{"summary":"Import an EDL file to enter frame_in / frame_out / nb_frames.","responses":{"201":{"description":"."},"400":{"description":"The .EDL file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/edl/projects/{project_id}/episodes/{episode_id}":{"post":{"summary":"Import an EDL file to enter frame_in / frame_out / nb_frames.","responses":{"201":{"description":"."},"400":{"description":"The .EDL file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/kitsu/comments":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/entities":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/entity-links":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/projects":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/tasks":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/":{"get":{"summary":"Get API name and version.","responses":{"200":{"description":"API name and version"}},"tags":["Index"]}},"/status":{"get":{"summary":"Retrieve API name, version and status.","responses":{"200":{"description":"API name, version and status"}},"tags":["Index"]}},"/status/influx":{"get":{"summary":"Retrieve status of database and time.","responses":{"200":{"description":"Status of database, key value, event stream, job queue and time"}},"tags":["Index"]}},"/status/resources":{"get":{"summary":"Retrieve date and CPU, memory and jobs stats.","responses":{"200":{"description":"Date and CPU, memory and jobs stats"}},"tags":["Index"]}},"/status.txt":{"get":{"summary":"Retrieve API name, version and status as txt.","responses":{"200":{"description":"API name, version and status as txt"}},"tags":["Index"]}},"/status/test-event":{"get":{"summary":"Generate a main:test event.","responses":{"200":{"description":"Success flage"}},"tags":["Index"]}},"/stats":{"get":{"summary":"Retrieve main stats.","responses":{"403":{"description":"Permission denied"},"200":{"description":"Main stats"}},"tags":["Index"]}},"/config":{"get":{"summary":"Get crisp token.","responses":{"200":{"description":"Crisp token"}},"tags":["Index"]}},"/data/projects/news":{"get":{"summary":"Retrieve all news related to a given project","responses":{"200":{"description":"All news from user open projects."}},"parameters":[{"in":"query","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"page","type":"integer","x-example":1},{"in":"query","name":"page_size","type":"integer","x-example":50},{"in":"query","name":"person_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_status_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"episode_id","type":"boolean","default":false},{"in":"query","name":"only_preview","type":"boolean","default":false}],"tags":["News"]}},"/data/projects/{project_id}/news":{"get":{"summary":"Retrieve all news related to a given project","responses":{"200":{"description":"All news related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"page","type":"integer","x-example":1},{"in":"query","name":"page_size","type":"integer","x-example":50},{"in":"query","name":"person_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_status_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"episode_id","type":"boolean","default":false},{"in":"query","name":"only_preview","type":"boolean","default":false}],"tags":["News"]}},"/data/projects/{project_id}/news/{news_id}":{"get":{"summary":"Retrieve a single given news related to a given project","responses":{"200":{"description":"Single given news related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"news_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["News"]}},"/data/persons/new":{"post":{"summary":"Create a new user in the database.","description":"Set password to None if not provided. User role can be set but only admins can create admin users.","responses":{"201":{"description":"User created"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"phone","required":false,"type":"integer","x-example":"06 12 34 56 78"},{"in":"formData","name":"role","required":false,"type":"string","x-example":"user"},{"in":"formData","name":"first_name","required":true,"type":"string"},{"in":"formData","name":"last_name","required":false,"type":"string"}],"tags":["Persons"]}},"/data/persons/{person_id}/desktop-login-logs":{"get":{"summary":"Retrieve desktop login logs.","description":"Desktop login logs can only be created by current user.","responses":{"200":{"description":"Desktop login logs"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]},"post":{"summary":"Create desktop login logs.","description":"Add a new log entry for desktop logins.","responses":{"201":{"description":"Desktop login log entry created."}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Persons"]}},"/data/persons/presence-logs/{month_date}":{"get":{"summary":"Return a csv file containing the presence logs based on a daily basis.","responses":{"200":{"description":"CSV file containing the presence logs based on a daily basis"}},"parameters":[{"in":"path","name":"month_date","required":true,"type":"string","format":"date","x-example":"2022-07"}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/{date}":{"get":{"summary":"Get time spents for given person and date.","responses":{"200":{"description":"Time spents for given person and date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/{date}":{"get":{"summary":"Get day off object for given person and date.","responses":{"200":{"description":"Day off object for given person and date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/year/{year}":{"get":{"summary":"Get aggregated time spents for given person and year.","responses":{"200":{"description":"Aggregated time spents for given person and year"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/month/{year}/{month}":{"get":{"summary":"Get aggregated time spents for given person and month.","responses":{"200":{"description":"Aggregated time spents for given person and month"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/week/{year}/{week}":{"get":{"summary":"Get aggregated time spents for given person and week.","responses":{"200":{"description":"Aggregated time spents for given person and week"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"week","required":true,"type":"integer","x-example":35,"minimum":1,"maximum":52}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}":{"get":{"summary":"Get aggregated time spents for given person and day.","responses":{"200":{"description":"Aggregated time spents for given person and day"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12},{"in":"path","name":"day","required":true,"type":"integer","x-example":12,"minimum":1,"maximum":31}],"tags":["Persons"]}},"/data/persons/{person_id}/quota-shots/month/{year}/{month}":{"get":{"summary":"Get ended shots used for quota calculation of this month.","responses":{"200":{"description":"Ended shots used for quota calculation of this month"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/quota-shots/week/{year}/{week}":{"get":{"summary":"Get ended shots used for quota calculation of this week.","responses":{"200":{"description":"Ended shots used for quota calculation of this week"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"week","required":true,"type":"integer","x-example":35,"minimum":1,"maximum":52}],"tags":["Persons"]}},"/data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}":{"get":{"summary":"Get ended shots used for quota calculation of this day.","responses":{"200":{"description":"Ended shots used for quota calculation of this day"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12},{"in":"path","name":"day","required":true,"type":"integer","x-example":12,"minimum":1,"maximum":31}],"tags":["Persons"]}},"/data/persons/time-spents/year-table/":{"get":{"summary":"Return a table giving time spent by user and by month for given year.","responses":{"200":{"description":"Table giving time spent by user and by month for given year"}},"tags":["Persons"]}},"/data/persons/time-spents/month-table/{year}":{"get":{"summary":"Return a table giving time spent by user and by month for given year.","responses":{"200":{"description":"Table giving time spent by user and by month for given year"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/data/persons/time-spents/week-table/{year}":{"get":{"summary":"Return a table giving time spent by user and by week for given year.","responses":{"200":{"description":"Table giving time spent by user and by week for given year"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/data/persons/time-spents/day-table/{year}/{month}":{"get":{"summary":"Return a table giving time spent by user and by day for given year and month.","responses":{"200":{"description":"Table giving time spent by user and by day for given year and month"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/day-offs/{year}/{month}":{"get":{"summary":"Return all day off recorded for given month.","responses":{"200":{"description":"All day off recorded for given month"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/week/{year}/{week}":{"get":{"summary":"Return all day off recorded for given week and person.","responses":{"200":{"description":"All day off recorded for given week and person"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"week","required":true,"type":"integer","x-example":35,"minimum":1,"maximum":52}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/month/{year}/{month}":{"get":{"summary":"Return all day off recorded for given month and person.","responses":{"200":{"description":"All day off recorded for given month and person"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/year/{year}":{"get":{"summary":"Return all day off recorded for given year and person.","responses":{"200":{"description":"All day off recorded for given year and person"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/actions/persons/{person_id}/invite":{"get":{"summary":"Sends an email to given person to invite him/her to connect to Kitsu.","responses":{"200":{"description":"Email sent"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/departments/add":{"post":{"summary":"Add a user to given department.","responses":{"201":{"description":"User added to given department"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/departments/{department_id}":{"delete":{"summary":"Remove a user from given department.","responses":{"204":{"description":"User removed from given department"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"department_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/change-password":{"post":{"summary":"Allow admin to change password for given user.","description":"Prior to modifying the password, it requires to be admin. An admin can't change other admins password. The new password requires a confirmation to ensure that the admin didn't make a mistake by typing the new password.","responses":{"200":{"description":"Password changed"},"400":{"description":"Invalid password or inactive user"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password_2","required":true,"type":"string","format":"password"}],"tags":["Persons"]}},"/actions/persons/{person_id}/disable-two-factor-authentication":{"delete":{"summary":"Allow admin to disable two factor authentication for given user.","description":"Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.","responses":{"200":{"description":"Two factor authentication disabled"},"400":{"description":"Inactive user"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/clear-avatar":{"delete":{"summary":"Set `has_avatar` flag to False for current user and remove its avatar","description":"file.
","responses":{"204":{"description":"Avatar file deleted"}},"tags":["User"]}},"/data/projects/{project_id}/playlists":{"get":{"summary":"Retrieve all playlists related to given project.","description":"Result is paginated and can be sorted.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/playlists/all":{"get":{"summary":"Retrieve all playlists related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/episodes/{episode_id}/playlists":{"get":{"summary":"Retrieve all playlists related to given episode.","description":"The full list is returned because the number of playlists in an episode is not that big.","responses":{"200":{"description":"All playlists related to given episode"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/playlists/{playlist_id}":{"get":{"summary":"Retrieve all playlists related to given project.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/playlists/entities/{entity_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given entity.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/playlists/{playlist_id}/jobs/{build_job_id}":{"delete":{"summary":"Remove given build job related to given playlist.","responses":{"204":{"description":"Given build job removed"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"build_job_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]},"get":{"summary":"Retrieve build job related to given playlist.","responses":{"200":{"description":"Build job related to given playlist"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"build_job_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/build-jobs":{"get":{"summary":"Retrieve all build jobs related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All build jobs related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/playlists/{playlist_id}/build/mp4":{"get":{"summary":"Build given playlist as mp4 movie.","responses":{"200":{"description":"Given playlist built as mp4 movie"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"],"produces":["multipart/form-data"]}},"/data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4":{"get":{"summary":"Download given playlist build as .mp4.","responses":{"200":{"description":"Given playlist build downloaded as .mp4"},"400":{"description":"Build not finished, need to retry later"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"build_job_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"],"produces":["multipart/form-data"]}},"/data/playlists/{playlist_id}/download/zip":{"get":{"summary":"Download given playlist as zip.","responses":{"200":{"description":"Given playlist downloaded as zip","schema":{"type":"file"}}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"],"produces":["multipart/form-data"]}},"/data/projects/{project_id}/playlists/temp":{"post":{"summary":"Retrieve all playlists related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/open":{"get":{"summary":"Return the list of projects currently running.","description":"Most of the time, past projects are not needed.","responses":{"200":{"description":"All running projects"}},"tags":["Projects"]}},"/data/projects/all":{"get":{"summary":"Return all projects listed in database.","description":"Ensure that user has at least the manager level before that.","responses":{"200":{"description":"All projects listed in database"}},"tags":["Projects"]}},"/data/projects/{project_id}/team":{"get":{"summary":"Return the people listed in a production team.","responses":{"200":{"description":"People listed in a production team"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"post":{"summary":"Add a person to a production team.","responses":{"201":{"description":"Person added to the production team"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/task-types":{"get":{"summary":"Retrieve task types linked to the production","responses":{"200":{"description":"Task types linked to the production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/team/{person_id}":{"delete":{"summary":"Remove people listed in a production team.","responses":{"204":{"description":"Person removed from production team"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/asset-types":{"post":{"summary":"Add an asset type linked to a production.","responses":{"201":{"description":"Asset type added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/asset-types/{asset_type_id}":{"delete":{"summary":"Remove an asset type from a production.","responses":{"204":{"description":"Asset type removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-types":{"post":{"summary":"Add a task type linked to a production.","responses":{"201":{"description":"Asset type added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"priority","required":false,"type":"string","default":"None"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-types/{task_type_id}":{"delete":{"summary":"Remove a task type from a production.","responses":{"204":{"description":"Task type removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-status":{"get":{"summary":"Return task statuses linked to a production","responses":{"200":{"description":"Task statuses linked to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"post":{"summary":"Add a task type linked to a production.","responses":{"201":{"description":"Task type added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"task_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-status/{task_status_id}":{"delete":{"summary":"Remove a task status from a production.","responses":{"204":{"description":"Task status removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/status-automations":{"get":{"summary":"Get a status automation linked to a production.","responses":{"200":{"description":"Status automation linked to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"post":{"summary":"Add a status automation linked to a production.","responses":{"201":{"description":"Status automation added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"status_automation_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/status-automations/{status_automation_id}":{"delete":{"summary":"Remove a status automation from a production.","responses":{"204":{"description":"Status automation removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"status_automation_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}":{"delete":{"summary":"Remove a preview background file from a production.","responses":{"204":{"description":"Preview background file removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_background_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/preview-background-files":{"get":{"summary":"Return preview background files linked to a production","responses":{"200":{"description":"Preview background files linked to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"post":{"summary":"Add a preview background file linked to a production.","responses":{"201":{"description":"Preview background file added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"preview_background_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/metadata-descriptors":{"get":{"summary":"Get all metadata descriptors","description":"It serves to describe extra fields listed in the data attribute of entities.","responses":{"200":{"description":"All metadata descriptors"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"post":{"summary":"Create a new metadata descriptor","description":"It serves to describe extra fields listed in the data attribute of entities.","responses":{"201":{"description":"Create a new metadata descriptor"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/metadata-descriptors/{descriptor_id}":{"delete":{"summary":"Delete a metadata descriptor.","description":"Descriptors serve to describe extra fields listed in the data attribute of entities.","responses":{"204":{"description":"Metadata descriptor deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"descriptor_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"put":{"summary":"Update a metadata descriptor.","description":"Descriptors serve to describe extra fields listed in the data attribute of entities.","responses":{"200":{"description":"Metadata descriptor updated"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"descriptor_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":false,"type":"string"},{"in":"formData","name":"for_client","required":false,"type":"boolean","default":false},{"in":"formData","name":"choices","required":false,"type":"array"},{"in":"formData","name":"departments","type":"array","required":false}],"tags":["Projects"]},"get":{"summary":"Get a metadata descriptor.","description":"Descriptors serve to describe extra fields listed in the data attribute of entities.","responses":{"200":{"description":"Metadata descriptor"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"descriptor_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/milestones":{"get":{"summary":"Retrieve milestones for given production","responses":{"200":{"description":"All milestones of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items":{"get":{"summary":"Retrieve schedule items for given production","responses":{"200":{"description":"All schedule items of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/task-types":{"get":{"summary":"Retrieve task type schedule items for given production","responses":{"200":{"description":"All task types schedule items of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/{task_type_id}/asset-types":{"get":{"summary":"Retrieve asset types schedule items for given task type","responses":{"200":{"description":"All asset types schedule items for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/{task_type_id}/episodes":{"get":{"summary":"Retrieve episodes schedule items for given task type","responses":{"200":{"description":"All episodes schedule items for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/{task_type_id}/sequences":{"get":{"summary":"Retrieve sequences schedule items for given task type","responses":{"200":{"description":"All sequences schedule items for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/time-spents":{"get":{"summary":"Retrieve time spents for given production","responses":{"200":{"description":"All time spents of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/shots":{"get":{"summary":"Retrieve all shot entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All shot entries"}},"parameters":[{"in":"query","name":"sequence_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"parent_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/all":{"get":{"summary":"Retrieve all shot entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All shot entries"}},"parameters":[{"in":"query","name":"sequence_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"parent_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/with-tasks":{"get":{"summary":"Retrieve all shots, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All shots"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}":{"delete":{"summary":"Delete given shot.","responses":{"204":{"description":"Given shot deleted"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given shot.","responses":{"200":{"description":"Given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/assets":{"get":{"summary":"Retrieve all assets for a given shot.","responses":{"200":{"description":"All assets for given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given shot.","responses":{"200":{"description":"All task types related to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given shot.","responses":{"200":{"description":"All tasks related to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given shot.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given episode"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/versions":{"get":{"summary":"Retrieve data versions of given shot.","responses":{"204":{"description":"Data versions of given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/all":{"get":{"summary":"Retrieve all scene entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All scene entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/with-tasks":{"get":{"summary":"Retrieve all scenes, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All scenes"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}":{"delete":{"summary":"Delete given scene.","responses":{"204":{"description":"Given scene deleted"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given scene.","responses":{"200":{"description":"Given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given scene.","responses":{"200":{"description":"All tasks related to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given scene.","responses":{"200":{"description":"All task types related to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/shots":{"get":{"summary":"Retrieve all shots that come from given scene.","responses":{"200":{"description":"All shots that come from given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"post":{"summary":"Mark given scene as source of given shot.","responses":{"200":{"description":"Given scene marked as source of given shot"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"shot_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/shots/{shot_id}":{"delete":{"summary":"Delete given shot from given scene.","responses":{"204":{"description":"Given shot deleted from given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes":{"get":{"summary":"Retrieve all episode entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All episode entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/with-tasks":{"get":{"summary":"Retrieve all episodes, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All episodes"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}":{"delete":{"summary":"Delete given episode.","responses":{"204":{"description":"Given episode deleted"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given episode.","responses":{"200":{"description":"Given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/shots":{"get":{"summary":"Retrieve all shots related to a given episode.","responses":{"200":{"description":"All shots related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/sequences":{"get":{"summary":"Retrieve all sequence entries for a given episode.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All sequence entries for given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given episode.","responses":{"200":{"description":"All tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given episode.","responses":{"200":{"description":"All task types related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/shot-tasks":{"get":{"summary":"Retrieve all shots tasks related to a given episode.","responses":{"200":{"description":"All shots tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/asset-tasks":{"get":{"summary":"Retrieve all assets tasks related to a given episode.","responses":{"200":{"description":"All assets tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences":{"get":{"summary":"Retrieve all sequence entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All sequence entries"}},"parameters":[{"in":"query","name":"episode_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/with-tasks":{"get":{"summary":"Retrieve all sequences, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All sequences"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}":{"delete":{"summary":"Delete given sequence.","responses":{"204":{"description":"Given sequence deleted"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given sequence.","responses":{"200":{"description":"Given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/shots":{"get":{"summary":"Retrieve all shot entries for a given sequence.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All shot entries for given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/scenes":{"get":{"summary":"Retrieve all scenes related to a given sequence.","responses":{"200":{"description":"All scenes related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given shot.","responses":{"200":{"description":"All tasks related to given shot"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given shot.","responses":{"200":{"description":"All task types related to given shot"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/shot-tasks":{"get":{"summary":"Retrieve all tasks related to a given sequence.","responses":{"200":{"description":"All task types related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/shots":{"get":{"summary":"Retrieve all shots related to a given project.","responses":{"200":{"description":"All shots related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"post":{"summary":"Create a shot for given project.","responses":{"201":{"description":"Shot created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of shot"},{"in":"formData","name":"description","type":"string","x-example":"Description of shot"},{"in":"formData","name":"sequence_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"nb_frames","type":"integer"}],"tags":["Shots"]}},"/data/projects/{project_id}/scenes":{"get":{"summary":"Retrieve all scenes related to a given project.","responses":{"200":{"description":"All scenes related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"post":{"summary":"Create a scene for given project.","responses":{"201":{"description":"Scene created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of scene"},{"in":"formData","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/sequences":{"get":{"summary":"Retrieve all sequences related to a given project.","responses":{"200":{"description":"All sequences related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"post":{"summary":"Create a sequence for given project.","responses":{"201":{"description":"Sequence created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of sequence"},{"in":"formData","name":"episode_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/episodes":{"get":{"summary":"Retrieve all episodes related to a given project.","responses":{"200":{"description":"All episodes related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"post":{"summary":"Create an episode for given project.","responses":{"201":{"description":"Episode created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of the episode"},{"in":"formData","name":"description","required":true,"type":"string","x-example":"Description of the episode"}],"tags":["Shots"]}},"/data/projects/{project_id}/episodes/stats":{"get":{"summary":"Retrieve number of tasks by status, task_types and episodes for given project.","responses":{"200":{"description":"Number of tasks by status, task types and episodes for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/episodes/retake-stats":{"get":{"summary":"Retrieve number of tasks by status, task_types and episodes for given project.","responses":{"200":{"description":"Number of tasks by status, task types and episodes for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/quotas/{task_type_id}":{"get":{"summary":"Retrieve quotas statistics for shots.","responses":{"200":{"description":"Quotas statistics for shots"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/tasks/{task_id}/comments":{"get":{"summary":"Return comments linked to given task.","responses":{"200":{"description":"Comments linked to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/tasks/{task_id}/comments/{comment_id}":{"delete":{"summary":"Delete a comment corresponding at given ID.","responses":{"204":{"description":"Comment corresponding at given ID deleted"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]},"get":{"summary":"Get comment corresponding at given ID.","responses":{"200":{"description":"Comment corresponding at given ID"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/tasks/{task_id}/previews":{"get":{"summary":"Return previews linked to given task.","responses":{"200":{"description":"Previews linked to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/tasks/{task_id}/full":{"get":{"summary":"Return a task with many information.","description":"Full details for assignees, full details for task type, full details for task status, etc.","responses":{"200":{"description":"Task with many information"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/{person_id}/tasks":{"get":{"summary":"Return task assigned to given user of which status has is_done flag sets to false.","responses":{"200":{"description":"Tasks assigned to user that are not done"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/{person_id}/related-tasks/{task_type_id}":{"get":{"summary":"For all entities assigned to given person (that have at least one task assigned to given person), returns all tasks for given task type.","responses":{"200":{"description":"All Tasks for given task type"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/{person_id}/done-tasks":{"get":{"summary":"Return task assigned to given user of which status has is_done flag sets to true.","description":"It return only tasks related to open projects.","responses":{"200":{"description":"Tasks assigned to user that are done"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/entities/{entity_id}/task-types/{task_type_id}/tasks":{"get":{"summary":"Return tasks related to given entity asset, episode, sequence, shot or scene.","responses":{"200":{"description":"Tasks related to given entity asset, episode, sequence, shot or scene"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/comments":{"get":{"summary":"Retrieve all comments to tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All comments to tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/notifications":{"get":{"summary":"Retrieve all notifications to tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All notifications to tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/preview-files":{"get":{"summary":"Preview files related to a given project.","responses":{"200":{"description":"Preview files related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/subscriptions":{"get":{"summary":"Retrieve all subcriptions to tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All subcriptions to tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/tasks":{"get":{"summary":"Retrieve all tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/task-dates":{"get":{"summary":"For schedule usages, for each active person, it returns the first start","description":"date of all tasks of assigned to this person and the last end date.
","responses":{"200":{"description":"For each person, the first start date of all tasks of assigned to this person and the last end date."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks":{"delete":{"summary":"Delete all tasks for a given task type and project.","description":"It's mainly used when tasks are created by mistake at the beginning of the project.","responses":{"204":{"description":"All tasks for given task type and project deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/delete-tasks":{"post":{"summary":"Delete tasks matching id list given in parameter.","description":"See it as a way to batch delete tasks.","responses":{"200":{"description":"Tasks matching id list given in parameter deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/assign":{"put":{"summary":"Assign given task list to given person.","responses":{"200":{"description":"Given task assigned to given person"},"400":{"description":"Assignee non-existent in database"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Person","description":"Person ID","schema":{"type":"object","required":["person_id"],"properties":{"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Tasks"]}},"/actions/tasks/clear-assignation":{"put":{"summary":"Remove all assignations set to given task.","responses":{"200":{"description":"All assignations removed"}},"parameters":[{"in":"body","name":"Task","description":"List of tasks ID and person ID","schema":{"type":"object","required":["task_ids"],"properties":{"task_ids":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Tasks"]}},"/actions/persons/{person_id}/assign":{"put":{"summary":"Assign given task lists to given person.","description":"If a given task ID is wrong, it ignores it.","responses":{"200":{"description":"Given tasks lists assigned to given person"}},"parameters":[{"in":"path","name":"person_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true},{"in":"body","name":"Task","description":"List of tasks ID","schema":{"type":"object","required":["task_ids"],"properties":{"task_ids":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents/{date}":{"get":{"summary":"Get time spent on a given task and date.","responses":{"200":{"description":"Time spent on given task and date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents":{"get":{"summary":"Get time spent on a given task.","responses":{"200":{"description":"Time spent on given task"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}":{"post":{"summary":"Set time spent by a person on a task for a given day.","responses":{"201":{"description":"Time spent by given person on given task for given day is set"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"},{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Duration","schema":{"type":"object","properties":{"duration":{"type":"float"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add":{"post":{"summary":"Add given timeframe to time spent by a person on a task for a given day.","responses":{"201":{"description":"Given timeframe added to time spent by given person on given task for given day"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"},{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Duration","schema":{"type":"object","properties":{"duration":{"type":"float"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/comments/{comment_id}/add-preview":{"post":{"summary":"Add preview metadata to given task. The preview file itself should be","description":"uploaded afterward.

Revision is automatically set: it is equal to last revision + 1. It can
be also set manually.
","responses":{"201":{"description":"Preview metadata added to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","schema":{"type":"object","properties":{"revision":{"type":"integer"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}":{"delete":{"summary":"Delete preview from given comment.","responses":{"204":{"description":"Preview deleted from given comment"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]},"post":{"summary":"Add a preview to given comment.","responses":{"201":{"description":"Preview added to given comment"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/to-review":{"put":{"summary":"Change a task status to \"to review\".","description":"It creates a new preview file entry and set path from the hard disk.","responses":{"200":{"description":"Task status changed to \"to review\""},"400":{"description":"Given person not found"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Task","description":"person ID, name, comment, revision and change status of task","schema":{"type":"object","properties":{"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"name":{"type":"string"},"revision":{"type":"integer"},"change_status":{"type":"boolean"}}}}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks":{"post":{"summary":"Create a new task for given shot and task type.","responses":{"201":{"description":"New task for given shot and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks":{"post":{"summary":"Create a new task for given asset and task type.","responses":{"201":{"description":"New task for given asset and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/edits/create-tasks":{"post":{"summary":"Create a new task for given edit and task type.","responses":{"201":{"description":"New task for given edit and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks":{"post":{"summary":"Create a new task for given concept and task type.","responses":{"201":{"description":"New task for given concept and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/":{"post":{"summary":"Create a new task with given task type for each entity of given","description":"entity type.
","responses":{"201":{"description":"List of created tasks."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/set-main-preview":{"put":{"summary":"Set last preview from given task as main preview of the related entity.","description":"This preview will be used as thumbnail to illustrate the entity.
","responses":{"200":{"description":"Given preview set as main preview"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Task"]}},"/data/playlists/preview-files/running":{"get":{"summary":"Retrieve all preview files from open productions with states equals to processing or broken.","responses":{"200":{"description":"All preview files from open productions with states equals to processing or broken"}},"tags":["Previews"]}},"/pictures/preview-files/{instance_id}":{"post":{"summary":"Main resource to add a preview.","description":"It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.","responses":{"200":{"description":"Preview added"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/movies/originals/preview-files/{instance_id}.mp4":{"get":{"summary":"Download a movie preview.","description":"It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.","responses":{"200":{"description":"Movie preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"File not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/movies/originals/preview-files/{instance_id}/download":{"get":{"summary":"Download a movie preview.","responses":{"200":{"description":"Movie preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"File not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/movies/low/preview-files/{instance_id}.mp4":{"get":{"summary":"Download a lowdef movie preview.","responses":{"200":{"description":"Lowdef movie preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"File not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails-square/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/originals/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/originals/preview-files/{instance_id}.{extension}":{"get":{"summary":"Download a generic file preview.","responses":{"200":{"description":"Generic file preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Non-movie file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"extension","required":true,"type":"string","x-example":"png, pdf, jpg, jpeg, ..."}],"tags":["Previews"]}},"/pictures/originals/preview-files/{instance_id}/download":{"get":{"summary":"Download a generic file preview as attachment.","responses":{"200":{"description":"Generic file preview downloaded as attachment"},"403":{"description":"Instance not allowed"},"404":{"description":"Standard file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/previews/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/movies/tiles/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/organisations/{instance_id}":{"post":{"summary":"Create a thumbnail for given object instance.","responses":{"200":{"description":"Thumbnail created"},"404":{"description":"Cannot found related object."}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/pictures/thumbnails/organisations/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/persons/{instance_id}":{"post":{"summary":"Create a thumbnail for given object instance.","responses":{"200":{"description":"Thumbnail created"},"404":{"description":"Cannot found related object."}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/pictures/thumbnails/persons/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/projects/{instance_id}":{"post":{"summary":"Create a thumbnail for given object instance.","responses":{"200":{"description":"Thumbnail created"},"404":{"description":"Cannot found related object."}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/pictures/thumbnails/projects/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/preview-background-files/{instance_id}":{"post":{"summary":"Main resource to add a preview background file.","responses":{"200":{"description":"Preview background file added"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Preview background file"],"consumes":["multipart/form-data","image/vnd.radiance"]}},"/pictures/thumbnails/preview-background-files/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/preview-background-files/{instance_id}.{extension}":{"get":{"summary":"Download a preview background file.","responses":{"200":{"description":"Preview background file downloaded"},"404":{"description":"Preview background file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"extension","required":true,"type":"string","format":"extension","x-example":"hdr"}],"tags":["Previews"]}},"/actions/entities/{entity_id}/set-main-preview/{preview_file_id}":{"put":{"summary":"Set main preview to given file.","responses":{"200":{"description":"Main preview set"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/set-main-preview":{"put":{"summary":"Set given preview as main preview of the related entity.","description":"This preview will be used to illustrate the entity.","responses":{"200":{"description":"Given preview set as main preview"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/extract-frame":{"get":{"summary":"Extract a frame from a preview_file","description":" ","responses":{"200":{"description":"Extracted frame"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/update-position":{"put":{"summary":"Allow to change orders of previews for a single revision.","description":"This preview will be used to illustrate the entity.","responses":{"200":{"description":"Orders of previews changed for a single revision"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/update-annotations":{"put":{"summary":"Allow to modify the annotations stored at the preview level.","description":"Modifications are applied via three fields:\n* `annotations` to give all the annotations that need to be added.\n\n* `updates` that list annotations that needs to be modified.\n\n* `deletions` to list the IDs of annotations that needs to be removed.\n","responses":{"200":{"description":"Orders of previews changed for a single revision"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/data/user/context":{"get":{"summary":"Return context required to properly run a full app connected to the API","description":"(like the Kitsu web client).
","responses":{"200":{"description":"Context to properly run a full app connected to the API"}},"tags":["User"]}},"/data/user/assets/{asset_id}/tasks":{"get":{"summary":"Return tasks related to given asset for current user.","responses":{"200":{"description":"Tasks related to given asset for current user"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/shots/{shot_id}/tasks":{"get":{"summary":"Return tasks related to given shot for current user.","responses":{"200":{"description":"Tasks related to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/scenes/{scene_id}/tasks":{"get":{"summary":"Return tasks related to given scene for current user.","responses":{"200":{"description":"Tasks related to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/tasks":{"get":{"summary":"Return tasks related to given sequence for current user.","responses":{"200":{"description":"Tasks related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/assets/{asset_id}/task-types":{"get":{"summary":"Return task types related to given asset for current user.","responses":{"200":{"description":"Task types related to given asset for current user"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/shots/{shot_id}/task-types":{"get":{"summary":"Return tasks related to given shot for current user.","responses":{"200":{"description":"Tasks related to given shot for current user"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/scenes/{scene_id}/task-types":{"get":{"summary":"Return tasks related to given scene for current user.","responses":{"200":{"description":"Tasks related to given scene for current user"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/task-types":{"get":{"summary":"Return tasks related to given sequence for current user.","responses":{"200":{"description":"Tasks related to given sequence for current user"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/open":{"get":{"summary":"Return open projects for which the user has at least one task assigned.","responses":{"200":{"description":"Open projects for which the user has at least one task assigned"}},"tags":["User"]}},"/data/user/projects/{project_id}/asset-types":{"get":{"summary":"Return asset types related to given project if the current user has","description":"access to it.
","responses":{"200":{"description":"Asset types related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/asset-types/{asset_type_id}/assets":{"get":{"summary":"Return assets of which type is given asset type and are listed in given","description":"project if user has access to this project.
","responses":{"200":{"description":"Assets of which type is given asset type and are listed in given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/sequences":{"get":{"summary":"Return sequences related to given project if the current user has access","description":"to it.
","responses":{"200":{"description":"Sequences related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/episodes":{"get":{"summary":"Return episodes related to given project if the current user has access","description":"to it.
","responses":{"200":{"description":"Episodes related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/shots":{"get":{"summary":"Return shots related to given sequence if the current user has access","description":"to it.
","responses":{"200":{"description":"Shots related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/scenes":{"get":{"summary":"Return scenes related to given sequence if the current user has access","description":"to it.
","responses":{"200":{"description":"Scenes related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/tasks":{"get":{"summary":"Return tasks currently assigned to current user and of which status has","description":"is_done attribute set to false.
","responses":{"200":{"description":"Unfinished tasks currently assigned to current user"}},"tags":["User"]}},"/data/user/tasks-to-check":{"get":{"summary":"Return tasks requiring feedback for current user departments.","description":"
If the user is not a supervisor, it returns an empty list.
","responses":{"200":{"description":"Tasks requiring feedback in current user departments."}},"tags":["User"]}},"/data/user/done-tasks":{"get":{"summary":"Return tasks currently assigned to current user and of which status has","description":"is_done attribute set to true.
","responses":{"200":{"description":"Finished tasks currently assigned to current user"}},"tags":["User"]}},"/data/user/filters":{"get":{"summary":"Retrieve filters for current user and only for open projects.","responses":{"200":{"description":"Filters for current user and only for open projects"}},"tags":["User"]},"post":{"summary":"Create filter for current user and only for open projects.","responses":{"201":{"description":"Filter for current user and only for open projects created"}},"parameters":[{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of filter"},{"in":"formData","name":"query","required":true,"type":"string"},{"in":"formData","name":"list_type","required":true,"type":"string"},{"in":"formData","name":"entity_type","required":false,"type":"string"},{"in":"formData","name":"project_id","required":true,"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/filters/{filter_id}":{"delete":{"summary":"Delete given filter if it's owned by current user.","responses":{"204":{"description":"Empty response"}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]},"put":{"summary":"Update given filter if it's owned by current user.","responses":{"200":{"description":"Given filter with updated data."}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/filter-groups":{"get":{"summary":"Retrieve filter groups for current user and only for open projects.","responses":{"200":{"description":"Filter groups for current user and only for open projects"}},"tags":["User"]},"post":{"summary":"Create filter group for current user and only for open projects.","responses":{"201":{"description":"Filter groups for the current user and only for open projects created."}},"parameters":[{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of filter"},{"in":"formData","name":"color","required":true,"type":"string"},{"in":"formData","name":"list_type","required":true,"type":"string"},{"in":"formData","name":"entity_type","required":false,"type":"string"},{"in":"formData","name":"project_id","required":true,"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/filter-groups/{filter_group_id}":{"delete":{"summary":"Delete given filter group if it's owned by the current user.","responses":{"204":{"description":"Empty response"}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]},"put":{"summary":"Update given filter group if it's owned by the current user.","responses":{"200":{"description":"Given filter group with updated data"}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]},"get":{"summary":"Retrieve given filter group for the current user.","responses":{"200":{"description":"Filter groups for the current user and only for open projects"}},"tags":["User"]}},"/data/user/desktop-login-logs":{"get":{"summary":"Retrieve desktop login logs.","responses":{"200":{"description":"Desktop login logs"}},"tags":["User"]},"post":{"summary":"Create a desktop login log.","description":"The desktop login log can only be created by the current user.","responses":{"201":{"description":"Desktop login log created"}},"parameters":[{"in":"formData","name":"date","type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]}},"/data/user/tasks/{task_id}/time-spents/{date}":{"get":{"summary":"Get time spents for current user and given date.","responses":{"200":{"description":"Time spents for current user and given date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]}},"/data/user/day-offs/{date}":{"get":{"summary":"Get day off object for current user and given date.","responses":{"200":{"description":"Day off object for current user and given date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]}},"/data/user/notifications":{"get":{"summary":"Return last 100 user notifications filtered by given parameters.","responses":{"200":{"description":"100 last user notifications"}},"parameters":[{"in":"formData","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"formData","name":"before","type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]}},"/data/user/notifications/{notification_id}":{"get":{"summary":"Return notification matching given id, only if it's a notification that","description":"belongs to current user.
","responses":{"200":{"description":"Notification matching given ID"}},"parameters":[{"in":"path","name":"notification_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/tasks/{task_id}/subscribed":{"get":{"summary":"Return true if current user has subscribed to given task.","responses":{"200":{"description":"True if current user has subscribed to given task, False otherwise"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/tasks/{task_id}/subscribe":{"post":{"summary":"Create a subscription entry for given task and current user.","description":"When a user subscribes, he gets notified everytime a comment is posted on the task.","responses":{"201":{"description":"Subscription entry created"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/tasks/{task_id}/unsubscribe":{"delete":{"summary":"Remove the subscription entry matching given task and current user.","description":"The user will no longer receive notifications for this task.","responses":{"204":{"description":"Subscription entry removed"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/clear-avatar":{"delete":{"summary":"Set `has_avatar` flag to False for current user and remove its avatar","description":"file.
","responses":{"204":{"description":"Avatar file deleted"}},"tags":["User"]}},"/data/user/entities/{sequence_id}/task-types/{task_type_id}/subscribed":{"get":{"summary":"Return true if current user has subscribed to given sequence and","description":"task type.
","responses":{"200":{"description":"True if current user has subscribed to given sequence and task type, False otherwise"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions":{"get":{"summary":"Return the list of sequence ids to which the current user has","description":"subscribed for given task type.
","responses":{"200":{"description":"List of sequence ids to which the current user has subscribed for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/sequences/{sequence_id}/task-types/{task_type_id}/subscribe":{"post":{"summary":"Create a subscription entry for given sequence,","description":"task type and current user.
","responses":{"201":{"description":"Subscription entry created"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/sequences/{sequence_id}/task-types/{task_type_id}/unsubscribe":{"delete":{"summary":"Remove a subscription entry for given sequence, tasl type","description":"and current user.
","responses":{"204":{"description":"Subscription entry removed"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/edits":{"get":{"summary":"Retrieve all edit entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All edit entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"name","required":false,"type":"string","x-example":"Name of edit"},{"in":"query","name":"force","required":false,"type":"boolean","default":false}],"tags":["Edits"]}},"/data/edits/all":{"get":{"summary":"Retrieve all edit entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All edit entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"name","required":false,"type":"string","x-example":"Name of edit"},{"in":"query","name":"force","required":false,"type":"boolean","default":false}],"tags":["Edits"]}},"/data/edits/with-tasks":{"get":{"summary":"Retrieve all edits, adds project name and all related tasks.","responses":{"200":{"description":"All edits and all related tasks."}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"name","required":false,"type":"string","x-example":"Name of edit"},{"in":"query","name":"force","required":false,"type":"boolean","default":false}],"tags":["Edits"]}},"/data/edits/{edit_id}":{"delete":{"summary":"Delete given edit.","responses":{"204":{"description":"Given edit deleted"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]},"get":{"summary":"Retrieve given edit.","responses":{"200":{"description":"Given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given edit.","responses":{"200":{"description":"All task types related to given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given edit.","responses":{"200":{"description":"All tasks related to given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given edit.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/versions":{"get":{"summary":"Retrieve data versions of given edit.","responses":{"200":{"description":"Data versions of given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/episodes/{episode_id}/edits":{"get":{"summary":"Retrieve all edits related to a given episode.","responses":{"200":{"description":"All efits related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/episodes/{episode_id}/edit-tasks":{"get":{"summary":"Retrieve all tasks related to a given episode.","responses":{"200":{"description":"All tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/projects/{project_id}/edits":{"get":{"summary":"Retrieve all edits related to a given project.","responses":{"200":{"description":"All edits related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]},"post":{"summary":"Create an edit for given project.","responses":{"201":{"description":"Edit created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of edit"},{"in":"formData","name":"description","type":"string","x-example":"Description of edit"},{"in":"formData","name":"episode_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/search":{"post":{"summary":"Search for resource","responses":{"200":{"description":"List of entities that contain the query"}},"parameters":[{"in":"formData","name":"query","required":true,"type":"string","x-example":"test will search for test"},{"in":"formData","name":"limit","required":false,"type":"integer","default":3,"x-example":3},{"in":"formData","name":"index_names","required":false,"type":"list of strings","default":["assets","shots","persons"],"x-example":["assets"]}],"tags":["Search"]}},"/data/concepts":{"get":{"summary":"Retrieve all concept entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All concept entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"parent_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/with-tasks":{"get":{"summary":"Retrieve all concepts, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All concepts"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}":{"delete":{"summary":"Delete given concept.","responses":{"204":{"description":"Given concept deleted"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]},"get":{"summary":"Retrieve given concept.","responses":{"200":{"description":"Given concept"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given concept.","responses":{"200":{"description":"All task types related to given concept"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given concept.","responses":{"200":{"description":"All tasks related to given concept"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given concept.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given episode"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/projects/{project_id}/concepts":{"get":{"summary":"Retrieve all concepts related to a given project.","responses":{"200":{"description":"All concepts related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]},"post":{"summary":"Create a concept for given project.","responses":{"201":{"description":"Concept created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of concept"},{"in":"formData","name":"description","type":"string","x-example":"Description of concept"},{"in":"formData","name":"entity_concept_links","type":"list of UUIDs","x-example":["a24a6ea4-ce75-4665-a070-57453082c25"]}],"tags":["Concepts"]}}},"definitions":{" Common fields for all model instances":{"type":"object","properties":{" id":{"type":"string","format":"UUID","description":"A unique ID made of letters, hyphens and numbers","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"created_at":{"type":"string","format":"date-time","description":"The creation date"},"updated_at":{"type":"string","format":"date-time","description":"The update date"}}},"Asset":{"type":"object","properties":{"name":{"type":"string","description":"Name of asset"},"code":{"type":"string","description":"Utility field for the pipeline to identify the asset"},"description":{"type":"string","description":"Asset brief"},"canceled":{"type":"boolean","default":"False","description":"True if the asset has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"entity_type_id":{"type":"string","format":"UUID","description":"Asset type ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"AssetInstance":{"type":"object","properties":{"asset_id":{"type":"string","format":"UUID","description":"Instantiated asset"},"name":{"type":"string"},"number":{"type":"integer"},"description":{"type":"string"},"active":{"type":"boolean","default":"True"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"scene_id":{"type":"string","format":"UUID","description":"Target scene"},"target_asset_id":{"type":"string","format":"UUID","description":"Use when instantiating an asset in an asset is required"}}},"AssetType":{"type":"object","properties":{"name":{"type":"string"}}},"AttachmentFile":{"type":"object","properties":{"name":{"type":"string","description":"Name of attachment file"},"size":{"type":"integer","description":"Size of attachment file"},"extension":{"type":"string","description":"Extension of attachment file"},"mimetype":{"type":"string"},"comment_id":{"type":"string","format":"UUID","description":"Comment to which the file is attached"}}},"BuildJob":{"type":"object","properties":{"status":{"type":"string","description":"Status of build job (running, failed, succeeded)"},"job_type":{"type":"string","description":"Type of build job (archive, movie)"},"ended_at":{"type":"string","format":"date-time"},"playlist_id":{"type":"string","format":"UUID","description":"Playlist ID"}}},"Comment":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"object_id":{"type":"string","format":"UUID","description":"Unique ID of the commented model instance"},"object_type":{"type":"string","description":"Model type of the comment model instance"},"text":{"type":"string"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"replies":{"type":"string","format":"json","default":"[]"},"checklist":{"type":"string","format":"json"},"pinned":{"type":"boolean"},"task_status_id":{"type":"string","format":"UUID","description":"Task status attached to comment"},"person_id":{"type":"string","format":"UUID","description":"The person who publishes the comment"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"}}},"CustomAction":{"type":"object","properties":{"name":{"type":"string","description":"Name of custom action"},"url":{"type":"string"},"entity_type":{"type":"string","default":"all"},"is_ajax":{"type":"boolean","default":"False","description":"True if the custom action is ajax, False otherwise"}}},"DataImportError":{"type":"object","properties":{"event_data":{"type":"string","format":"json","description":"JSON field to add event data"},"source":{"type":"array","items":{"type":"string","enum":["csv","shotgun"]}}}},"DayOff":{"type":"object","properties":{"date":{"type":"string","format":"date"},"person_id":{"type":"string","format":"UUID","description":"The person who will take the day off"}}},"Department":{"type":"object","properties":{"name":{"type":"string","description":"Name of department"},"color":{"type":"string","description":"Color of department"}}},"DesktopLoginLog":{"type":"object","properties":{"date":{"type":"string","format":"date"},"person_id":{"type":"string","format":"UUID","description":"Person ID"}}},"Episode":{"type":"object","properties":{"name":{"type":"string","description":"Name of episode"},"code":{"type":"string","description":"Utility field for the pipeline to identify the episode"},"description":{"type":"string","description":"Episode brief"},"canceled":{"type":"boolean","default":"False","description":"True if the episode has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"Event":{"type":"object","properties":{"name":{"type":"string","description":"Name of event"},"user_id":{"type":"string","format":"UUID","description":"The user who made the action that emitted the event"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"}}},"FileStatus":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}},"LoginLog":{"type":"object","properties":{"origin":{"type":"string","description":"web, script"},"ip_address":{"type":"string","description":"IP address of device used to login"},"person_id":{"type":"string","format":"UUID","description":"Person ID"}}},"Metadata":{"type":"object","properties":{"project_id":{"type":"string","format":"UUID","description":"ID of project for which metadata are added"},"entity_type":{"type":"string","description":"Asset or Shot"},"name":{"type":"string","description":"Field name for GUI"},"field_name":{"type":"string","description":"Technical field name"},"choices":{"type":"string","format":"json","description":"Array of string that represents the available values for this metadate (this metatada is considered as a free field if this array is empty)"},"for_client":{"type":"boolean"}}},"Milestone":{"type":"object","properties":{"data":{"type":"string","format":"date","description":"Milestone date of production schedule"},"name":{"type":"string","description":"Name of milestone"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"project_id":{"type":"string","format":"UUID","description":"Project ID"}}},"News":{"type":"object","properties":{"change":{"type":"boolean","default":"False"},"author_id":{"type":"string","format":"UUID","description":"Person who wrote the comment"},"comment_id":{"type":"string","format":"UUID","description":"Posted comment ID"},"task_id":{"type":"string","format":"UUID","description":"Task ID"},"preview_file_id":{"type":"string","format":"UUID","description":"Preview file ID"}}},"Notification":{"type":"object","properties":{"read":{"type":"boolean","description":"True if user read it, False otherwise"},"change":{"type":"boolean","description":"True if there is status change related to this status, False otherwise"},"person_id":{"type":"string","format":"UUID","description":"The user to who the notification is aimed at"},"author_id":{"type":"string","format":"UUID","description":"Author of the event to notify"},"comment_id":{"type":"string","format":"UUID","description":"Comment related to the notification, if there is any"},"task_id":{"type":"string","format":"UUID","description":"Task related to the notification, if there is any"},"reply_id":{"type":"string","format":"UUID","description":"Reply related to notification"},"type":{"type":"string","description":"Type of notification"}}},"Organisation":{"type":"object","properties":{"name":{"type":"string","description":"Name of organisaition"},"hours_by_day":{"type":"float"},"has_avatar":{"type":"boolean","default":"False","description":"True if the organisation has an avatar, Flase otherwise"},"use_original_file_name":{"type":"boolean","default":"False","description":"True if the organisation uses original file names, Flase otherwise"},"timesheets_locked":{"type":"boolean","default":"False","description":"True if the organisation's timesheets are locked, False otherwise"},"hd_by_default":{"type":"boolean","default":"False"},"chat_token_slack":{"type":"string"},"chat_webhook_mattermost":{"type":"string"},"chat_token_discord":{"type":"string"}}},"OutputFile":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"name":{"type":"string","description":"Name of output file"},"extension":{"type":"string","description":"Extension of output file"},"description":{"type":"string","description":"Output file brief"},"comment":{"type":"string","description":"Comment on output file"},"revision":{"type":"integer","description":"Revision number of output file"},"size":{"type":"integer","description":"Size of output file"},"checksum":{"type":"string","description":"Checksum of output file"},"source":{"type":"string","description":"Created by a script, a webgui or a desktop gui"},"path":{"type":"string","description":"File path on the production hard drive"},"representation":{"type":"string","description":"Precise what kind of output it is (abc, jpgs, pngs, etc.)"},"nb_elements":{"type":"integer","default":"1","description":"For image sequence"},"canceled":{"type":"boolean"},"file_status_id":{"type":"string","format":"UUID","description":"File status ID"},"entity_id":{"type":"string","format":"UUID","description":"Asset or Shot concerned by the output file"},"asset_instance_id":{"type":"string","format":"UUID","description":"Asset instance ID"},"output_type_id":{"type":"string","format":"UUID","description":"Type of output (geometry, cache, etc.)"},"task_type_id":{"type":"string","format":"UUID","description":"Task type related to this output file (modeling, animation, etc.)"},"person_id":{"type":"string","format":"UUID","description":"Author of the file"},"source_file_id":{"type":"string","format":"UUID","description":"Working file that led to create this output file"},"temporal_entity_id":{"type":"string","format":"UUID","description":"Shot, scene or sequence needed for output files related to an asset instance"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"}}},"OutputType":{"type":"object","properties":{"name":{"type":"string"},"short_name":{"type":"string"}}},"Person":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","description":"Serve as login"},"phone":{"type":"string"},"active":{"type":"boolean","description":"True if the person is still in the studio, False otherwise"},"last_presence":{"type":"string","format":"date","description":"Last time the person worked for the studio"},"password":{"type":"string","format":"byte"},"desktop_login":{"type":"string","description":"Login used on desktop"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"timezone":{"type":"string"},"locale":{"type":"string"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"role":{"type":"string","default":"user"},"has_avatar":{"type":"boolean","default":"False","description":"True if user has an avatar, Flase otherwise"},"notifications_enabled":{"type":"boolean"},"notifications_slack_enabled":{"type":"boolean"},"notifications_slack_userid":{"type":"string"},"notifications_mattermost_enabled":{"type":"boolean"},"notifications_mattermost_userid":{"type":"string"},"notifications_discord_enabled":{"type":"boolean"},"notifications_discord_userid":{"type":"string"}}},"Playlist":{"type":"object","properties":{"name":{"type":"string","description":"Name of playlist"},"shots":{"type":"string","format":"json","description":"JSON field describing shot and preview listed in"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"episode_id":{"type":"string","format":"UUID","description":"Episode ID"},"for_client":{"type":"boolean","default":"False"},"for_entity":{"type":"string","default":"shot"},"is_for_all":{"type":"boolean","default":"False"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"}}},"PreviewFile":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"name":{"type":"string","description":"Name of preview file"},"original_name":{"type":"string","description":"Original name of preview file"},"revision":{"type":"integer","default":"1","description":"Revision number of preview file"},"position":{"type":"integer","default":"1","description":"Position of preview file"},"extension":{"type":"string","description":"Extension of preview file"},"description":{"type":"string","description":"Preview file brief"},"path":{"type":"string","description":"File path on the production hard drive"},"source":{"type":"string","description":"Created by a script, a webgui or a desktop gui"},"file_size":{"type":"integer","default":"0","description":"Size of output file"},"comment":{"type":"string","description":"Comment on output file"},"checksum":{"type":"string","description":"Checksum of output file"},"representation":{"type":"string","description":"Precise what kind of output it is (abc, jpgs, pngs, etc.)"},"nb_elements":{"type":"integer","default":"1","description":"For image sequence"},"canceled":{"type":"boolean"},"file_status_id":{"type":"string","format":"UUID","description":"File status ID"},"entity_id":{"type":"string","format":"UUID","description":"Asset or Shot concerned by the output file"},"asset_instance_id":{"type":"string","format":"UUID","description":"Asset instance ID"},"output_type_id":{"type":"string","format":"UUID","description":"Type of output (geometry, cache, etc.)"},"task_type_id":{"type":"string","format":"UUID","description":"Task type related to this output file (modeling, animation, etc.)"},"person_id":{"type":"string","format":"UUID","description":"Author of the file"},"source_file_id":{"type":"string","format":"UUID","description":"Working file that led to create this output file"},"temporal_entity_id":{"type":"string","format":"UUID","description":"Shot, scene or sequence needed for output files related to an asset instance"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"}}},"Project":{"type":"object","properties":{"name":{"type":"string","description":"Name of project"},"code":{"type":"string","description":"Utility field for the pipeline to identify the project"},"description":{"type":"string","description":"Project brief"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"file_tree":{"type":"string","format":"json","description":"Templates to use to build file paths"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"project_status_id":{"type":"string","format":"UUID","description":"Project status ID"},"has_avatar":{"type":"boolean","default":"False","description":"True if the project has an avatar, False otherwise"},"fps":{"type":"string","description":"Frames per second"},"ratio":{"type":"string"},"resolution":{"type":"string"},"production_type":{"type":"string","description":"short, featurefilm or tvshow","default":"short"},"end_date":{"type":"string","format":"date"},"start_date":{"type":"string","format":"date"},"man_days":{"type":"integer","description":"Estimated number of working days to complete the project"},"nb_episodes":{"type":"integer","default":"0"},"episode_span":{"type":"integer","default":"0"},"max_retakes":{"type":"integer","default":"0"},"is_clients_isolated":{"type":"boolean","default":"False","description":"True if the clients are isolated from the project, False otherwise"}}},"ProjectStatus":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}},"ScheduleItem":{"type":"object","properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"man_days":{"type":"string","format":"date"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"object_id":{"type":"string","format":"UUID","description":"Object ID"}}},"SearchFilter":{"type":"object","properties":{"list_type":{"type":"string","description":"Type of list"},"entity_type":{"type":"string","description":"Type of entity"},"name":{"type":"string","description":"Name of search filter"},"search_query":{"type":"string"},"person_id":{"type":"string","format":"UUID","description":"Person ID"},"project_id":{"type":"string","format":"UUID","description":"Project ID"}}},"Sequence":{"type":"object","properties":{"name":{"type":"string","description":"Name of sequence"},"code":{"type":"string","description":"Utility field for the pipeline to identify the sequence"},"description":{"type":"string","description":"Sequence brief"},"canceled":{"type":"boolean","default":"False","description":"True if the sequence has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"parent_id":{"type":"string","format":"UUID","description":"Episode ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"Shot":{"type":"object","properties":{"name":{"type":"string","description":"Name of shot"},"code":{"type":"string","description":"Utility field for the pipeline to identify the shot"},"description":{"type":"string","description":"Shot brief"},"canceled":{"type":"boolean","default":"False","description":"True if the shot has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"parent_id":{"type":"string","format":"UUID","description":"Episode ID"},"entity_type_id":{"type":"string","format":"UUID","description":"Shot type ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"Software":{"type":"object","properties":{"name":{"type":"string","description":"Name of software"},"short_name":{"type":"string","description":"Short name of software"},"file_extension":{"type":"string","description":"Main extension used for this software's files"},"secondary_extensions":{"type":"string","format":"json","description":"Other extensions used for this software's files"}}},"StatusAutomation":{"type":"object","properties":{"entity_type":{"type":"string","default":"asset"},"in_task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"in_task_status_id":{"type":"string","format":"UUID","description":"Task status ID"},"out_field_type":{"type":"string","description":"Field type (status, ready_for)"},"out_task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"out_task_status_id":{"type":"string","format":"UUID","description":"Task status ID"}}},"SubscriptionToNotifications":{"type":"object","properties":{"person_id":{"type":"string","format":"UUID","description":"Person ID"},"task_id":{"type":"string","format":"UUID","description":"Task ID"},"entity_id":{"type":"string","format":"UUID","description":"Entity ID"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"}}},"Task":{"type":"object","properties":{"name":{"type":"string","description":"Name of task"},"description":{"type":"string","description":"Task brief"},"priority":{"type":"integer","default":"0","description":"Priority of task"},"duration":{"type":"float","default":"0","description":"Duration of task"},"estimation":{"type":"float","default":"0","description":"Estimation of duration of task"},"completion_rate":{"type":"integer","default":"0","description":"Completion rate of task"},"retake_count":{"type":"integer","default":"0","description":"Retake count of task"},"sort_order":{"type":"integer","default":"0","description":"Sort order of task"},"start_date":{"type":"string","format":"date-time"},"due_date":{"type":"string","format":"date-time"},"real_start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"last_comment_date":{"type":"string","format":"date-time"},"nb_assets_ready":{"type":"integer","default":"0","description":"Number of assets ready"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"task_status_id":{"type":"string","format":"UUID","description":"Task status ID"},"entity_id":{"type":"string","format":"UUID","description":"Entity ID"},"assigner_id":{"type":"string","format":"UUID","description":"Person ID"}}},"TaskStatus":{"type":"object","properties":{"name":{"type":"string","description":"Name of task status"},"short_name":{"type":"string","description":"Short name of task status"},"color":{"type":"string"},"is_done":{"type":"boolean","default":"False","description":"True if the task is done, False otherwise"},"is_artist_allowed":{"type":"boolean","default":"True","description":"True if the artist is allowed, False otherwise"},"is_client_allowed":{"type":"boolean","default":"True","description":"True if the client is allowed, False otherwise"},"is_retake":{"type":"boolean","default":"False","description":"True if the task was retaken, False otherwise"},"is_feedback_request":{"type":"boolean","default":"False","description":"True if feedback was requested, False otherwise"},"is_default":{"type":"boolean","default":"False","description":"True if the task is default, False otherwise"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"TaskType":{"type":"object","properties":{"name":{"type":"string","description":"Name of task type"},"short_name":{"type":"string","description":"Short name of task type"},"color":{"type":"string","default":"#FFFFFF"},"priority":{"type":"integer","default":"1","description":"Priority of task type"},"for_entity":{"type":"string","default":"Asset"},"allow_timelog":{"type":"boolean","default":"True","description":"True if timelog is allowed, False otherwise"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"department_id":{"type":"string","format":"UUID","description":"Department ID"}}},"TimeSpent":{"type":"object","properties":{"duration":{"type":"float"},"date":{"type":"string","format":"date"},"task_id":{"type":"string","format":"UUID","description":"Related task ID"},"person_id":{"type":"string","format":"UUID","description":"The person who performed the working time"}}},"WorkingFile":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"name":{"type":"string","description":"Name of working file"},"description":{"type":"string","description":"working file brief"},"comment":{"type":"string","description":"Comment on working file"},"revision":{"type":"integer","description":"Revision number of working file"},"size":{"type":"integer","description":"Size of working file"},"checksum":{"type":"string","description":"Checksum of working file"},"path":{"type":"string","description":"File path on the production hard drive"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"task_id":{"type":"string","format":"UUID","description":"Task for which the working file is made"},"entity_id":{"type":"string","format":"UUID","description":"Entity for which the working is made"},"person_id":{"type":"string","format":"UUID","description":"Author of the file"},"software_id":{"type":"string","format":"UUID","description":"Software used to build this working file"}}}},"swagger":"2.0","openapi":"3.1","externalDocs":{"description":"Read the installation documentation","url":"https://zou.cg-wire.com"},"host":"localhost:8080","basePath":"/api","schemes":["http","https"],"securityDefinitions":{"JWT Authorization":{"name":"Authorization","in":"header","type":"apiKey","description":"Format in header: **Authorization: Bearer {token}**. \n\n Value example: Bearer xxxxx.yyyyy.zzzzz"}},"security":[{"JWT Authorization":[]}],"tags":[{"name":"Authentication"},{"name":"Assets"},{"name":"Breakdown"},{"name":"Comments"},{"name":"Crud"},{"name":"Edits"},{"name":"Entities"},{"name":"Events"},{"name":"Export"},{"name":"Files"},{"name":"Import"},{"name":"Index"},{"name":"News"},{"name":"Persons"},{"name":"Playlists"},{"name":"Previews"},{"name":"Projects"},{"name":"Search"},{"name":"Shots"},{"name":"Tasks"},{"name":"User"}]} \ No newline at end of file +{"info":{"title":"Kitsu API","description":"\n## Welcome to the Kitsu API specification\n```Version: 0.18.8```\n\nThe Kitsu API allows to store and manage the data of your animation/VFX production. Through it you can link all the tools of your pipeline and make sure they are all synchronized.\n\nAn easy to use Python client to access this API is available:\n[Python Kitsu Client documentation](https://gazu.cg-wire.com/)\n\n## Authentication

\n\n

Before you can use any of the endpoints outline below,\nyou will have to get a JWT token to authorize your requests.\n\nYou can get a authorization token using a (form-encoded) POST request to ```/auth/login```.\nWith curl this would look something like ```curl -X POST /auth/login -d \"email=&password=```.\n\nThe response is a JSON object, specifically you'll need to provide the ```access_token``` for your future requests.\n\nHere is a complete authentication process as an example (again using curl):\n```\n$ curl -X POST /api/auth/login -d \"email=&password=\"'\n{\"login\": true\", \"access_token\": \"eyJ0e...\", ...}\n$ jwt=eyJ0e... # Store the access token for easier use\n$ curl -H \"Authorization: Bearer $jwt\" /api/data/projects\n[{...},\n{...}]\n```\n[OpenAPI definition](/openapi.json)\n","contact":{"name":"CGWire","url":"https://www.cg-wire.com"},"version":"0.18.8","license":{"name":"AGPL 3.0","url":"https://www.gnu.org/licenses/agpl-3.0.en.html"}},"paths":{"/auth/login":{"post":{"summary":"Log in user by creating and registering auth tokens.","description":"Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.","responses":{"200":{"description":"Login successful"},"400":{"description":"Login failed"},"500":{"description":"Database not reachable"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"password","required":true,"type":"string","format":"password","x-example":"mysecretpassword"},{"in":"formData","name":"otp","required":false,"type":"string","format":"password","x-example":123456}],"tags":["Authentication"]}},"/auth/logout":{"get":{"summary":"Log user out by revoking his auth tokens.","description":"Once logged out, current user cannot access the API anymore.","responses":{"200":{"description":"Logout successful"},"500":{"description":"Access token not found"}},"tags":["Authentication"]}},"/auth/authenticated":{"get":{"summary":"Returns information if the user is authenticated else it returns a 401","description":"response.
","responses":{"200":{"description":"User authenticated"},"401":{"description":"Person not found"}},"tags":["Authentication"]}},"/auth/register":{"post":{"summary":"Allow a user to register himself to the service.","responses":{"201":{"description":"Registration successful"},"400":{"description":"Invalid password or email"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password_2","required":true,"type":"string","format":"password"},{"in":"formData","name":"first_name","required":true,"type":"string"},{"in":"formData","name":"last_name","required":true,"type":"string"}],"tags":["Authentication"]}},"/auth/change-password":{"post":{"summary":"Allow the user to change his password.","description":"Prior to modifying the password, it requires to give the current password (to make sure the user changing the password is not someone who stealed the session). The new password requires a confirmation to ensure that the user didn't make a mistake by typing his new password.","responses":{"200":{"description":"Password changed"},"400":{"description":"Invalid password or inactive user"}},"parameters":[{"in":"formData","name":"old_password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password_2","required":true,"type":"string","format":"password"}],"tags":["Authentication"]}},"/auth/reset-password":{"post":{"summary":"Resource to allow a user to change his password when he forgets it.","description":"It uses a classic scheme: a token is sent by email to the user. Then he can change his password.","responses":{"200":{"description":"Reset token sent"},"400":{"description":"Email not listed in database"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"}],"tags":["Authentication"]},"put":{"summary":"Resource to allow a user to change his password when he forgets it.","description":"It uses a classic scheme: a token is sent by email to the user. Then he can change his password.","responses":{"200":{"description":"Password reset"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"token","required":true,"type":"string","format":"JWT token"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password2","required":true,"type":"string","format":"password"}],"tags":["Authentication"]}},"/auth/refresh-token":{"get":{"summary":"Tokens are considered as outdated every two weeks.","description":"This route allows to make their lifetime long before they get outdated.","responses":{"200":{"description":"Access Token"}},"tags":["Authentication"]}},"/auth/totp":{"delete":{"summary":"Resource to allow a user to disable TOTP.","responses":{"200":{"description":"TOTP disabled"},"400":{"description":"TOTP not enabled"}},"tags":["Authentication"]},"post":{"summary":"Resource to allow a user to enable TOTP.","responses":{"200":{"description":"TOTP enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"put":{"summary":"Resource to allow a user to pre-enable TOTP.","responses":{"200":{"description":"TOTP enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/auth/email-otp":{"delete":{"summary":"Resource to allow a user to disable OTP by email.","responses":{"200":{"description":"OTP by email disabled."},"400":{"description":"Invalid password. Wrong or expired token. Inactive user. Wrong 2FA."}},"tags":["Authentication"]},"post":{"summary":"Resource to allow a user to enable OTP by email.","responses":{"200":{"description":"OTP by email enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"get":{"summary":"Resource to send an OTP by email to user.","responses":{"200":{"description":"OTP by email sent"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"put":{"summary":"Resource to allow a user to pre-enable OTP by email.","responses":{"200":{"description":"OTP by email enabled"},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/auth/recovery-codes":{"put":{"summary":"Resource to allow a user to generate new recovery codes.","responses":{"200":{"description":"new recovery codes."},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/auth/fido":{"delete":{"summary":"Resource to allow a user to unregister a FIDO device.","responses":{"200":{"description":"FIDO device unregistered."},"400":{"description":"Invalid password Wrong or expired token Inactive user Wrong 2FA"}},"tags":["Authentication"]},"post":{"summary":"Resource to allow a user to register a FIDO device.","responses":{"200":{"description":"FIDO device registered."},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]},"get":{"summary":"Resource to get a challenge for a FIDO device.","responses":{"200":{"description":"Challenge for FIDO device."},"400":{"description":"Wrong parameter."}},"tags":["Authentication"]},"put":{"summary":"Resource to allow a user to pre-register a FIDO device.","responses":{"200":{"description":"FIDO device pre-registered."},"400":{"description":"Invalid password Wrong or expired token Inactive user"}},"tags":["Authentication"]}},"/data/asset-types":{"get":{"summary":"Retrieve all asset types (entity types that are not shot, sequence or episode).","responses":{"200":{"description":"All asset types"}},"tags":["Assets"]}},"/data/asset-types/{asset_type_id}":{"get":{"summary":"Retrieve given asset type.","responses":{"200":{"description":"Given asset type"}},"parameters":[{"in":"path","name":"asset_type_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/assets":{"get":{"summary":"Retrieve all entities that are not shot or sequence.","description":"Adds project name and asset type name.
","responses":{"200":{"description":"All assets"}},"tags":["Assets"]}},"/data/assets/all":{"get":{"summary":"Retrieve all entities that are not shot or sequence.","description":"Adds project name and asset type name.
","responses":{"200":{"description":"All assets"}},"tags":["Assets"]}},"/data/assets/with-tasks":{"get":{"summary":"Retrieve all entities that are not shot or sequence.","description":"Adds project name and asset type name and all related tasks. If episode_id is given as parameter, it returns assets not linked to an episode and assets linked to given episode.","responses":{"200":{"description":"All assets with tasks"}},"tags":["Assets"]}},"/data/assets/{asset_id}":{"delete":{"summary":"Delete given asset.","responses":{"204":{"description":"Given asset deleted"}},"parameters":[{"in":"path","name":"asset_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]},"get":{"summary":"Retrieve given asset.","responses":{"200":{"description":"Given asset"}},"parameters":[{"in":"path","name":"asset_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/assets/{asset_id}/assets":{"get":{"summary":"Retrieve all assets for a given asset.","responses":{"200":{"description":"All assets for a given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given shot.","responses":{"200":{"description":"All tasks related to given shot"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given asset.","responses":{"200":{"description":"All task types related to given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/cast-in":{"get":{"summary":"Resource to retrieve the casting of a given asset.","responses":{"200":{"description":"Casting of given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/casting":{"get":{"summary":"Resource to retrieve the casting of a given asset.","responses":{"200":{"description":"Casting of given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]},"put":{"summary":"Resource to allow the modification of assets linked to a asset.","responses":{"200":{"description":"Modification of assets linked to given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/shot-asset-instances":{"get":{"summary":"Retrieve all shot asset instances linked to asset.","responses":{"200":{"description":"All shot asset instances linked to asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/scene-asset-instances":{"get":{"summary":"Retrieve all scene asset instances linked to asset.","responses":{"200":{"description":"All scene asset instances linked to asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/assets/{asset_id}/asset-asset-instances":{"post":{"summary":"Create an asset instance inside given asset.","responses":{"201":{"description":"Asset instance created inside given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]},"get":{"summary":"Retrieve all asset instances instantiated inside this asset.","responses":{"200":{"description":"All asset instances instantiated inside given asset"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/projects/{project_id}/asset-types/{asset_type_id}/assets":{"get":{"summary":"Retrieve all assets for given project and entity type.","responses":{"200":{"description":"All assets for given project and entity type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Assets"]}},"/data/projects/{project_id}/asset-types/{asset_type_id}/assets/new":{"post":{"summary":"Create new asset resource.","responses":{"201":{"description":"New asset resource created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Asset","description":"Name, description, data and ID of asset","schema":{"type":"object","required":["name","description","data","source_id"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"data":{"type":"string"},"source_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Assets"]}},"/data/projects/{project_id}/asset-types":{"get":{"summary":"Retrieve all asset types for given project.","responses":{"200":{"description":"All asset types for given project"}},"parameters":[{"in":"path","name":"project_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/shots/{shot_id}/asset-types":{"get":{"summary":"Retrieve all asset shots for given shot.","responses":{"200":{"description":"All asset shots for given shot"}},"parameters":[{"in":"path","name":"shot_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/projects/{project_id}/assets":{"get":{"summary":"Retrieve all assets for given project.","responses":{"200":{"description":"All assets for given project"}},"parameters":[{"in":"path","name":"project_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true}],"tags":["Assets"]}},"/data/projects/{project_id}/entities/{entity_id}/casting":{"get":{"summary":"Resource to retrieve the casting of a given entity.","responses":{"200":{"description":"Casting of given entity"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]},"put":{"summary":"Resource to allow the modification of assets linked to an entity.","responses":{"200":{"description":"Modification of assets linked to an entity"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/asset-types/{asset_type_id}/casting":{"get":{"summary":"Resource to retrieve the casting of assets from given asset type.","responses":{"200":{"description":"Casting of assets from given asset type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/episodes/casting":{"get":{"summary":"Resource to retrieve the casting of episodes.","responses":{"200":{"description":"Casting of episodes"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/sequences/{sequence_id}/casting":{"get":{"summary":"Resource to retrieve the casting of shots from given sequence.","responses":{"200":{"description":"Casting of shots from given sequence"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting":{"get":{"summary":"Resource to retrieve the casting of shots from given episode.","responses":{"200":{"description":"Casting for all shots from given episode."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/sequences/all/casting":{"get":{"summary":"Resource to retrieve the casting of shots from all sequences of given","description":"project.
","responses":{"200":{"description":"Casting for all shots from given project."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/entity-links":{"get":{"summary":"Retrieve all entity links related to given project.","description":"
Results can be paginated using page and limit query parameters. If you
prefer a more accurate pagination, you can use and
cursor_created_at to get the next page.
","responses":{"200":{"description":"All entity links related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"page","required":false,"type":"string","format":"Number","x-example":2},{"in":"limit","name":"page","required":false,"type":"string","format":"Number","x-example":100},{"in":"cursor_created_at","name":"page","required":false,"type":"string","format":"Datetime","x-example":"2020-01-01T00:00:00"}],"tags":["Breakdown"]}},"/data/projects/{project_id}/entity-links/{entity_link_id}":{"delete":{"summary":"Delete given entity link.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"Entity link deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"entity_link_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/scenes/{scene_id}/asset-instances":{"post":{"summary":"Create an asset instance on given scene.","responses":{"201":{"description":"Asset instances created on given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]},"get":{"summary":"Retrieve all asset instances linked to scene.","responses":{"200":{"description":"All asset instances linked to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/scenes/{scene_id}/camera-instances":{"get":{"summary":"Retrieve all camera instances linked to scene.","responses":{"201":{"description":"All camera instances linked to scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/shots/{shot_id}/asset-instances":{"post":{"summary":"Add an asset instance to given shot.","responses":{"201":{"description":"Asset instance added to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]},"get":{"summary":"Retrieve all asset instances linked to shot.","responses":{"200":{"description":"All assets linked to shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/shots/{shot_id}/asset-instances/{asset_instance_id}":{"delete":{"summary":"Remove an asset instance from given shot.","responses":{"204":{"description":"Asset instance removed from given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Breakdown"]}},"/data/tasks/{task_id}/comments/{comment_id}/ack":{"post":{"summary":"Acknowledge given comment.","description":"If it's already acknowledged, remove acknowledgement.","responses":{"200":{"description":"Comment acknowledged"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/tasks/{task_id}/comments/{comment_id}/reply":{"post":{"summary":"Reply to given comment.","description":"Add comment to its replies list.","responses":{"200":{"description":"Reply to given comment"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"text","type":"string","x-example":"comment"}],"tags":["Comments"]}},"/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}":{"delete":{"summary":"Delete attachment linked to a comment matching given ID.","responses":{"204":{"description":"Empty response"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"attachment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}":{"delete":{"summary":"Delete given comment reply.","responses":{"200":{"description":"Given comment reply deleted"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"reply_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/attachment-files/{attachment_file_id}/file/{file_name}":{"get":{"summary":"Download attachment file.","responses":{"200":{"description":"Attachment file downloaded","schema":{"type":"file"}},"404":{"description":"Download failed"}},"parameters":[{"in":"path","name":"attachment_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"file_name","required":true,"type":"string","x-example":"filename"}],"tags":["Comments"],"produces":["multipart/form-data","image/png","image/gif","image/jpeg"]}},"/actions/tasks/{task_id}/comments/{comment_id}/add-attachment":{"post":{"summary":"Add given files to the comment entry as attachments.","responses":{"201":{"description":"Given files added to the comment entry as attachments"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"files","type":"file","required":true}],"tags":["Comments"],"consumes":["image/png","image/gif","image/jpeg","multipart/form-data"]}},"/data/projects/{project_id}/attachment-files":{"get":{"summary":"Return all attachment files related to given project.","responses":{"200":{"description":"All attachment files related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/data/tasks/{task_id}/attachment-files":{"get":{"summary":"Return all attachment files related to given task.","responses":{"200":{"description":"All attachment files related to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Comments"]}},"/actions/tasks/{task_id}/comment":{"post":{"summary":"Create a new comment for given task.","description":"It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.","responses":{"201":{"description":"New comment created"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Comment","description":"person ID, name, comment, revision and change status of task","schema":{"type":"object","required":["task_status_id"],"properties":{"task_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"created_at":{"type":"string","format":"date-time","example":"2022-07-12T13:00:00"},"checklist":{"type":"object","properties":{"item 1":{"type":"string"}}}}}}],"tags":["Comments"]}},"/actions/projects/{project_id}/tasks/comment-many":{"post":{"summary":"Create several comments at once.","description":"Each comment requires a text, a task id, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.","responses":{"201":{"description":"Given files added to the comment entry as attachments"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Comment","description":"person ID, name, comment, revision and change status of task","schema":{"type":"object","required":["task_status_id"],"properties":{"task_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"object_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"},"created_at":{"type":"string","format":"date-time","example":"2022-07-12T13:00:00"},"checklist":{"type":"object","properties":{"item 1":{"type":"string"}}}}}}],"tags":["Comments"]}},"/data/persons":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/persons/{instance_id}":{"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/projects":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/projects/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/project-status":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/project-status/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/entity-types":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/entity-types/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/entities":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/entities/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]}},"/data/task-types":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/task-types/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/task-status":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/task-status/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/tasks":{"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/tasks/{instance_id}":{"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/departments":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/departments/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/organisations":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/organisations/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/file-status/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/file-status/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/softwares":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/softwares/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a software corresponding at given ID and return it as a","description":"JSON object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"software_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/output-files":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/output-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON","description":"object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"output_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/output-types":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/output-types/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve an output type corresponding at given ID and return it as a","description":"JSON object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/preview-files":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/preview-files/{instance_id}":{"delete":{"summary":"Delete a preview file corresponding at given ID and retuns","description":"a 204 status code.
","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/working-files":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/working-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a working file corresponding at given ID and return it as a","description":"JSON object.
","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/attachment-files":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/attachment-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/comments":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/comments/{instance_id}":{"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/time-spents/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/time-spents/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/day-offs/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/day-offs/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/custom-actions/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/custom-actions/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/status-automations/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/status-automations/{instance_id}":{"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/asset-instances/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/asset-instances/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/playlists/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/playlists/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/events/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/events/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/notifications/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/notifications/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/search-filters/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/search-filters/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/search-filter-groups/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/search-filter-groups/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/schedule-items/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/schedule-items/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/news/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/news/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/milestones/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/milestones/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/metadata-descriptors/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/metadata-descriptors/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/subscriptions/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/subscriptions/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/entity-links/":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/entity-links/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/preview-background-files":{"post":{"summary":"Create a model with data given in the request body.","description":"JSON format is expected. The model performs the validation automatically when instantiated.","responses":{"200":{"description":"Model created"},"400":{"description":"Error"}},"parameters":[{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]},"get":{"summary":"Retrieve all entries for given model.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All entries for given model"},"400":{"description":"Format error"},"403":{"description":"Permission denied"}},"tags":["Crud"]}},"/data/preview-background-files/{instance_id}":{"delete":{"summary":"Delete a model corresponding at given ID and return it as a JSON object.","responses":{"204":{"description":"Model deleted"},"400":{"description":"Statement or integrity error"},"404":{"description":"Instance non-existant"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"get":{"summary":"Retrieve a model corresponding at given ID and return it as a JSON object.","responses":{"200":{"description":"Model as a JSON object"},"400":{"description":"Statement error"},"404":{"description":"Value error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Crud"]},"put":{"summary":"Update a model with data given in the request body.","description":"JSON format is expected. Model performs the validation automatically when fields are modified.","responses":{"200":{"description":"Model updated"},"400":{"description":"Error"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Model","schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"},"nb_pages":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"page":{"type":"integer"}}}}],"tags":["Crud"]}},"/data/entities/{entity_id}/news":{"get":{"summary":"Retrieve all news linked to a given entity.","responses":{"200":{"description":"All news linked to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entities"]}},"/data/entities/{entity_id}/preview-files":{"get":{"summary":"Retrieve all preview files linked to a given entity.","responses":{"200":{"description":"All preview files linked to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entities"]}},"/data/entities/{entity_id}/time-spents":{"get":{"summary":"Retrieve all time spents linked to a given entity.","responses":{"200":{"description":"All time spents linked to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entities"]}},"/data/entities/{entity_id}/entities-linked/with-tasks":{"get":{"summary":"Resource to retrieve the entities linked on a given entity.","responses":{"200":{"description":"Entities linked on given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Entity"]}},"/export/csv/projects/{project_id}/assets.csv":{"get":{"summary":"Export assets linked to a given project as csv.","responses":{"200":{"description":"Assets exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/projects/{project_id}/shots.csv":{"get":{"summary":"Export shots linked to a given project as csv.","responses":{"200":{"description":"Shots exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/projects/{project_id}/casting.csv":{"get":{"summary":"Export casting linked to a given project as csv.","responses":{"200":{"description":"Casting exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/projects/{project_id}/edits.csv":{"get":{"summary":"Export edits linked to a given project as csv.","responses":{"200":{"description":"Edits exported as csv"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/playlists/{playlist_id}":{"get":{"summary":"Export a given playlist as csv.","responses":{"200":{"description":"Playlist exported as csv"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Export"]}},"/export/csv/persons.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/projects.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/tasks.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/time-spents.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/export/csv/task-types.csv":{"get":{"summary":"Export as csv.","responses":{"200":{"description":"Exported as csv"}},"tags":["Export"]}},"/data/events/last":{"get":{"summary":"Retrieve last events.","responses":{"200":{"description":"All login logs"}},"parameters":[{"in":"query","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"only_files","type":"boolean","default":false},{"in":"query","name":"page_size","type":"integer","default":100,"x-example":100},{"in":"query","name":"project_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Events"]}},"/data/events/login-logs/last":{"get":{"summary":"Retrieve all login logs.","responses":{"200":{"description":"All login logs"}},"parameters":[{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12T00:00:00"},{"in":"query","name":"page_size","type":"integer","x-example":100}],"tags":["Events"]}},"/data/files/{file_id}":{"get":{"summary":"Get information about a file that could be a working file as much as an","description":"output file.
","responses":{"200":{"description":"Information about file"}},"parameters":[{"in":"path","name":"file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/tasks/{task_id}/working-files":{"get":{"summary":"Return last working files revision for each file name for given task.","responses":{"200":{"description":"Last working files revision for each file name for given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/tasks/{task_id}/working-files/new":{"post":{"summary":"Create new working file.","description":"A working file is a file used to produce output files. It is the file the CG artist is working on. It is versioned, tied to a task and a software and requires a comment each time it is created. A path is generated for each file created. The path format is defined in the file tree template file.","responses":{"201":{"description":"New working file created","schema":{"type":"file"}},"400":{"description":"Given working file already exists"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, mode, description, comment, person ID, software ID, revision and separator.","schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"mode":{"type":"string","default":"working"},"description":{"type":"string"},"comment":{"type":"string"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"software_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"revision":{"type":"integer"},"sep":{"type":"string","default":"/"}}}}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]}},"/data/tasks/{task_id}/working-files/last-revisions":{"get":{"summary":"Return last working files revision for each file name for given task.","responses":{"200":{"description":"Last working files revision for each file name for given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/tasks/{task_id}/working-file-path":{"post":{"summary":"Generate a working file path from file tree template.","description":"Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.","responses":{"200":{"description":"Working file path generated"},"400":{"description":"Malformed file tree"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, software, mode, revision and separator.","schema":{"type":"object","properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"working"},"software_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"revision":{"type":"integer"},"separator":{"type":"string","default":"/"}}}}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new":{"post":{"summary":"Create new output file linked to assets through an instance of this asset for a given shot.","description":"Some output files are linked to assets through an instance of this asset for a given shot. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target instance. It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file.","responses":{"200":{"description":"New output file created","schema":{"type":"file"}},"400":{"description":"Given output file already exists Given person not found Given output type not found"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, mode, output type ID, task type ID, person ID, working file ID, file status ID, comment, extension, representation, revision, number of elements and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"working_file_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"file_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"is_sequence":{"type":"boolean","default":false},"comment":{"type":"string"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"nb_elements":{"type":"integer","default":1},"sep":{"type":"string","default":"/"}}}}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision":{"post":{"summary":"Get next revision for given asset instance, output type, task type and name.","responses":{"200":{"description":"Next revision for given asset instance, output type, task type and name"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, output type ID, task type ID.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions":{"get":{"summary":"Get last revisions of output files for given instance grouped by output type and file name.","responses":{"200":{"description":"Last revisions of output files for given instance grouped by output type and file name"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types":{"get":{"summary":"Return all types of output generated for given instance.","responses":{"200":{"description":"All types of output generated for given instance and temporal_entity"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files":{"get":{"summary":"Get all output files for given asset instance and given output type.","responses":{"200":{"description":"All output files for given asset instance and given output type"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path":{"post":{"summary":"Generate an output file path from file tree template","description":"Generate file path based on several parameters: asset instance, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision in case no revision is given in parameter.","responses":{"200":{"description":"Output file path generated"},"400":{"description":"Malformed file tree"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Asset instance, output type, task type, revision, mode, name and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"separator":{"type":"string","default":"/"}}}}],"tags":["Files"]}},"/data/entities/{entity_id}/working-files":{"get":{"summary":"Get all working files for a given entity and possibly a task and a name.","responses":{"200":{"description":"All working files for given entity and possibly a task and a name"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-files/new":{"post":{"summary":"Create new output file linked to a given entity.","description":"Output files are linked to entities. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target entity (an asset, a shot, a sequence, ...). It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file. Revision is automatically set.","responses":{"200":{"description":"New output file created","schema":{"type":"file"}},"400":{"description":"Given output file already exists Given person not found Given output type not found"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, mode, output type ID, task type ID, person ID, working file ID, file status ID, comment, extension, representation, revision, number of elements and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"working_file_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"file_status_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"nb_elements":{"type":"integer","default":1},"sep":{"type":"string","default":"/"}}}}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]}},"/data/entities/{entity_id}/output-files/next-revision":{"post":{"summary":"Get next revision for given entity, output type, task type and name.","responses":{"200":{"description":"Next revision for given entity, output type, task type and name"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Name, output type ID, task type ID.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Files"]}},"/data/entities/{entity_id}/output-files/last-revisions":{"get":{"summary":"Get last revisions of output files for given entity grouped by output type and file name.","responses":{"200":{"description":"Last revisions of output files for given entity grouped by output type and file name"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-types":{"get":{"summary":"Return all types of output generated for given entity.","responses":{"200":{"description":"All types of output generated for given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-types/{output_type_id}/output-files":{"get":{"summary":"Get all output files for given entity and given output type.","responses":{"200":{"description":"All output files for given entity and given output type"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-files":{"get":{"summary":"Get all output files for given entity.","responses":{"200":{"description":"All output files for given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/projects/{project_id}/output-files":{"get":{"summary":"Get all output files for given poject.","responses":{"200":{"description":"All output files for given project."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/asset-instances/{asset_instance_id}/output-files":{"get":{"summary":"Get all output files for given asset instance and given output type.","responses":{"200":{"description":"All output files for given asset instance and given temporal entity (shot, sequence, etc.)"}},"parameters":[{"in":"path","name":"asset_instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"temporal_entity_id","required":true,"type":"string","format":"UUID","x-example":"cache"},{"in":"query","name":"output_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"file_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"representation","required":true,"type":"string","format":"UUID","x-example":"cache"}],"tags":["Files"]}},"/data/entities/{entity_id}/output-file-path":{"post":{"summary":"Generate an output file path from file tree template","description":"Generate file path based on several parameters: entity, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision if not given.","responses":{"200":{"description":"Output file path generated"},"400":{"description":"Malformed file tree"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"File","description":"Entity, output type, task type, revision, mode, name and separator.","schema":{"type":"object","required":["output_type_id","task_type_id"],"properties":{"name":{"type":"string","default":"main"},"mode":{"type":"string","default":"output"},"output_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"task_type_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"extension":{"type":"string"},"representation":{"type":"string"},"revision":{"type":"integer"},"separator":{"type":"string","default":"/"}}}}],"tags":["Files"]}},"/data/working-files/{working_file_id}/file":{"post":{"summary":"Store a working file.","responses":{"201":{"description":"Working file stored"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Files"]},"get":{"summary":"Download a working file.","responses":{"200":{"description":"Working file downloaded","schema":{"type":"file"}}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"],"produces":["image/png","image/jpg","image/gif","multipart/form-data"]}},"/actions/projects/{project_id}/set-file-tree":{"post":{"summary":"Define a template file to use for given project.","description":"Template files are located on the server side. Each template has a name which means that you just have to give a name to \"select\" the template to link with the project.","responses":{"200":{"description":"Template file defined"},"400":{"description":"Selected tree not available"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Tree name","schema":{"type":"object","required":["tree_name"],"properties":{"tree_name":{"type":"string"}}}}],"tags":["Files"]}},"/actions/working-files/{working_file_id}/comment":{"put":{"summary":"Update comment on given working file.","responses":{"200":{"description":"Comment updated on given working file"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Comment","schema":{"type":"object","required":["comment"],"properties":{"comment":{"type":"string"}}}}],"tags":["Files"]}},"/actions/working-files/{working_file_id}/modified":{"put":{"summary":"Update working file modification date with current date.","responses":{"200":{"description":"Working file modification date updated"}},"parameters":[{"in":"path","name":"working_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Files"]}},"/import/shotgun/persons":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/projects":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/episodes":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/sequences":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/shots":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/scenes":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/assets":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/steps":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/status":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/tasks":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/versions":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/notes":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/errors":{"post":{"summary":"Serialize shotgun error resource.","responses":{"200":{"description":"Resource serialized"}},"tags":["Import"]},"get":{"summary":"Import shotgun error resource.","responses":{"200":{"description":"Resource imported"}},"tags":["Import"]}},"/import/shotgun/projectconnections":{"post":{"summary":"Import shotgun resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"sg_entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/shotgun/errors/{error_id}":{"delete":{"summary":"Delete error.","responses":{"204":{"description":"Error deleted"},"404":{"description":"Error non-existant or Statement error"}},"parameters":[{"in":"path","name":"error_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"]}},"/import/shotgun/remove/project":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/person":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/shot":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/scene":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/episode":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/sequence":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/asset":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/projectconnection":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/step":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/status":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/task":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/note":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/shotgun/remove/version":{"post":{"summary":"Import remove instance.","responses":{"204":{"description":"Instance removed"}},"tags":["Import"]}},"/import/csv/persons":{"post":{"summary":"Import persons via a .csv file.","responses":{"201":{"description":"The lists of imported persons."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/assets":{"post":{"summary":"Import project assets via a .csv file.","responses":{"201":{"description":"The lists of imported assets."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/shots":{"post":{"summary":"Import project shots via a .csv file.","responses":{"201":{"description":"The lists of imported assets."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/edits":{"post":{"summary":"Import project edits.","responses":{"201":{"description":"Edits imported"},"400":{"description":"Format error"}},"parameters":[{"in":"formData","name":"file","type":"file","required":true},{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/casting":{"post":{"summary":"Import project casting links via a .csv file.","responses":{"201":{"description":"The lists of imported casting links."},"400":{"description":"The .csv file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations":{"post":{"summary":"Import the estimations of task-types for given project.","responses":{"201":{"description":"Estimations imported"},"400":{"description":"Format error"}},"parameters":[{"in":"formData","name":"file","type":"file","required":true},{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations":{"post":{"summary":"Import the estimations of task-types for given episode of given project.","responses":{"201":{"description":"Estimations imported"},"400":{"description":"Format error"}},"parameters":[{"in":"formData","name":"file","type":"file","required":true},{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/edl/projects/{project_id}":{"post":{"summary":"Import an EDL file to enter frame_in / frame_out / nb_frames.","responses":{"201":{"description":"."},"400":{"description":"The .EDL file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/edl/projects/{project_id}/episodes/{episode_id}":{"post":{"summary":"Import an EDL file to enter frame_in / frame_out / nb_frames.","responses":{"201":{"description":"."},"400":{"description":"The .EDL file is not properly formatted."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Import"],"consumes":["multipart/form-data"]}},"/import/kitsu/comments":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/entities":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/entity-links":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/projects":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/import/kitsu/tasks":{"post":{"summary":"Import Kitsu resource.","responses":{"200":{"description":"Resource imported"}},"parameters":[{"in":"body","name":"entries","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}],"tags":["Import"]}},"/":{"get":{"summary":"Get API name and version.","responses":{"200":{"description":"API name and version"}},"tags":["Index"]}},"/status":{"get":{"summary":"Retrieve API name, version and status.","responses":{"200":{"description":"API name, version and status"}},"tags":["Index"]}},"/status/influx":{"get":{"summary":"Retrieve status of database and time.","responses":{"200":{"description":"Status of database, key value, event stream, job queue and time"}},"tags":["Index"]}},"/status/resources":{"get":{"summary":"Retrieve date and CPU, memory and jobs stats.","responses":{"200":{"description":"Date and CPU, memory and jobs stats"}},"tags":["Index"]}},"/status.txt":{"get":{"summary":"Retrieve API name, version and status as txt.","responses":{"200":{"description":"API name, version and status as txt"}},"tags":["Index"]}},"/status/test-event":{"get":{"summary":"Generate a main:test event.","responses":{"200":{"description":"Success flage"}},"tags":["Index"]}},"/stats":{"get":{"summary":"Retrieve main stats.","responses":{"403":{"description":"Permission denied"},"200":{"description":"Main stats"}},"tags":["Index"]}},"/config":{"get":{"summary":"Get crisp token.","responses":{"200":{"description":"Crisp token"}},"tags":["Index"]}},"/data/projects/news":{"get":{"summary":"Retrieve all news related to a given project","responses":{"200":{"description":"All news from user open projects."}},"parameters":[{"in":"query","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"page","type":"integer","x-example":1},{"in":"query","name":"page_size","type":"integer","x-example":50},{"in":"query","name":"person_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_status_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"episode_id","type":"boolean","default":false},{"in":"query","name":"only_preview","type":"boolean","default":false}],"tags":["News"]}},"/data/projects/{project_id}/news":{"get":{"summary":"Retrieve all news related to a given project","responses":{"200":{"description":"All news related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"before","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"query","name":"page","type":"integer","x-example":1},{"in":"query","name":"page_size","type":"integer","x-example":50},{"in":"query","name":"person_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_type_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"task_status_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"episode_id","type":"boolean","default":false},{"in":"query","name":"only_preview","type":"boolean","default":false}],"tags":["News"]}},"/data/projects/{project_id}/news/{news_id}":{"get":{"summary":"Retrieve a single given news related to a given project","responses":{"200":{"description":"Single given news related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"news_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["News"]}},"/data/persons/new":{"post":{"summary":"Create a new user in the database.","description":"Set password to None if not provided. User role can be set but only admins can create admin users.","responses":{"201":{"description":"User created"}},"parameters":[{"in":"formData","name":"email","required":true,"type":"string","format":"email","x-example":"admin@example.com"},{"in":"formData","name":"phone","required":false,"type":"integer","x-example":"06 12 34 56 78"},{"in":"formData","name":"role","required":false,"type":"string","x-example":"user"},{"in":"formData","name":"first_name","required":true,"type":"string"},{"in":"formData","name":"last_name","required":false,"type":"string"}],"tags":["Persons"]}},"/data/persons/{person_id}/desktop-login-logs":{"post":{"summary":"Create desktop login logs.","description":"Add a new log entry for desktop logins.","responses":{"201":{"description":"Desktop login log entry created."}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Persons"]},"get":{"summary":"Retrieve desktop login logs.","description":"Desktop login logs can only be created by current user.","responses":{"200":{"description":"Desktop login logs"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/data/persons/presence-logs/{month_date}":{"get":{"summary":"Return a csv file containing the presence logs based on a daily basis.","responses":{"200":{"description":"CSV file containing the presence logs based on a daily basis"}},"parameters":[{"in":"path","name":"month_date","required":true,"type":"string","format":"date","x-example":"2022-07"}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/{date}":{"get":{"summary":"Get time spents for given person and date.","responses":{"200":{"description":"Time spents for given person and date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/{date}":{"get":{"summary":"Get day off object for given person and date.","responses":{"200":{"description":"Day off object for given person and date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/year/{year}":{"get":{"summary":"Get aggregated time spents for given person and year.","responses":{"200":{"description":"Aggregated time spents for given person and year"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/month/{year}/{month}":{"get":{"summary":"Get aggregated time spents for given person and month.","responses":{"200":{"description":"Aggregated time spents for given person and month"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/week/{year}/{week}":{"get":{"summary":"Get aggregated time spents for given person and week.","responses":{"200":{"description":"Aggregated time spents for given person and week"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"week","required":true,"type":"integer","x-example":35,"minimum":1,"maximum":52}],"tags":["Persons"]}},"/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}":{"get":{"summary":"Get aggregated time spents for given person and day.","responses":{"200":{"description":"Aggregated time spents for given person and day"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12},{"in":"path","name":"day","required":true,"type":"integer","x-example":12,"minimum":1,"maximum":31}],"tags":["Persons"]}},"/data/persons/{person_id}/quota-shots/month/{year}/{month}":{"get":{"summary":"Get ended shots used for quota calculation of this month.","responses":{"200":{"description":"Ended shots used for quota calculation of this month"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/quota-shots/week/{year}/{week}":{"get":{"summary":"Get ended shots used for quota calculation of this week.","responses":{"200":{"description":"Ended shots used for quota calculation of this week"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"week","required":true,"type":"integer","x-example":35,"minimum":1,"maximum":52}],"tags":["Persons"]}},"/data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}":{"get":{"summary":"Get ended shots used for quota calculation of this day.","responses":{"200":{"description":"Ended shots used for quota calculation of this day"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12},{"in":"path","name":"day","required":true,"type":"integer","x-example":12,"minimum":1,"maximum":31}],"tags":["Persons"]}},"/data/persons/time-spents/year-table/":{"get":{"summary":"Return a table giving time spent by user and by month for given year.","responses":{"200":{"description":"Table giving time spent by user and by month for given year"}},"tags":["Persons"]}},"/data/persons/time-spents/month-table/{year}":{"get":{"summary":"Return a table giving time spent by user and by month for given year.","responses":{"200":{"description":"Table giving time spent by user and by month for given year"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/data/persons/time-spents/week-table/{year}":{"get":{"summary":"Return a table giving time spent by user and by week for given year.","responses":{"200":{"description":"Table giving time spent by user and by week for given year"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/data/persons/time-spents/day-table/{year}/{month}":{"get":{"summary":"Return a table giving time spent by user and by day for given year and month.","responses":{"200":{"description":"Table giving time spent by user and by day for given year and month"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/day-offs/{year}/{month}":{"get":{"summary":"Return all day off recorded for given month.","responses":{"200":{"description":"All day off recorded for given month"}},"parameters":[{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/week/{year}/{week}":{"get":{"summary":"Return all day off recorded for given week and person.","responses":{"200":{"description":"All day off recorded for given week and person"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"week","required":true,"type":"integer","x-example":35,"minimum":1,"maximum":52}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/month/{year}/{month}":{"get":{"summary":"Return all day off recorded for given month and person.","responses":{"200":{"description":"All day off recorded for given month and person"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"},{"in":"path","name":"month","required":true,"type":"integer","x-example":7,"minimum":1,"maximum":12}],"tags":["Persons"]}},"/data/persons/{person_id}/day-offs/year/{year}":{"get":{"summary":"Return all day off recorded for given year and person.","responses":{"200":{"description":"All day off recorded for given year and person"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"year","required":true,"type":"integer","x-example":"2022"}],"tags":["Persons"]}},"/actions/persons/{person_id}/invite":{"get":{"summary":"Sends an email to given person to invite him/her to connect to Kitsu.","responses":{"200":{"description":"Email sent"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/departments/add":{"post":{"summary":"Add a user to given department.","responses":{"201":{"description":"User added to given department"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/departments/{department_id}":{"delete":{"summary":"Remove a user from given department.","responses":{"204":{"description":"User removed from given department"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"department_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/change-password":{"post":{"summary":"Allow admin to change password for given user.","description":"Prior to modifying the password, it requires to be admin. An admin can't change other admins password. The new password requires a confirmation to ensure that the admin didn't make a mistake by typing the new password.","responses":{"200":{"description":"Password changed"},"400":{"description":"Invalid password or inactive user"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"password","required":true,"type":"string","format":"password"},{"in":"formData","name":"password_2","required":true,"type":"string","format":"password"}],"tags":["Persons"]}},"/actions/persons/{person_id}/disable-two-factor-authentication":{"delete":{"summary":"Allow admin to disable two factor authentication for given user.","description":"Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.","responses":{"200":{"description":"Two factor authentication disabled"},"400":{"description":"Inactive user"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Persons"]}},"/actions/persons/{person_id}/clear-avatar":{"delete":{"summary":"Set `has_avatar` flag to False for current user and remove its avatar","description":"file.
","responses":{"204":{"description":"Avatar file deleted"}},"tags":["User"]}},"/data/projects/{project_id}/playlists":{"get":{"summary":"Retrieve all playlists related to given project.","description":"Result is paginated and can be sorted.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/playlists/all":{"get":{"summary":"Retrieve all playlists related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/episodes/{episode_id}/playlists":{"get":{"summary":"Retrieve all playlists related to given episode.","description":"The full list is returned because the number of playlists in an episode is not that big.","responses":{"200":{"description":"All playlists related to given episode"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/playlists/{playlist_id}":{"get":{"summary":"Retrieve all playlists related to given project.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/playlists/entities/{entity_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given entity.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given entity"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/playlists/{playlist_id}/jobs/{build_job_id}":{"delete":{"summary":"Remove given build job related to given playlist.","responses":{"204":{"description":"Given build job removed"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"build_job_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]},"get":{"summary":"Retrieve build job related to given playlist.","responses":{"200":{"description":"Build job related to given playlist"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"build_job_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/{project_id}/build-jobs":{"get":{"summary":"Retrieve all build jobs related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All build jobs related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/playlists/{playlist_id}/build/mp4":{"get":{"summary":"Build given playlist as mp4 movie.","responses":{"200":{"description":"Given playlist built as mp4 movie"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"],"produces":["multipart/form-data"]}},"/data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4":{"get":{"summary":"Download given playlist build as .mp4.","responses":{"200":{"description":"Given playlist build downloaded as .mp4"},"400":{"description":"Build not finished, need to retry later"}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"build_job_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"],"produces":["multipart/form-data"]}},"/data/playlists/{playlist_id}/download/zip":{"get":{"summary":"Download given playlist as zip.","responses":{"200":{"description":"Given playlist downloaded as zip","schema":{"type":"file"}}},"parameters":[{"in":"path","name":"playlist_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"],"produces":["multipart/form-data"]}},"/data/projects/{project_id}/playlists/temp":{"post":{"summary":"Retrieve all playlists related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All playlists related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Playlists"]}},"/data/projects/open":{"get":{"summary":"Return the list of projects currently running.","description":"Most of the time, past projects are not needed.","responses":{"200":{"description":"All running projects"}},"tags":["Projects"]}},"/data/projects/all":{"get":{"summary":"Return all projects listed in database.","description":"Ensure that user has at least the manager level before that.","responses":{"200":{"description":"All projects listed in database"}},"tags":["Projects"]}},"/data/projects/{project_id}/team":{"post":{"summary":"Add a person to a production team.","responses":{"201":{"description":"Person added to the production team"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"get":{"summary":"Return the people listed in a production team.","responses":{"200":{"description":"People listed in a production team"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/task-types":{"get":{"summary":"Retrieve task types linked to the production","responses":{"200":{"description":"Task types linked to the production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/team/{person_id}":{"delete":{"summary":"Remove people listed in a production team.","responses":{"204":{"description":"Person removed from production team"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/asset-types":{"post":{"summary":"Add an asset type linked to a production.","responses":{"201":{"description":"Asset type added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/asset-types/{asset_type_id}":{"delete":{"summary":"Remove an asset type from a production.","responses":{"204":{"description":"Asset type removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-types":{"post":{"summary":"Add a task type linked to a production.","responses":{"201":{"description":"Asset type added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"priority","required":false,"type":"string","default":"None"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-types/{task_type_id}":{"delete":{"summary":"Remove a task type from a production.","responses":{"204":{"description":"Task type removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-status":{"post":{"summary":"Add a task type linked to a production.","responses":{"201":{"description":"Task type added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"task_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"get":{"summary":"Return task statuses linked to a production","responses":{"200":{"description":"Task statuses linked to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/task-status/{task_status_id}":{"delete":{"summary":"Remove a task status from a production.","responses":{"204":{"description":"Task status removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_status_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/status-automations":{"post":{"summary":"Add a status automation linked to a production.","responses":{"201":{"description":"Status automation added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"status_automation_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"get":{"summary":"Get a status automation linked to a production.","responses":{"200":{"description":"Status automation linked to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/status-automations/{status_automation_id}":{"delete":{"summary":"Remove a status automation from a production.","responses":{"204":{"description":"Status automation removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"status_automation_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}":{"delete":{"summary":"Remove a preview background file from a production.","responses":{"204":{"description":"Preview background file removed from production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_background_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/settings/preview-background-files":{"post":{"summary":"Add a preview background file linked to a production.","responses":{"201":{"description":"Preview background file added to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"preview_background_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"get":{"summary":"Return preview background files linked to a production","responses":{"200":{"description":"Preview background files linked to production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/metadata-descriptors":{"post":{"summary":"Create a new metadata descriptor","description":"It serves to describe extra fields listed in the data attribute of entities.","responses":{"201":{"description":"Create a new metadata descriptor"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"get":{"summary":"Get all metadata descriptors","description":"It serves to describe extra fields listed in the data attribute of entities.","responses":{"200":{"description":"All metadata descriptors"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/metadata-descriptors/{descriptor_id}":{"delete":{"summary":"Delete a metadata descriptor.","description":"Descriptors serve to describe extra fields listed in the data attribute of entities.","responses":{"204":{"description":"Metadata descriptor deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"descriptor_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"get":{"summary":"Get a metadata descriptor.","description":"Descriptors serve to describe extra fields listed in the data attribute of entities.","responses":{"200":{"description":"Metadata descriptor"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"descriptor_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]},"put":{"summary":"Update a metadata descriptor.","description":"Descriptors serve to describe extra fields listed in the data attribute of entities.","responses":{"200":{"description":"Metadata descriptor updated"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"descriptor_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":false,"type":"string"},{"in":"formData","name":"for_client","required":false,"type":"boolean","default":false},{"in":"formData","name":"choices","required":false,"type":"array"},{"in":"formData","name":"departments","type":"array","required":false}],"tags":["Projects"]}},"/data/projects/{project_id}/milestones":{"get":{"summary":"Retrieve milestones for given production","responses":{"200":{"description":"All milestones of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items":{"get":{"summary":"Retrieve schedule items for given production","responses":{"200":{"description":"All schedule items of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/task-types":{"get":{"summary":"Retrieve task type schedule items for given production","responses":{"200":{"description":"All task types schedule items of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/{task_type_id}/asset-types":{"get":{"summary":"Retrieve asset types schedule items for given task type","responses":{"200":{"description":"All asset types schedule items for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/{task_type_id}/episodes":{"get":{"summary":"Retrieve episodes schedule items for given task type","responses":{"200":{"description":"All episodes schedule items for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/schedule-items/{task_type_id}/sequences":{"get":{"summary":"Retrieve sequences schedule items for given task type","responses":{"200":{"description":"All sequences schedule items for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/projects/{project_id}/time-spents":{"get":{"summary":"Retrieve time spents for given production","responses":{"200":{"description":"All time spents of given production"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Projects"]}},"/data/shots":{"get":{"summary":"Retrieve all shot entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All shot entries"}},"parameters":[{"in":"query","name":"sequence_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"parent_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/all":{"get":{"summary":"Retrieve all shot entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All shot entries"}},"parameters":[{"in":"query","name":"sequence_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"parent_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/with-tasks":{"get":{"summary":"Retrieve all shots, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All shots"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}":{"delete":{"summary":"Delete given shot.","responses":{"204":{"description":"Given shot deleted"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given shot.","responses":{"200":{"description":"Given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/assets":{"get":{"summary":"Retrieve all assets for a given shot.","responses":{"200":{"description":"All assets for given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given shot.","responses":{"200":{"description":"All task types related to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given shot.","responses":{"200":{"description":"All tasks related to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given shot.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given episode"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/shots/{shot_id}/versions":{"get":{"summary":"Retrieve data versions of given shot.","responses":{"204":{"description":"Data versions of given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/all":{"get":{"summary":"Retrieve all scene entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All scene entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/with-tasks":{"get":{"summary":"Retrieve all scenes, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All scenes"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}":{"delete":{"summary":"Delete given scene.","responses":{"204":{"description":"Given scene deleted"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given scene.","responses":{"200":{"description":"Given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given scene.","responses":{"200":{"description":"All tasks related to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given scene.","responses":{"200":{"description":"All task types related to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/shots":{"post":{"summary":"Mark given scene as source of given shot.","responses":{"200":{"description":"Given scene marked as source of given shot"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"shot_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve all shots that come from given scene.","responses":{"200":{"description":"All shots that come from given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/scenes/{scene_id}/shots/{shot_id}":{"delete":{"summary":"Delete given shot from given scene.","responses":{"204":{"description":"Given shot deleted from given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes":{"get":{"summary":"Retrieve all episode entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All episode entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/with-tasks":{"get":{"summary":"Retrieve all episodes, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All episodes"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}":{"delete":{"summary":"Delete given episode.","responses":{"204":{"description":"Given episode deleted"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given episode.","responses":{"200":{"description":"Given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/shots":{"get":{"summary":"Retrieve all shots related to a given episode.","responses":{"200":{"description":"All shots related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/sequences":{"get":{"summary":"Retrieve all sequence entries for a given episode.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All sequence entries for given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given episode.","responses":{"200":{"description":"All tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given episode.","responses":{"200":{"description":"All task types related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/shot-tasks":{"get":{"summary":"Retrieve all shots tasks related to a given episode.","responses":{"200":{"description":"All shots tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/episodes/{episode_id}/asset-tasks":{"get":{"summary":"Retrieve all assets tasks related to a given episode.","responses":{"200":{"description":"All assets tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences":{"get":{"summary":"Retrieve all sequence entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All sequence entries"}},"parameters":[{"in":"query","name":"episode_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/with-tasks":{"get":{"summary":"Retrieve all sequences, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All sequences"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}":{"delete":{"summary":"Delete given sequence.","responses":{"204":{"description":"Given sequence deleted"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve given sequence.","responses":{"200":{"description":"Given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/shots":{"get":{"summary":"Retrieve all shot entries for a given sequence.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All shot entries for given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/scenes":{"get":{"summary":"Retrieve all scenes related to a given sequence.","responses":{"200":{"description":"All scenes related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given shot.","responses":{"200":{"description":"All tasks related to given shot"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given shot.","responses":{"200":{"description":"All task types related to given shot"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/sequences/{sequence_id}/shot-tasks":{"get":{"summary":"Retrieve all tasks related to a given sequence.","responses":{"200":{"description":"All task types related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/shots":{"post":{"summary":"Create a shot for given project.","responses":{"201":{"description":"Shot created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of shot"},{"in":"formData","name":"description","type":"string","x-example":"Description of shot"},{"in":"formData","name":"sequence_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"nb_frames","type":"integer"}],"tags":["Shots"]},"get":{"summary":"Retrieve all shots related to a given project.","responses":{"200":{"description":"All shots related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/scenes":{"post":{"summary":"Create a scene for given project.","responses":{"201":{"description":"Scene created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of scene"},{"in":"formData","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve all scenes related to a given project.","responses":{"200":{"description":"All scenes related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/sequences":{"post":{"summary":"Create a sequence for given project.","responses":{"201":{"description":"Sequence created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of sequence"},{"in":"formData","name":"episode_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]},"get":{"summary":"Retrieve all sequences related to a given project.","responses":{"200":{"description":"All sequences related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/episodes":{"post":{"summary":"Create an episode for given project.","responses":{"201":{"description":"Episode created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of the episode"},{"in":"formData","name":"description","required":true,"type":"string","x-example":"Description of the episode"}],"tags":["Shots"]},"get":{"summary":"Retrieve all episodes related to a given project.","responses":{"200":{"description":"All episodes related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/episodes/stats":{"get":{"summary":"Retrieve number of tasks by status, task_types and episodes for given project.","responses":{"200":{"description":"Number of tasks by status, task types and episodes for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/episodes/retake-stats":{"get":{"summary":"Retrieve number of tasks by status, task_types and episodes for given project.","responses":{"200":{"description":"Number of tasks by status, task types and episodes for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/projects/{project_id}/quotas/{task_type_id}":{"get":{"summary":"Retrieve quotas statistics for shots.","responses":{"200":{"description":"Quotas statistics for shots"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Shots"]}},"/data/tasks/{task_id}/comments":{"get":{"summary":"Return comments linked to given task.","responses":{"200":{"description":"Comments linked to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/tasks/{task_id}/comments/{comment_id}":{"delete":{"summary":"Delete a comment corresponding at given ID.","responses":{"204":{"description":"Comment corresponding at given ID deleted"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]},"get":{"summary":"Get comment corresponding at given ID.","responses":{"200":{"description":"Comment corresponding at given ID"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/tasks/{task_id}/previews":{"get":{"summary":"Return previews linked to given task.","responses":{"200":{"description":"Previews linked to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/tasks/{task_id}/full":{"get":{"summary":"Return a task with many information.","description":"Full details for assignees, full details for task type, full details for task status, etc.","responses":{"200":{"description":"Task with many information"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/{person_id}/tasks":{"get":{"summary":"Return task assigned to given user of which status has is_done flag sets to false.","responses":{"200":{"description":"Tasks assigned to user that are not done"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/{person_id}/related-tasks/{task_type_id}":{"get":{"summary":"For all entities assigned to given person (that have at least one task assigned to given person), returns all tasks for given task type.","responses":{"200":{"description":"All Tasks for given task type"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/{person_id}/done-tasks":{"get":{"summary":"Return task assigned to given user of which status has is_done flag sets to true.","description":"It return only tasks related to open projects.","responses":{"200":{"description":"Tasks assigned to user that are done"}},"parameters":[{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/entities/{entity_id}/task-types/{task_type_id}/tasks":{"get":{"summary":"Return tasks related to given entity asset, episode, sequence, shot or scene.","responses":{"200":{"description":"Tasks related to given entity asset, episode, sequence, shot or scene"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/comments":{"get":{"summary":"Retrieve all comments to tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All comments to tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/notifications":{"get":{"summary":"Retrieve all notifications to tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All notifications to tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/preview-files":{"get":{"summary":"Preview files related to a given project.","responses":{"200":{"description":"Preview files related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/subscriptions":{"get":{"summary":"Retrieve all subcriptions to tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All subcriptions to tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/projects/{project_id}/tasks":{"get":{"summary":"Retrieve all tasks related to given project.","description":"It's mainly used for synchronisation purpose.","responses":{"200":{"description":"All tasks related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/data/persons/task-dates":{"get":{"summary":"For schedule usages, for each active person, it returns the first start","description":"date of all tasks of assigned to this person and the last end date.
","responses":{"200":{"description":"For each person, the first start date of all tasks of assigned to this person and the last end date."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks":{"delete":{"summary":"Delete all tasks for a given task type and project.","description":"It's mainly used when tasks are created by mistake at the beginning of the project.","responses":{"204":{"description":"All tasks for given task type and project deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/delete-tasks":{"post":{"summary":"Delete tasks matching id list given in parameter.","description":"See it as a way to batch delete tasks.","responses":{"200":{"description":"Tasks matching id list given in parameter deleted"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/assign":{"put":{"summary":"Assign given task list to given person.","responses":{"200":{"description":"Given task assigned to given person"},"400":{"description":"Assignee non-existent in database"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Person","description":"Person ID","schema":{"type":"object","required":["person_id"],"properties":{"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Tasks"]}},"/actions/tasks/clear-assignation":{"put":{"summary":"Remove all assignations set to given task.","responses":{"200":{"description":"All assignations removed"}},"parameters":[{"in":"body","name":"Task","description":"List of tasks ID and person ID","schema":{"type":"object","required":["task_ids"],"properties":{"task_ids":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Tasks"]}},"/actions/persons/{person_id}/assign":{"put":{"summary":"Assign given task lists to given person.","description":"If a given task ID is wrong, it ignores it.","responses":{"200":{"description":"Given tasks lists assigned to given person"}},"parameters":[{"in":"path","name":"person_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25","required":true},{"in":"body","name":"Task","description":"List of tasks ID","schema":{"type":"object","required":["task_ids"],"properties":{"task_ids":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents/{date}":{"get":{"summary":"Get time spent on a given task and date.","responses":{"200":{"description":"Time spent on given task and date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents":{"get":{"summary":"Get time spent on a given task.","responses":{"200":{"description":"Time spent on given task"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}":{"post":{"summary":"Set time spent by a person on a task for a given day.","responses":{"201":{"description":"Time spent by given person on given task for given day is set"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"},{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Duration","schema":{"type":"object","properties":{"duration":{"type":"float"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add":{"post":{"summary":"Add given timeframe to time spent by a person on a task for a given day.","responses":{"201":{"description":"Given timeframe added to time spent by given person on given task for given day"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"},{"in":"path","name":"person_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Duration","schema":{"type":"object","properties":{"duration":{"type":"float"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/comments/{comment_id}/add-preview":{"post":{"summary":"Add preview metadata to given task. The preview file itself should be","description":"uploaded afterward.

Revision is automatically set: it is equal to last revision + 1. It can
be also set manually.
","responses":{"201":{"description":"Preview metadata added to given task"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","schema":{"type":"object","properties":{"revision":{"type":"integer"}}}}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}":{"delete":{"summary":"Delete preview from given comment.","responses":{"204":{"description":"Preview deleted from given comment"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]},"post":{"summary":"Add a preview to given comment.","responses":{"201":{"description":"Preview added to given comment"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"comment_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","type":"file","required":true}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/to-review":{"put":{"summary":"Change a task status to \"to review\".","description":"It creates a new preview file entry and set path from the hard disk.","responses":{"200":{"description":"Task status changed to \"to review\""},"400":{"description":"Given person not found"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"body","name":"Task","description":"person ID, name, comment, revision and change status of task","schema":{"type":"object","properties":{"person_id":{"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"comment":{"type":"string"},"name":{"type":"string"},"revision":{"type":"integer"},"change_status":{"type":"boolean"}}}}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks":{"post":{"summary":"Create a new task for given shot and task type.","responses":{"201":{"description":"New task for given shot and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks":{"post":{"summary":"Create a new task for given asset and task type.","responses":{"201":{"description":"New task for given asset and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/edits/create-tasks":{"post":{"summary":"Create a new task for given edit and task type.","responses":{"201":{"description":"New task for given edit and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks":{"post":{"summary":"Create a new task for given concept and task type.","responses":{"201":{"description":"New task for given concept and task type created"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/":{"post":{"summary":"Create a new task with given task type for each entity of given","description":"entity type.
","responses":{"201":{"description":"List of created tasks."}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Tasks"]}},"/actions/tasks/{task_id}/set-main-preview":{"put":{"summary":"Set last preview from given task as main preview of the related entity.","description":"This preview will be used as thumbnail to illustrate the entity.
","responses":{"200":{"description":"Given preview set as main preview"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Task"]}},"/data/playlists/preview-files/running":{"get":{"summary":"Retrieve all preview files from open productions with states equals to processing or broken.","responses":{"200":{"description":"All preview files from open productions with states equals to processing or broken"}},"tags":["Previews"]}},"/pictures/preview-files/{instance_id}":{"post":{"summary":"Main resource to add a preview.","description":"It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.","responses":{"200":{"description":"Preview added"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/movies/originals/preview-files/{instance_id}.mp4":{"get":{"summary":"Download a movie preview.","description":"It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.","responses":{"200":{"description":"Movie preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"File not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/movies/originals/preview-files/{instance_id}/download":{"get":{"summary":"Download a movie preview.","responses":{"200":{"description":"Movie preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"File not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/movies/low/preview-files/{instance_id}.mp4":{"get":{"summary":"Download a lowdef movie preview.","responses":{"200":{"description":"Lowdef movie preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"File not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails-square/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/originals/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/originals/preview-files/{instance_id}.{extension}":{"get":{"summary":"Download a generic file preview.","responses":{"200":{"description":"Generic file preview downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Non-movie file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"extension","required":true,"type":"string","x-example":"png, pdf, jpg, jpeg, ..."}],"tags":["Previews"]}},"/pictures/originals/preview-files/{instance_id}/download":{"get":{"summary":"Download a generic file preview as attachment.","responses":{"200":{"description":"Generic file preview downloaded as attachment"},"403":{"description":"Instance not allowed"},"404":{"description":"Standard file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/previews/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/movies/tiles/preview-files/{instance_id}.png":{"get":{"summary":"Download a thumbnail.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Instance not allowed"},"404":{"description":"Picture file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/organisations/{instance_id}":{"post":{"summary":"Create a thumbnail for given object instance.","responses":{"200":{"description":"Thumbnail created"},"404":{"description":"Cannot found related object."}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/pictures/thumbnails/organisations/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/persons/{instance_id}":{"post":{"summary":"Create a thumbnail for given object instance.","responses":{"200":{"description":"Thumbnail created"},"404":{"description":"Cannot found related object."}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/pictures/thumbnails/persons/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/thumbnails/projects/{instance_id}":{"post":{"summary":"Create a thumbnail for given object instance.","responses":{"200":{"description":"Thumbnail created"},"404":{"description":"Cannot found related object."}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Previews"],"consumes":["multipart/form-data","image/png","application/pdf"]}},"/pictures/thumbnails/projects/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/preview-background-files/{instance_id}":{"post":{"summary":"Main resource to add a preview background file.","responses":{"200":{"description":"Preview background file added"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"file","required":true,"type":"file"}],"tags":["Preview background file"],"consumes":["multipart/form-data","image/vnd.radiance"]}},"/pictures/thumbnails/preview-background-files/{instance_id}.png":{"get":{"summary":"Download the thumbnail linked to given object instance.","responses":{"200":{"description":"Thumbnail downloaded"},"403":{"description":"Access not allowed"},"404":{"description":"Object instance not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/pictures/preview-background-files/{instance_id}.{extension}":{"get":{"summary":"Download a preview background file.","responses":{"200":{"description":"Preview background file downloaded"},"404":{"description":"Preview background file not found"}},"parameters":[{"in":"path","name":"instance_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"extension","required":true,"type":"string","format":"extension","x-example":"hdr"}],"tags":["Previews"]}},"/actions/entities/{entity_id}/set-main-preview/{preview_file_id}":{"put":{"summary":"Set main preview to given file.","responses":{"200":{"description":"Main preview set"}},"parameters":[{"in":"path","name":"entity_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/set-main-preview":{"put":{"summary":"Set given preview as main preview of the related entity.","description":"This preview will be used to illustrate the entity.","responses":{"200":{"description":"Given preview set as main preview"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/extract-frame":{"get":{"summary":"Extract a frame from a preview_file","description":" ","responses":{"200":{"description":"Extracted frame"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/update-position":{"put":{"summary":"Allow to change orders of previews for a single revision.","description":"This preview will be used to illustrate the entity.","responses":{"200":{"description":"Orders of previews changed for a single revision"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/actions/preview-files/{preview_file_id}/update-annotations":{"put":{"summary":"Allow to modify the annotations stored at the preview level.","description":"Modifications are applied via three fields:\n* `annotations` to give all the annotations that need to be added.\n\n* `updates` that list annotations that needs to be modified.\n\n* `deletions` to list the IDs of annotations that needs to be removed.\n","responses":{"200":{"description":"Orders of previews changed for a single revision"}},"parameters":[{"in":"path","name":"preview_file_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Previews"]}},"/data/user/context":{"get":{"summary":"Return context required to properly run a full app connected to the API","description":"(like the Kitsu web client).
","responses":{"200":{"description":"Context to properly run a full app connected to the API"}},"tags":["User"]}},"/data/user/assets/{asset_id}/tasks":{"get":{"summary":"Return tasks related to given asset for current user.","responses":{"200":{"description":"Tasks related to given asset for current user"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/shots/{shot_id}/tasks":{"get":{"summary":"Return tasks related to given shot for current user.","responses":{"200":{"description":"Tasks related to given shot"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/scenes/{scene_id}/tasks":{"get":{"summary":"Return tasks related to given scene for current user.","responses":{"200":{"description":"Tasks related to given scene"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/tasks":{"get":{"summary":"Return tasks related to given sequence for current user.","responses":{"200":{"description":"Tasks related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/assets/{asset_id}/task-types":{"get":{"summary":"Return task types related to given asset for current user.","responses":{"200":{"description":"Task types related to given asset for current user"}},"parameters":[{"in":"path","name":"asset_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/shots/{shot_id}/task-types":{"get":{"summary":"Return tasks related to given shot for current user.","responses":{"200":{"description":"Tasks related to given shot for current user"}},"parameters":[{"in":"path","name":"shot_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/scenes/{scene_id}/task-types":{"get":{"summary":"Return tasks related to given scene for current user.","responses":{"200":{"description":"Tasks related to given scene for current user"}},"parameters":[{"in":"path","name":"scene_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/task-types":{"get":{"summary":"Return tasks related to given sequence for current user.","responses":{"200":{"description":"Tasks related to given sequence for current user"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/open":{"get":{"summary":"Return open projects for which the user has at least one task assigned.","responses":{"200":{"description":"Open projects for which the user has at least one task assigned"}},"tags":["User"]}},"/data/user/projects/{project_id}/asset-types":{"get":{"summary":"Return asset types related to given project if the current user has","description":"access to it.
","responses":{"200":{"description":"Asset types related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/asset-types/{asset_type_id}/assets":{"get":{"summary":"Return assets of which type is given asset type and are listed in given","description":"project if user has access to this project.
","responses":{"200":{"description":"Assets of which type is given asset type and are listed in given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"asset_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/sequences":{"get":{"summary":"Return sequences related to given project if the current user has access","description":"to it.
","responses":{"200":{"description":"Sequences related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/episodes":{"get":{"summary":"Return episodes related to given project if the current user has access","description":"to it.
","responses":{"200":{"description":"Episodes related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/shots":{"get":{"summary":"Return shots related to given sequence if the current user has access","description":"to it.
","responses":{"200":{"description":"Shots related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/sequences/{sequence_id}/scenes":{"get":{"summary":"Return scenes related to given sequence if the current user has access","description":"to it.
","responses":{"200":{"description":"Scenes related to given sequence"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/tasks":{"get":{"summary":"Return tasks currently assigned to current user and of which status has","description":"is_done attribute set to false.
","responses":{"200":{"description":"Unfinished tasks currently assigned to current user"}},"tags":["User"]}},"/data/user/tasks-to-check":{"get":{"summary":"Return tasks requiring feedback for current user departments.","description":"
If the user is not a supervisor, it returns an empty list.
","responses":{"200":{"description":"Tasks requiring feedback in current user departments."}},"tags":["User"]}},"/data/user/done-tasks":{"get":{"summary":"Return tasks currently assigned to current user and of which status has","description":"is_done attribute set to true.
","responses":{"200":{"description":"Finished tasks currently assigned to current user"}},"tags":["User"]}},"/data/user/filters":{"post":{"summary":"Create filter for current user and only for open projects.","responses":{"201":{"description":"Filter for current user and only for open projects created"}},"parameters":[{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of filter"},{"in":"formData","name":"query","required":true,"type":"string"},{"in":"formData","name":"list_type","required":true,"type":"string"},{"in":"formData","name":"entity_type","required":false,"type":"string"},{"in":"formData","name":"project_id","required":true,"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]},"get":{"summary":"Retrieve filters for current user and only for open projects.","responses":{"200":{"description":"Filters for current user and only for open projects"}},"tags":["User"]}},"/data/user/filters/{filter_id}":{"delete":{"summary":"Delete given filter if it's owned by current user.","responses":{"204":{"description":"Empty response"}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]},"put":{"summary":"Update given filter if it's owned by current user.","responses":{"200":{"description":"Given filter with updated data."}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/filter-groups":{"post":{"summary":"Create filter group for current user and only for open projects.","responses":{"201":{"description":"Filter groups for the current user and only for open projects created."}},"parameters":[{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of filter"},{"in":"formData","name":"color","required":true,"type":"string"},{"in":"formData","name":"list_type","required":true,"type":"string"},{"in":"formData","name":"entity_type","required":false,"type":"string"},{"in":"formData","name":"project_id","required":true,"type":"string","format":"UUID","example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]},"get":{"summary":"Retrieve filter groups for current user and only for open projects.","responses":{"200":{"description":"Filter groups for current user and only for open projects"}},"tags":["User"]}},"/data/user/filter-groups/{filter_group_id}":{"delete":{"summary":"Delete given filter group if it's owned by the current user.","responses":{"204":{"description":"Empty response"}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]},"get":{"summary":"Retrieve given filter group for the current user.","responses":{"200":{"description":"Filter groups for the current user and only for open projects"}},"tags":["User"]},"put":{"summary":"Update given filter group if it's owned by the current user.","responses":{"200":{"description":"Given filter group with updated data"}},"parameters":[{"in":"path","name":"filter_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/desktop-login-logs":{"post":{"summary":"Create a desktop login log.","description":"The desktop login log can only be created by the current user.","responses":{"201":{"description":"Desktop login log created"}},"parameters":[{"in":"formData","name":"date","type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]},"get":{"summary":"Retrieve desktop login logs.","responses":{"200":{"description":"Desktop login logs"}},"tags":["User"]}},"/data/user/tasks/{task_id}/time-spents/{date}":{"get":{"summary":"Get time spents for current user and given date.","responses":{"200":{"description":"Time spents for current user and given date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]}},"/data/user/day-offs/{date}":{"get":{"summary":"Get day off object for current user and given date.","responses":{"200":{"description":"Day off object for current user and given date"},"404":{"description":"Wrong date format"}},"parameters":[{"in":"path","name":"date","required":true,"type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]}},"/data/user/notifications":{"get":{"summary":"Return last 100 user notifications filtered by given parameters.","responses":{"200":{"description":"100 last user notifications"}},"parameters":[{"in":"formData","name":"after","type":"string","format":"date","x-example":"2022-07-12"},{"in":"formData","name":"before","type":"string","format":"date","x-example":"2022-07-12"}],"tags":["User"]}},"/data/user/notifications/{notification_id}":{"get":{"summary":"Return notification matching given id, only if it's a notification that","description":"belongs to current user.
","responses":{"200":{"description":"Notification matching given ID"}},"parameters":[{"in":"path","name":"notification_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/tasks/{task_id}/subscribed":{"get":{"summary":"Return true if current user has subscribed to given task.","responses":{"200":{"description":"True if current user has subscribed to given task, False otherwise"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/tasks/{task_id}/subscribe":{"post":{"summary":"Create a subscription entry for given task and current user.","description":"When a user subscribes, he gets notified everytime a comment is posted on the task.","responses":{"201":{"description":"Subscription entry created"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/tasks/{task_id}/unsubscribe":{"delete":{"summary":"Remove the subscription entry matching given task and current user.","description":"The user will no longer receive notifications for this task.","responses":{"204":{"description":"Subscription entry removed"}},"parameters":[{"in":"path","name":"task_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/clear-avatar":{"delete":{"summary":"Set `has_avatar` flag to False for current user and remove its avatar","description":"file.
","responses":{"204":{"description":"Avatar file deleted"}},"tags":["User"]}},"/data/user/entities/{sequence_id}/task-types/{task_type_id}/subscribed":{"get":{"summary":"Return true if current user has subscribed to given sequence and","description":"task type.
","responses":{"200":{"description":"True if current user has subscribed to given sequence and task type, False otherwise"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions":{"get":{"summary":"Return the list of sequence ids to which the current user has","description":"subscribed for given task type.
","responses":{"200":{"description":"List of sequence ids to which the current user has subscribed for given task type"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/sequences/{sequence_id}/task-types/{task_type_id}/subscribe":{"post":{"summary":"Create a subscription entry for given sequence,","description":"task type and current user.
","responses":{"201":{"description":"Subscription entry created"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/actions/user/sequences/{sequence_id}/task-types/{task_type_id}/unsubscribe":{"delete":{"summary":"Remove a subscription entry for given sequence, tasl type","description":"and current user.
","responses":{"204":{"description":"Subscription entry removed"}},"parameters":[{"in":"path","name":"sequence_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"path","name":"task_type_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["User"]}},"/data/edits":{"get":{"summary":"Retrieve all edit entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All edit entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"name","required":false,"type":"string","x-example":"Name of edit"},{"in":"query","name":"force","required":false,"type":"boolean","default":false}],"tags":["Edits"]}},"/data/edits/all":{"get":{"summary":"Retrieve all edit entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All edit entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"name","required":false,"type":"string","x-example":"Name of edit"},{"in":"query","name":"force","required":false,"type":"boolean","default":false}],"tags":["Edits"]}},"/data/edits/with-tasks":{"get":{"summary":"Retrieve all edits, adds project name and all related tasks.","responses":{"200":{"description":"All edits and all related tasks."}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"name","required":false,"type":"string","x-example":"Name of edit"},{"in":"query","name":"force","required":false,"type":"boolean","default":false}],"tags":["Edits"]}},"/data/edits/{edit_id}":{"delete":{"summary":"Delete given edit.","responses":{"204":{"description":"Given edit deleted"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]},"get":{"summary":"Retrieve given edit.","responses":{"200":{"description":"Given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given edit.","responses":{"200":{"description":"All task types related to given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given edit.","responses":{"200":{"description":"All tasks related to given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given edit.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/edits/{edit_id}/versions":{"get":{"summary":"Retrieve data versions of given edit.","responses":{"200":{"description":"Data versions of given edit"}},"parameters":[{"in":"path","name":"edit_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/episodes/{episode_id}/edits":{"get":{"summary":"Retrieve all edits related to a given episode.","responses":{"200":{"description":"All efits related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/episodes/{episode_id}/edit-tasks":{"get":{"summary":"Retrieve all tasks related to a given episode.","responses":{"200":{"description":"All tasks related to given episode"}},"parameters":[{"in":"path","name":"episode_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/projects/{project_id}/edits":{"post":{"summary":"Create an edit for given project.","responses":{"201":{"description":"Edit created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of edit"},{"in":"formData","name":"description","type":"string","x-example":"Description of edit"},{"in":"formData","name":"episode_id","type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]},"get":{"summary":"Retrieve all edits related to a given project.","responses":{"200":{"description":"All edits related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Edits"]}},"/data/search":{"post":{"summary":"Search for resource","responses":{"200":{"description":"List of entities that contain the query"}},"parameters":[{"in":"formData","name":"query","required":true,"type":"string","x-example":"test will search for test"},{"in":"formData","name":"limit","required":false,"type":"integer","default":3,"x-example":3},{"in":"formData","name":"index_names","required":false,"type":"list of strings","default":["assets","shots","persons"],"x-example":["assets"]}],"tags":["Search"]}},"/data/concepts":{"get":{"summary":"Retrieve all concept entries.","description":"Filters can be specified in the query string.","responses":{"200":{"description":"All concept entries"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"query","name":"parent_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/with-tasks":{"get":{"summary":"Retrieve all concepts, adds project name and asset type name and all related tasks.","responses":{"200":{"description":"All concepts"}},"parameters":[{"in":"query","name":"project_id","required":false,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}":{"delete":{"summary":"Delete given concept.","responses":{"204":{"description":"Given concept deleted"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]},"get":{"summary":"Retrieve given concept.","responses":{"200":{"description":"Given concept"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}/task-types":{"get":{"summary":"Retrieve all task types related to a given concept.","responses":{"200":{"description":"All task types related to given concept"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}/tasks":{"get":{"summary":"Retrieve all tasks related to a given concept.","responses":{"200":{"description":"All tasks related to given concept"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/concepts/{concept_id}/preview-files":{"get":{"summary":"Retrieve all previews related to a given concept.","description":"It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.","responses":{"200":{"description":"All previews related to given episode"}},"parameters":[{"in":"path","name":"concept_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}},"/data/projects/{project_id}/concepts":{"post":{"summary":"Create a concept for given project.","responses":{"201":{"description":"Concept created for given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"},{"in":"formData","name":"name","required":true,"type":"string","x-example":"Name of concept"},{"in":"formData","name":"description","type":"string","x-example":"Description of concept"},{"in":"formData","name":"entity_concept_links","type":"list of UUIDs","x-example":["a24a6ea4-ce75-4665-a070-57453082c25"]}],"tags":["Concepts"]},"get":{"summary":"Retrieve all concepts related to a given project.","responses":{"200":{"description":"All concepts related to given project"}},"parameters":[{"in":"path","name":"project_id","required":true,"type":"string","format":"UUID","x-example":"a24a6ea4-ce75-4665-a070-57453082c25"}],"tags":["Concepts"]}}},"definitions":{" Common fields for all model instances":{"type":"object","properties":{" id":{"type":"string","format":"UUID","description":"A unique ID made of letters, hyphens and numbers","example":"a24a6ea4-ce75-4665-a070-57453082c25"},"created_at":{"type":"string","format":"date-time","description":"The creation date"},"updated_at":{"type":"string","format":"date-time","description":"The update date"}}},"Asset":{"type":"object","properties":{"name":{"type":"string","description":"Name of asset"},"code":{"type":"string","description":"Utility field for the pipeline to identify the asset"},"description":{"type":"string","description":"Asset brief"},"canceled":{"type":"boolean","default":"False","description":"True if the asset has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"entity_type_id":{"type":"string","format":"UUID","description":"Asset type ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"AssetInstance":{"type":"object","properties":{"asset_id":{"type":"string","format":"UUID","description":"Instantiated asset"},"name":{"type":"string"},"number":{"type":"integer"},"description":{"type":"string"},"active":{"type":"boolean","default":"True"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"scene_id":{"type":"string","format":"UUID","description":"Target scene"},"target_asset_id":{"type":"string","format":"UUID","description":"Use when instantiating an asset in an asset is required"}}},"AssetType":{"type":"object","properties":{"name":{"type":"string"}}},"AttachmentFile":{"type":"object","properties":{"name":{"type":"string","description":"Name of attachment file"},"size":{"type":"integer","description":"Size of attachment file"},"extension":{"type":"string","description":"Extension of attachment file"},"mimetype":{"type":"string"},"comment_id":{"type":"string","format":"UUID","description":"Comment to which the file is attached"}}},"BuildJob":{"type":"object","properties":{"status":{"type":"string","description":"Status of build job (running, failed, succeeded)"},"job_type":{"type":"string","description":"Type of build job (archive, movie)"},"ended_at":{"type":"string","format":"date-time"},"playlist_id":{"type":"string","format":"UUID","description":"Playlist ID"}}},"Comment":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"object_id":{"type":"string","format":"UUID","description":"Unique ID of the commented model instance"},"object_type":{"type":"string","description":"Model type of the comment model instance"},"text":{"type":"string"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"replies":{"type":"string","format":"json","default":"[]"},"checklist":{"type":"string","format":"json"},"pinned":{"type":"boolean"},"task_status_id":{"type":"string","format":"UUID","description":"Task status attached to comment"},"person_id":{"type":"string","format":"UUID","description":"The person who publishes the comment"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"}}},"CustomAction":{"type":"object","properties":{"name":{"type":"string","description":"Name of custom action"},"url":{"type":"string"},"entity_type":{"type":"string","default":"all"},"is_ajax":{"type":"boolean","default":"False","description":"True if the custom action is ajax, False otherwise"}}},"DataImportError":{"type":"object","properties":{"event_data":{"type":"string","format":"json","description":"JSON field to add event data"},"source":{"type":"array","items":{"type":"string","enum":["csv","shotgun"]}}}},"DayOff":{"type":"object","properties":{"date":{"type":"string","format":"date"},"person_id":{"type":"string","format":"UUID","description":"The person who will take the day off"}}},"Department":{"type":"object","properties":{"name":{"type":"string","description":"Name of department"},"color":{"type":"string","description":"Color of department"}}},"DesktopLoginLog":{"type":"object","properties":{"date":{"type":"string","format":"date"},"person_id":{"type":"string","format":"UUID","description":"Person ID"}}},"Episode":{"type":"object","properties":{"name":{"type":"string","description":"Name of episode"},"code":{"type":"string","description":"Utility field for the pipeline to identify the episode"},"description":{"type":"string","description":"Episode brief"},"canceled":{"type":"boolean","default":"False","description":"True if the episode has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"Event":{"type":"object","properties":{"name":{"type":"string","description":"Name of event"},"user_id":{"type":"string","format":"UUID","description":"The user who made the action that emitted the event"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"}}},"FileStatus":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}},"LoginLog":{"type":"object","properties":{"origin":{"type":"string","description":"web, script"},"ip_address":{"type":"string","description":"IP address of device used to login"},"person_id":{"type":"string","format":"UUID","description":"Person ID"}}},"Metadata":{"type":"object","properties":{"project_id":{"type":"string","format":"UUID","description":"ID of project for which metadata are added"},"entity_type":{"type":"string","description":"Asset or Shot"},"name":{"type":"string","description":"Field name for GUI"},"field_name":{"type":"string","description":"Technical field name"},"choices":{"type":"string","format":"json","description":"Array of string that represents the available values for this metadate (this metatada is considered as a free field if this array is empty)"},"for_client":{"type":"boolean"}}},"Milestone":{"type":"object","properties":{"data":{"type":"string","format":"date","description":"Milestone date of production schedule"},"name":{"type":"string","description":"Name of milestone"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"project_id":{"type":"string","format":"UUID","description":"Project ID"}}},"News":{"type":"object","properties":{"change":{"type":"boolean","default":"False"},"author_id":{"type":"string","format":"UUID","description":"Person who wrote the comment"},"comment_id":{"type":"string","format":"UUID","description":"Posted comment ID"},"task_id":{"type":"string","format":"UUID","description":"Task ID"},"preview_file_id":{"type":"string","format":"UUID","description":"Preview file ID"}}},"Notification":{"type":"object","properties":{"read":{"type":"boolean","description":"True if user read it, False otherwise"},"change":{"type":"boolean","description":"True if there is status change related to this status, False otherwise"},"person_id":{"type":"string","format":"UUID","description":"The user to who the notification is aimed at"},"author_id":{"type":"string","format":"UUID","description":"Author of the event to notify"},"comment_id":{"type":"string","format":"UUID","description":"Comment related to the notification, if there is any"},"task_id":{"type":"string","format":"UUID","description":"Task related to the notification, if there is any"},"reply_id":{"type":"string","format":"UUID","description":"Reply related to notification"},"type":{"type":"string","description":"Type of notification"}}},"Organisation":{"type":"object","properties":{"name":{"type":"string","description":"Name of organisaition"},"hours_by_day":{"type":"float"},"has_avatar":{"type":"boolean","default":"False","description":"True if the organisation has an avatar, Flase otherwise"},"use_original_file_name":{"type":"boolean","default":"False","description":"True if the organisation uses original file names, Flase otherwise"},"timesheets_locked":{"type":"boolean","default":"False","description":"True if the organisation's timesheets are locked, False otherwise"},"hd_by_default":{"type":"boolean","default":"False"},"chat_token_slack":{"type":"string"},"chat_webhook_mattermost":{"type":"string"},"chat_token_discord":{"type":"string"}}},"OutputFile":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"name":{"type":"string","description":"Name of output file"},"extension":{"type":"string","description":"Extension of output file"},"description":{"type":"string","description":"Output file brief"},"comment":{"type":"string","description":"Comment on output file"},"revision":{"type":"integer","description":"Revision number of output file"},"size":{"type":"integer","description":"Size of output file"},"checksum":{"type":"string","description":"Checksum of output file"},"source":{"type":"string","description":"Created by a script, a webgui or a desktop gui"},"path":{"type":"string","description":"File path on the production hard drive"},"representation":{"type":"string","description":"Precise what kind of output it is (abc, jpgs, pngs, etc.)"},"nb_elements":{"type":"integer","default":"1","description":"For image sequence"},"canceled":{"type":"boolean"},"file_status_id":{"type":"string","format":"UUID","description":"File status ID"},"entity_id":{"type":"string","format":"UUID","description":"Asset or Shot concerned by the output file"},"asset_instance_id":{"type":"string","format":"UUID","description":"Asset instance ID"},"output_type_id":{"type":"string","format":"UUID","description":"Type of output (geometry, cache, etc.)"},"task_type_id":{"type":"string","format":"UUID","description":"Task type related to this output file (modeling, animation, etc.)"},"person_id":{"type":"string","format":"UUID","description":"Author of the file"},"source_file_id":{"type":"string","format":"UUID","description":"Working file that led to create this output file"},"temporal_entity_id":{"type":"string","format":"UUID","description":"Shot, scene or sequence needed for output files related to an asset instance"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"}}},"OutputType":{"type":"object","properties":{"name":{"type":"string"},"short_name":{"type":"string"}}},"Person":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","description":"Serve as login"},"phone":{"type":"string"},"active":{"type":"boolean","description":"True if the person is still in the studio, False otherwise"},"last_presence":{"type":"string","format":"date","description":"Last time the person worked for the studio"},"password":{"type":"string","format":"byte"},"desktop_login":{"type":"string","description":"Login used on desktop"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"timezone":{"type":"string"},"locale":{"type":"string"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"role":{"type":"string","default":"user"},"has_avatar":{"type":"boolean","default":"False","description":"True if user has an avatar, Flase otherwise"},"notifications_enabled":{"type":"boolean"},"notifications_slack_enabled":{"type":"boolean"},"notifications_slack_userid":{"type":"string"},"notifications_mattermost_enabled":{"type":"boolean"},"notifications_mattermost_userid":{"type":"string"},"notifications_discord_enabled":{"type":"boolean"},"notifications_discord_userid":{"type":"string"}}},"Playlist":{"type":"object","properties":{"name":{"type":"string","description":"Name of playlist"},"shots":{"type":"string","format":"json","description":"JSON field describing shot and preview listed in"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"episode_id":{"type":"string","format":"UUID","description":"Episode ID"},"for_client":{"type":"boolean","default":"False"},"for_entity":{"type":"string","default":"shot"},"is_for_all":{"type":"boolean","default":"False"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"}}},"PreviewFile":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"name":{"type":"string","description":"Name of preview file"},"original_name":{"type":"string","description":"Original name of preview file"},"revision":{"type":"integer","default":"1","description":"Revision number of preview file"},"position":{"type":"integer","default":"1","description":"Position of preview file"},"extension":{"type":"string","description":"Extension of preview file"},"description":{"type":"string","description":"Preview file brief"},"path":{"type":"string","description":"File path on the production hard drive"},"source":{"type":"string","description":"Created by a script, a webgui or a desktop gui"},"file_size":{"type":"integer","default":"0","description":"Size of output file"},"comment":{"type":"string","description":"Comment on output file"},"checksum":{"type":"string","description":"Checksum of output file"},"representation":{"type":"string","description":"Precise what kind of output it is (abc, jpgs, pngs, etc.)"},"nb_elements":{"type":"integer","default":"1","description":"For image sequence"},"canceled":{"type":"boolean"},"file_status_id":{"type":"string","format":"UUID","description":"File status ID"},"entity_id":{"type":"string","format":"UUID","description":"Asset or Shot concerned by the output file"},"asset_instance_id":{"type":"string","format":"UUID","description":"Asset instance ID"},"output_type_id":{"type":"string","format":"UUID","description":"Type of output (geometry, cache, etc.)"},"task_type_id":{"type":"string","format":"UUID","description":"Task type related to this output file (modeling, animation, etc.)"},"person_id":{"type":"string","format":"UUID","description":"Author of the file"},"source_file_id":{"type":"string","format":"UUID","description":"Working file that led to create this output file"},"temporal_entity_id":{"type":"string","format":"UUID","description":"Shot, scene or sequence needed for output files related to an asset instance"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"}}},"Project":{"type":"object","properties":{"name":{"type":"string","description":"Name of project"},"code":{"type":"string","description":"Utility field for the pipeline to identify the project"},"description":{"type":"string","description":"Project brief"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"file_tree":{"type":"string","format":"json","description":"Templates to use to build file paths"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"project_status_id":{"type":"string","format":"UUID","description":"Project status ID"},"has_avatar":{"type":"boolean","default":"False","description":"True if the project has an avatar, False otherwise"},"fps":{"type":"string","description":"Frames per second"},"ratio":{"type":"string"},"resolution":{"type":"string"},"production_type":{"type":"string","description":"short, featurefilm or tvshow","default":"short"},"end_date":{"type":"string","format":"date"},"start_date":{"type":"string","format":"date"},"man_days":{"type":"integer","description":"Estimated number of working days to complete the project"},"nb_episodes":{"type":"integer","default":"0"},"episode_span":{"type":"integer","default":"0"},"max_retakes":{"type":"integer","default":"0"},"is_clients_isolated":{"type":"boolean","default":"False","description":"True if the clients are isolated from the project, False otherwise"}}},"ProjectStatus":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}},"ScheduleItem":{"type":"object","properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"man_days":{"type":"string","format":"date"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"object_id":{"type":"string","format":"UUID","description":"Object ID"}}},"SearchFilter":{"type":"object","properties":{"list_type":{"type":"string","description":"Type of list"},"entity_type":{"type":"string","description":"Type of entity"},"name":{"type":"string","description":"Name of search filter"},"search_query":{"type":"string"},"person_id":{"type":"string","format":"UUID","description":"Person ID"},"project_id":{"type":"string","format":"UUID","description":"Project ID"}}},"Sequence":{"type":"object","properties":{"name":{"type":"string","description":"Name of sequence"},"code":{"type":"string","description":"Utility field for the pipeline to identify the sequence"},"description":{"type":"string","description":"Sequence brief"},"canceled":{"type":"boolean","default":"False","description":"True if the sequence has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"parent_id":{"type":"string","format":"UUID","description":"Episode ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"Shot":{"type":"object","properties":{"name":{"type":"string","description":"Name of shot"},"code":{"type":"string","description":"Utility field for the pipeline to identify the shot"},"description":{"type":"string","description":"Shot brief"},"canceled":{"type":"boolean","default":"False","description":"True if the shot has been delete one time, False otherwise"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"parent_id":{"type":"string","format":"UUID","description":"Episode ID"},"entity_type_id":{"type":"string","format":"UUID","description":"Shot type ID"},"source_id":{"type":"string","format":"UUID","description":"Field uset to set the episode_id"},"preview_file_id":{"type":"string","format":"UUID","description":"ID of preview file used as thumbnail"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"Software":{"type":"object","properties":{"name":{"type":"string","description":"Name of software"},"short_name":{"type":"string","description":"Short name of software"},"file_extension":{"type":"string","description":"Main extension used for this software's files"},"secondary_extensions":{"type":"string","format":"json","description":"Other extensions used for this software's files"}}},"StatusAutomation":{"type":"object","properties":{"entity_type":{"type":"string","default":"asset"},"in_task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"in_task_status_id":{"type":"string","format":"UUID","description":"Task status ID"},"out_field_type":{"type":"string","description":"Field type (status, ready_for)"},"out_task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"out_task_status_id":{"type":"string","format":"UUID","description":"Task status ID"}}},"SubscriptionToNotifications":{"type":"object","properties":{"person_id":{"type":"string","format":"UUID","description":"Person ID"},"task_id":{"type":"string","format":"UUID","description":"Task ID"},"entity_id":{"type":"string","format":"UUID","description":"Entity ID"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"}}},"Task":{"type":"object","properties":{"name":{"type":"string","description":"Name of task"},"description":{"type":"string","description":"Task brief"},"priority":{"type":"integer","default":"0","description":"Priority of task"},"duration":{"type":"float","default":"0","description":"Duration of task"},"estimation":{"type":"float","default":"0","description":"Estimation of duration of task"},"completion_rate":{"type":"integer","default":"0","description":"Completion rate of task"},"retake_count":{"type":"integer","default":"0","description":"Retake count of task"},"sort_order":{"type":"integer","default":"0","description":"Sort order of task"},"start_date":{"type":"string","format":"date-time"},"due_date":{"type":"string","format":"date-time"},"real_start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"last_comment_date":{"type":"string","format":"date-time"},"nb_assets_ready":{"type":"integer","default":"0","description":"Number of assets ready"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"project_id":{"type":"string","format":"UUID","description":"Project ID"},"task_type_id":{"type":"string","format":"UUID","description":"Task type ID"},"task_status_id":{"type":"string","format":"UUID","description":"Task status ID"},"entity_id":{"type":"string","format":"UUID","description":"Entity ID"},"assigner_id":{"type":"string","format":"UUID","description":"Person ID"}}},"TaskStatus":{"type":"object","properties":{"name":{"type":"string","description":"Name of task status"},"short_name":{"type":"string","description":"Short name of task status"},"color":{"type":"string"},"is_done":{"type":"boolean","default":"False","description":"True if the task is done, False otherwise"},"is_artist_allowed":{"type":"boolean","default":"True","description":"True if the artist is allowed, False otherwise"},"is_client_allowed":{"type":"boolean","default":"True","description":"True if the client is allowed, False otherwise"},"is_retake":{"type":"boolean","default":"False","description":"True if the task was retaken, False otherwise"},"is_feedback_request":{"type":"boolean","default":"False","description":"True if feedback was requested, False otherwise"},"is_default":{"type":"boolean","default":"False","description":"True if the task is default, False otherwise"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"}}},"TaskType":{"type":"object","properties":{"name":{"type":"string","description":"Name of task type"},"short_name":{"type":"string","description":"Short name of task type"},"color":{"type":"string","default":"#FFFFFF"},"priority":{"type":"integer","default":"1","description":"Priority of task type"},"for_entity":{"type":"string","default":"Asset"},"allow_timelog":{"type":"boolean","default":"True","description":"True if timelog is allowed, False otherwise"},"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"department_id":{"type":"string","format":"UUID","description":"Department ID"}}},"TimeSpent":{"type":"object","properties":{"duration":{"type":"float"},"date":{"type":"string","format":"date"},"task_id":{"type":"string","format":"UUID","description":"Related task ID"},"person_id":{"type":"string","format":"UUID","description":"The person who performed the working time"}}},"WorkingFile":{"type":"object","properties":{"shotgun_id":{"type":"integer","description":"Used for synchronization with a Shotgun instance"},"name":{"type":"string","description":"Name of working file"},"description":{"type":"string","description":"working file brief"},"comment":{"type":"string","description":"Comment on working file"},"revision":{"type":"integer","description":"Revision number of working file"},"size":{"type":"integer","description":"Size of working file"},"checksum":{"type":"string","description":"Checksum of working file"},"path":{"type":"string","description":"File path on the production hard drive"},"data":{"type":"string","format":"json","description":"Free JSON field to add metadata"},"task_id":{"type":"string","format":"UUID","description":"Task for which the working file is made"},"entity_id":{"type":"string","format":"UUID","description":"Entity for which the working is made"},"person_id":{"type":"string","format":"UUID","description":"Author of the file"},"software_id":{"type":"string","format":"UUID","description":"Software used to build this working file"}}}},"swagger":"2.0","openapi":"3.1","externalDocs":{"description":"Read the installation documentation","url":"https://zou.cg-wire.com"},"host":"localhost:8080","basePath":"/api","schemes":["http","https"],"securityDefinitions":{"JWT Authorization":{"name":"Authorization","in":"header","type":"apiKey","description":"Format in header: **Authorization: Bearer {token}**. \n\n Value example: Bearer xxxxx.yyyyy.zzzzz"}},"security":[{"JWT Authorization":[]}],"tags":[{"name":"Authentication"},{"name":"Assets"},{"name":"Breakdown"},{"name":"Comments"},{"name":"Crud"},{"name":"Edits"},{"name":"Entities"},{"name":"Events"},{"name":"Export"},{"name":"Files"},{"name":"Import"},{"name":"Index"},{"name":"News"},{"name":"Persons"},{"name":"Playlists"},{"name":"Previews"},{"name":"Projects"},{"name":"Search"},{"name":"Shots"},{"name":"Tasks"},{"name":"User"}]} \ No newline at end of file